Class: SAML2::Status

Inherits:
Base
  • Object
show all
Defined in:
lib/saml2/status.rb

Constant Summary collapse

SUCCESS = 
"urn:oasis:names:tc:SAML:2.0:status:Success"
REQUESTER = 
"urn:oasis:names:tc:SAML:2.0:status:Requester"
RESPONDER = 
"urn:oasis:names:tc:SAML:2.0:status:Responder"

Instance Attribute Summary collapse

Attributes inherited from Base

#xml

Instance Method Summary collapse

Methods inherited from Base

#decrypt, from_xml, #inspect, load_object_array, load_string_array, lookup_qname, #to_s, #to_xml

Constructor Details

#initialize(code = SUCCESS, message = nil) ⇒ Status

Returns a new instance of Status.

Parameters:

  • code (String) (defaults to: SUCCESS)
  • message (String, nil) (defaults to: nil) 


16
17
18
19
20
 
# File 'lib/saml2/status.rb', line 16

def initialize(code = SUCCESS, message = nil)
  super()
  @code = code
  @message = message
end

Instance Attribute Details

#code ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/saml2/status.rb', line 12

def code
  @code
end

#message ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/saml2/status.rb', line 12

def message
  @message
end

Instance Method Details

#build(builder) ⇒ void

This method returns an undefined value.

Serialize this object to XML, as part of a larger document

Parameters:

  • builder (Nokogiri::XML::Builder) —

    The builder helper object to serialize to.



34
35
36
37
38
39
40
41
 
# File 'lib/saml2/status.rb', line 34

def build(builder)
  builder["samlp"].Status do |status|
    status["samlp"].StatusCode(Value: code)
    Array(message).each do |m|
      status["samlp"].StatusMessage(m)
    end
  end
end

#from_xml(node) ⇒ void

This method returns an undefined value.

Parse an XML element into this object.

Parameters:

  • node (Nokogiri::XML::Element) 


23
24
25
26
27
 
# File 'lib/saml2/status.rb', line 23

def from_xml(node)
  super
  self.code = node.at_xpath("samlp:StatusCode", Namespaces::ALL)["Value"]
  self.message = load_string_array(xml, "samlp:StatusMessage")
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/saml2/status.rb', line 29

def success?
  code == SUCCESS
end