Class: Nexpose::Field

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

Overview

When using htmlform, 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.



205
206
207
208
209
210
211
 
# File 'lib/nexpose/creds.rb', line 205

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).



203
204
205
 
# File 'lib/nexpose/creds.rb', line 203

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.



200
201
202
 
# File 'lib/nexpose/creds.rb', line 200

def dynamic
  @dynamic
end

#name ⇒ Object (readonly)

The name of the HTML field (form parameter).



192
193
194
 
# File 'lib/nexpose/creds.rb', line 192

def name
  @name
end

#type ⇒ Object (readonly)

The type of the HTML field (form parameter).



196
197
198
 
# File 'lib/nexpose/creds.rb', line 196

def type
  @type
end

#value ⇒ Object (readonly)

The value of the HTML field (form parameter).



194
195
196
 
# File 'lib/nexpose/creds.rb', line 194

def value
  @value
end

Instance Method Details

#to_xml_elem ⇒ Object 



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/nexpose/creds.rb', line 213

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

  make_xml('Field', attributes)
end