Package ndg :: Package saml :: Package saml2 :: Module core :: Class Attribute
[hide private]

Class Attribute

source code


SAML 2.0 Core Attribute

Instance Methods [hide private]
 
__init__(self, **kw)
Initialise Attribute Class attributes
source code
dict
__getstate__(self)
Enable pickling
source code
string
_get_name(self)
Get name
source code
 
_set_name(self, name)
Set name
source code
string
_get_nameFormat(self)
Get name format
source code
 
_set_nameFormat(self, nameFormat)
Set name format
source code
string
_get_friendlyName(self)
Get friendly name
source code
 
_set_friendlyName(self, friendlyName)
Set friendly name
source code
string
_get_attributeValues(self)
Get attribute values
source code
 
_set_attributeValues(self, attributeValues)
Set attribute values
source code

Inherited from common.SAMLObject: __setstate__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from common.SAMLObject: fromXML, toXML

Class Variables [hide private]
None DEFAULT_ELEMENT_LOCAL_NAME = 'Attribute'
default XML element name - derived classes must specify
ndg.saml.common.xml.QName DEFAULT_ELEMENT_NAME = QName(SAMLConstants.SAML20_NS, DEFAULT_...
Default element name.
string TYPE_LOCAL_NAME = 'AttributeType'
Local name of the XSI type.
ndg.saml.common.xml.QName TYPE_NAME = QName(SAMLConstants.SAML20_NS, TYPE_LOCAL_NAME, SA...
QName of the XSI type.
string NAME_ATTRIB_NAME = 'Name'
Name of the Name attribute.
string NAME_FORMAT_ATTRIB_NAME = 'NameFormat'
Name for the NameFormat attribute.
string FRIENDLY_NAME_ATTRIB_NAME = 'FriendlyName'
Name of the FriendlyName attribute.
string UNSPECIFIED = 'urn:oasis:names:tc:SAML:2.0:attrname-format:uns...
Unspecified attribute format ID.
string URI_REFERENCE = 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
URI reference attribute format ID.
string BASIC = 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic'
Basic attribute format ID.
Instance Variables [hide private]
list / tuple __attributeValues
list of values
NoneType / basestring __friendlyName
friendly name for attribute
NoneType / basestring __name
attribute name
NoneType / basestring __nameFormat
name format
Properties [hide private]
  name
name of this attribute
  nameFormat
Get the name format of this attribute.
  friendlyName
the friendly name of this attribute.
  attributeValues
the list of attribute values for this attribute.

Inherited from common.SAMLObject: qname

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kw)
(Constructor)

source code 

Initialise Attribute Class attributes

Parameters:
  • kw (dict) - keywords SAMLObject parent instantiation
Overrides: object.__init__

__getstate__(self)

source code 

Enable pickling

Returns: dict
object's attribute dictionary
Overrides: common.SAMLObject.__getstate__

_get_name(self)

source code 

Get name

Returns: string
name

_set_name(self, name)

source code 

Set name

Parameters:
  • name (basestring) - name
Raises:
  • TypeError - invalid input value type

_get_nameFormat(self)

source code 

Get name format

Returns: string
name format

_set_nameFormat(self, nameFormat)

source code 

Set name format

Parameters:
  • nameFormat (string) - name format
Raises:
  • TypeError - invalid input value type

_get_friendlyName(self)

source code 

Get friendly name

Returns: string
friendly name

_set_friendlyName(self, friendlyName)

source code 

Set friendly name

Parameters:
  • friendlyName (string) - friendly name
Raises:
  • TypeError - invalid input value type

_get_attributeValues(self)

source code 

Get attribute values

Returns: string
attribute values

_set_attributeValues(self, attributeValues)

source code 

Set attribute values

Parameters:
  • attributeValues (list/tuple) - attribute values
Raises:
  • TypeError - invalid input value type

Class Variable Details [hide private]

DEFAULT_ELEMENT_NAME

Default element name.
Type:
ndg.saml.common.xml.QName
Value:
QName(SAMLConstants.SAML20_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstan\
ts.SAML20_PREFIX)

TYPE_NAME

QName of the XSI type.
Type:
ndg.saml.common.xml.QName
Value:
QName(SAMLConstants.SAML20_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20_P\
REFIX)

UNSPECIFIED

Unspecified attribute format ID.
Type:
string
Value:
'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified'

Property Details [hide private]

name

name of this attribute

Get Method:
_get_name(self) - Get name
Set Method:
_set_name(self, name) - Set name

nameFormat

Get the name format of this attribute.

Get Method:
_get_nameFormat(self) - Get name format
Set Method:
_set_nameFormat(self, nameFormat) - Set name format

friendlyName

the friendly name of this attribute.

Get Method:
_get_friendlyName(self) - Get friendly name
Set Method:
_set_friendlyName(self, friendlyName) - Set friendly name

attributeValues

the list of attribute values for this attribute.

Get Method:
_get_attributeValues(self) - Get attribute values
Set Method:
_set_attributeValues(self, attributeValues) - Set attribute values