Class: Nexpose::Field

Inherits:
Object
  • Object
show all
Includes:
XMLUtils
Defined in:
lib/nexpose/creds.rb

Overview

When using HTML form, this represents the login form information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLUtils

#make_xml, #parse_xml

Constructor Details

#initialize(name, value, type, dynamic, checked) ⇒ Field

Returns a new instance of Field.



281
282
283
284
285
286
287
 
# File 'lib/nexpose/creds.rb', line 281

def initialize(name, value, type, dynamic, checked)
  @name = name
  @value = value
  @type = type
  @dynamic = dynamic
  @checked = checked
end

Instance Attribute Details

#checked ⇒ Object (readonly)

If the HTML field (form parameter) is a radio button, checkbox or select field, this flag determines if the field should be checked (selected).



279
280
281
 
# File 'lib/nexpose/creds.rb', line 279

def checked
  @checked
end

#dynamic ⇒ Object (readonly)

Is the HTML field (form parameter) dynamically generated? If so, the login page is requested and the value of the field is extracted from the response.



276
277
278
 
# File 'lib/nexpose/creds.rb', line 276

def dynamic
  @dynamic
end

#name ⇒ Object (readonly)

The name of the HTML field (form parameter).



268
269
270
 
# File 'lib/nexpose/creds.rb', line 268

def name
  @name
end

#type ⇒ Object (readonly)

The type of the HTML field (form parameter).



272
273
274
 
# File 'lib/nexpose/creds.rb', line 272

def type
  @type
end

#value ⇒ Object (readonly)

The value of the HTML field (form parameter).



270
271
272
 
# File 'lib/nexpose/creds.rb', line 270

def value
  @value
end

Instance Method Details

#as_xml ⇒ Object Also known as: to_xml_elem 



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/nexpose/creds.rb', line 289

def as_xml
  attributes = {}
  attributes['name'] = @name
  attributes['value'] = @value
  attributes['type'] = @type
  attributes['dynamic'] = @dynamic
  attributes['checked'] = @checked

  make_xml('Field', attributes)
end