Class: SAML2::NameID::Policy

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

Instance Attribute Summary collapse

Attributes inherited from Base

#xml

Instance Method Summary collapse

Methods inherited from Base

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

Constructor Details

#initialize(allow_create = nil, format = nil, sp_name_qualifier = nil) ⇒ Policy

Returns a new instance of Policy.

Parameters:

  • allow_create (defaults to: nil)

    optional [Boolean]

  • format (defaults to: nil)

    optional [String]

  • sp_name_qualifier (defaults to: nil)

    optional [String]



27
28
29
30
31
# File 'lib/saml2/name_id.rb', line 27

def initialize(allow_create = nil, format = nil, sp_name_qualifier = nil)
  @allow_create = allow_create if allow_create
  @format = format if format
  @sp_name_qualifier = sp_name_qualifier if sp_name_qualifier
end

Instance Attribute Details

#allow_create=(value) ⇒ Boolean? (writeonly)

Returns:

  • (Boolean, nil)


21
22
23
# File 'lib/saml2/name_id.rb', line 21

def allow_create=(value)
  @allow_create = value
end

#formatString?

Returns:

  • (String, nil)

See Also:



43
44
45
46
47
48
# File 'lib/saml2/name_id.rb', line 43

def format
  if xml && !instance_variable_defined?(:@format)
    @format = xml['Format']
  end
  @format
end

#sp_name_qualifierString?

Returns:

  • (String, nil)


51
52
53
54
55
56
# File 'lib/saml2/name_id.rb', line 51

def sp_name_qualifier
  if xml && !instance_variable_defined?(:@sp_name_qualifier)
    @sp_name_qualifier = xml['SPNameQualifier']
  end
  @sp_name_qualifier
end

Instance Method Details

#==(rhs) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)


60
61
62
63
64
# File 'lib/saml2/name_id.rb', line 60

def ==(rhs)
  allow_create? == rhs.allow_create? &&
      format == rhs.format &&
      sp_name_qualifier == rhs.sp_name_qualifier
end

#allow_create?Boolean?

Returns:

  • (Boolean, nil)


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

def allow_create?
  if xml && !instance_variable_defined?(:@allow_create)
    @allow_create = xml['AllowCreate']&.== 'true'
  end
  @allow_create
end

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



67
68
69
70
71
72
73
# File 'lib/saml2/name_id.rb', line 67

def build(builder)
  builder['samlp'].NameIDPolicy do |name_id_policy|
    name_id_policy.parent['Format'] = format if format
    name_id_policy.parent['SPNameQualifier'] = sp_name_qualifier if sp_name_qualifier
    name_id_policy.parent['AllowCreate'] = allow_create? unless allow_create?.nil?
  end
end