class SAML2::RequestedAttribute

Public Class Methods

create(name, is_required = nil) click to toggle source

Create a RequestAttribute object to represent an attribute.

{Attribute.create} will be used to create a temporary object, so that attribute-class specific inferences (i.e. {Attribute::X500} friendly names) will be done, but always returns a {RequestedAttribute}. @param name [String]

The attribute name. This can be a friendly name, or a URI.

@param is_required optional [true, false, nil] @return [RequestedAttribute]

# File lib/saml2/attribute_consuming_service.rb, line 34
def create(name, is_required = nil)
  attribute = Attribute.create(name)
  new(attribute.name, is_required, attribute.friendly_name, attribute.name_format)
end
element() click to toggle source

The XML element that this attribute class serializes as. @return [‘RequestedAttribute’]

# File lib/saml2/attribute_consuming_service.rb, line 21
def element
  "RequestedAttribute"
end
namespace() click to toggle source

The XML namespace that this attribute class serializes as. @return [‘md’]

# File lib/saml2/attribute_consuming_service.rb, line 15
def namespace
  "md"
end
new(name = nil, is_required = nil, friendly_name = nil, name_format = nil) click to toggle source

Create a new {RequestedAttribute}.

@param name [String] @param is_required optional [true, false, nil] @param friendly_name optional [String, nil] @param name_format optional [String, nil]

Calls superclass method SAML2::Attribute::new
# File lib/saml2/attribute_consuming_service.rb, line 46
def initialize(name = nil, is_required = nil, friendly_name = nil, name_format = nil)
  super(name, nil, friendly_name, name_format)
  @is_required = is_required
end

Public Instance Methods

from_xml(node) click to toggle source

(see Base#from_xml)

Calls superclass method SAML2::Attribute::from_xml
# File lib/saml2/attribute_consuming_service.rb, line 52
def from_xml(node)
  super
  @is_required = node["isRequired"] && node["isRequired"] == "true"
end
required?() click to toggle source

@return [true, false, nil]

# File lib/saml2/attribute_consuming_service.rb, line 58
def required?
  @is_required
end