Class: Nexpose::HTMLForm

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, action, method, enctype) ⇒ HTMLForm

Returns a new instance of HTMLForm.



275
276
277
278
279
280
281
# File 'lib/nexpose/creds.rb', line 275

def initialize(name, action, method, enctype)
  @name = name
  @action = action
  @method = method
  @enctype = enctype
  @fields = []
end

Instance Attribute Details

#actionObject (readonly)

The HTTP action (URL) through which to submit the login form.



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

def action
  @action
end

#enctypeObject (readonly)

The HTTP encoding type with which to submit the form.



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

def enctype
  @enctype
end

#fieldsObject (readonly)

The fields in the HTML Form



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

def fields
  @fields
end

#methodObject (readonly)

The HTTP request method with which to submit the form.



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

def method
  @method
end

#nameObject (readonly)

The name of the form being submitted.



265
266
267
# File 'lib/nexpose/creds.rb', line 265

def name
  @name
end

Instance Method Details

#add_field(field) ⇒ Object



283
284
285
# File 'lib/nexpose/creds.rb', line 283

def add_field(field)
  @fields << field
end

#to_xml_elemObject



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

def to_xml_elem
  attributes = {}
  attributes['name'] = @name
  attributes['action'] = @action
  attributes['method'] = @method
  attributes['enctype'] = @enctype

  xml = make_xml('HTMLForm', attributes)

  fields.each() do |field|
    xml.add_element(field.to_xml_elem)
  end
  xml
end