Class: Nexpose::Criteria

Inherits:
Object
  • Object
show all
Defined in:
lib/nexpose/filter.rb

Overview

Join search criteria for an asset filter search or dynamic asset group.

Direct Known Subclasses

Tag::Criteria

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(criteria = [], match = 'AND') ⇒ Criteria

Returns a new instance of Criteria.



308
309
310
311
 
# File 'lib/nexpose/filter.rb', line 308

def initialize(criteria = [], match = 'AND')
  @criteria = Array(criteria)
  @match = match.upcase
end

Instance Attribute Details

#criteria ⇒ Object

Array of criteria to match against.



306
307
308
 
# File 'lib/nexpose/filter.rb', line 306

def criteria
  @criteria
end

#match ⇒ Object

Whether to match any or all filters. One of ‘OR’ or ‘AND’.



304
305
306
 
# File 'lib/nexpose/filter.rb', line 304

def match
  @match
end

Class Method Details

.parse(json) ⇒ Object 



339
340
341
342
343
344
345
346
347
 
# File 'lib/nexpose/filter.rb', line 339

def self.parse(json)
  # The call returns empty JSON, so default to 'AND' if not present.
  operator = json['operator'] || 'AND'
  ret = Criteria.new([], operator)
  json['criteria'].each do |c|
    ret.criteria << Criterion.parse(c)
  end
  ret
end

Instance Method Details

#<<(criterion) ⇒ Object 



335
336
337
 
# File 'lib/nexpose/filter.rb', line 335

def <<(criterion)
  criteria << criterion
end

#_to_payload ⇒ Object

Generate the payload needed for a POST request for Asset Filter.



326
327
328
329
330
331
332
333
 
# File 'lib/nexpose/filter.rb', line 326

def _to_payload
  { 'dir' => -1,
    'results' => -1,
    'sort' => 'assetIP',
    'startIndex' => -1,
    'table-id' => 'assetfilter',
    'searchCriteria' => to_json }
end

#to_json ⇒ Object

Convert this object into the format expected by Nexpose.



320
321
322
 
# File 'lib/nexpose/filter.rb', line 320

def to_json
  JSON.generate(to_map)
end

#to_map ⇒ Object 



313
314
315
316
 
# File 'lib/nexpose/filter.rb', line 313

def to_map
  { 'operator' => @match,
    'criteria' => @criteria.map { |c| c.to_map } }
end