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

Class Subject

source code


Implementation of SAML 2.0 Subject

Instance Methods [hide private]
 
__init__(self, **kw)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
dict
__getstate__(self)
Enable pickling
source code
basestring
_getBaseID(self)
Get base identifier
source code
 
_setBaseID(self, value)
Set base identifier
source code
basestring
_getNameID(self)
Get name identifier
source code
 
_setNameID(self, value)
Set name identifier
source code
basestring
_getEncryptedID(self)
Get encrypted identifier
source code
 
_setEncryptedID(self, value)
Set encrypted identifier
source code
list
_getSubjectConfirmations(self)
Get list of subject confirmations
source code
list
getOrderedChildren(self)
Get list containing base, name and encrypted IDs and the subject confirmations
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 = 'Subject'
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 = 'SubjectType'
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.
Instance Variables [hide private]
basestring __baseID
base identifier
any - not implemented for type checking __encryptedID
encrypted identifier
basestring __nameID
name identifier
list __subjectConfirmations
list of subject confirmations
Properties [hide private]
  baseID
Base identifier
  nameID
Name identifier
  encryptedID
EncryptedID's Docstring
  subjectConfirmations
Subject Confirmations

Inherited from common.SAMLObject: qname

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kw)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • kw (dict) - keywords for initialisation of parent class attributes
Overrides: object.__init__

__getstate__(self)

source code 

Enable pickling

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

_getBaseID(self)

source code 

Get base identifier

Returns: basestring
base identifier

_setBaseID(self, value)

source code 

Set base identifier

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

_getNameID(self)

source code 

Get name identifier

Returns: basestring
name identifier

_setNameID(self, value)

source code 

Set name identifier

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

_getEncryptedID(self)

source code 

Get encrypted identifier

Returns: basestring
encrypted identifier

_setEncryptedID(self, value)

source code 

Set encrypted identifier

Parameters:
  • value (any type) - encrypted identifier
Raises:
  • TypeError - invalid input value type

_getSubjectConfirmations(self)

source code 

Get list of subject confirmations

Returns: list
list of subject confirmations

getOrderedChildren(self)

source code 

Get list containing base, name and encrypted IDs and the subject confirmations

Returns: list
list of all child attributes

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)

Property Details [hide private]

baseID

Base identifier

Get Method:
_getBaseID(self) - Get base identifier
Set Method:
_setBaseID(self, value) - Set base identifier

nameID

Name identifier

Get Method:
_getNameID(self) - Get name identifier
Set Method:
_setNameID(self, value) - Set name identifier

encryptedID

EncryptedID's Docstring

Get Method:
_getEncryptedID(self) - Get encrypted identifier
Set Method:
_setEncryptedID(self, value) - Set encrypted identifier

subjectConfirmations

Subject Confirmations

Get Method:
_getSubjectConfirmations(self) - Get list of subject confirmations