Class: Nexpose::Headers
- Inherits:
-
Object
- Object
- Nexpose::Headers
- Includes:
- XMLUtils
- Defined in:
- lib/nexpose/creds.rb
Overview
Object that represents Headers, associated with Web Session Authentication.
Instance Attribute Summary collapse
-
#headers ⇒ Object
readonly
When using HTTP headers, this represents the set of headers to pass with the authentication request.
-
#soft403 ⇒ Object
readonly
A regular expression used to match against the response to identify authentication failures.
-
#webapproot ⇒ Object
readonly
Base URL of the application for which the form authentication applies.
Instance Method Summary collapse
- #add_header(header) ⇒ Object
- #as_xml ⇒ Object (also: #to_xml_elem)
-
#initialize(webapproot, soft403) ⇒ Headers
constructor
A new instance of Headers.
Methods included from XMLUtils
Constructor Details
#initialize(webapproot, soft403) ⇒ Headers
Returns a new instance of Headers.
237 238 239 240 241 |
# File 'lib/nexpose/creds.rb', line 237 def initialize(webapproot, soft403) @headers = [] @webapproot = webapproot @soft403 = soft403 end |
Instance Attribute Details
#headers ⇒ Object (readonly)
When using HTTP headers, this represents the set of headers to pass with the authentication request.
235 236 237 |
# File 'lib/nexpose/creds.rb', line 235 def headers @headers end |
#soft403 ⇒ Object (readonly)
A regular expression used to match against the response to identify authentication failures.
231 232 233 |
# File 'lib/nexpose/creds.rb', line 231 def soft403 @soft403 end |
#webapproot ⇒ Object (readonly)
Base URL of the application for which the form authentication applies.
233 234 235 |
# File 'lib/nexpose/creds.rb', line 233 def webapproot @webapproot end |
Instance Method Details
#add_header(header) ⇒ Object
243 244 245 |
# File 'lib/nexpose/creds.rb', line 243 def add_header(header) @headers.push(header) end |
#as_xml ⇒ Object Also known as: to_xml_elem
247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/nexpose/creds.rb', line 247 def as_xml attributes = {} attributes['webapproot'] = @webapproot attributes['soft403'] = @soft403 xml = make_xml('Headers', attributes) @headers.each do |header| xml.add_element(header.to_xml_elem) end xml end |