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

Class StatusResponseType

source code


SAML 2.0 Core Status Response Type

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
string
_get_version(self)
Returns: the SAML Version of this response
source code
 
_set_version(self, version) source code
basestring
_get_id(self)
Sets the ID of this response.
source code
 
_set_id(self, value)
Sets the ID of this response.
source code
basestring
_getInResponseTo(self)
Get the unique request identifier for which this is a response
source code
 
_setInResponseTo(self, value)
Set the unique request identifier for which this is a response
source code
datetime.datetime
_get_issueInstant(self)
Gets the issue instant of this response.
source code
 
_set_issueInstant(self, issueInstant)
Set the issue instant of this response
source code
basestring
_get_destination(self)
Gets the URI of the destination of the response.
source code
 
_set_destination(self, value)
Sets the URI of the destination of the response.
source code
basestring
_get_consent(self)
Get the consent obtained from the principal for sending this response
source code
 
_set_consent(self, value)
Sets the consent obtained from the principal for sending this response.
source code
 
_set_issuer(self, issuer)
Set issuer of response
source code
ndg.saml.saml2.core.Issuer
_get_issuer(self)
Get the issuer name
source code
ndg.saml.saml2.core.Status
_getStatus(self)
Gets the Status of this response.
source code
 
_setStatus(self, value)
Sets the Status of this response.
source code
tuple/list/NoneType
_get_extensions(self)
Gets the Extensions of this response.
source code
 
_set_extensions(self, value)
Sets the Extensions of this response.
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]
string TYPE_LOCAL_NAME = 'StatusResponseType'
Local name of the XSI type.
ndg.saml.common.xml.QName TYPE_NAME = QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, S...
QName of the XSI type.
string ID_ATTRIB_NAME = 'ID'
ID attribute name
string IN_RESPONSE_TO_ATTRIB_NAME = 'InResponseTo'
InResponseTo attribute name
string VERSION_ATTRIB_NAME = 'Version'
Version attribute name
string ISSUE_INSTANT_ATTRIB_NAME = 'IssueInstant'
IssueInstant attribute name
string DESTINATION_ATTRIB_NAME = 'Destination'
Destination attribute name
string CONSENT_ATTRIB_NAME = 'Consent'
Consent attribute name.
string UNSPECIFIED_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:uns...
Unspecified consent URI
string OBTAINED_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:obtained'
Obtained consent URI
string PRIOR_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:prior'
Prior consent URI
string IMPLICIT_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:implicit'
Implicit consent URI
string EXPLICIT_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:explicit'
Explicit consent URI
string UNAVAILABLE_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:una...
Unavailable consent URI
string INAPPLICABLE_CONSENT = 'urn:oasis:names:tc:SAML:2.0:consent:in...
Inapplicable consent URI

Inherited from common.SAMLObject: DEFAULT_ELEMENT_LOCAL_NAME

Instance Variables [hide private]
string __consent
consent information
string __destination
destination for the response
list or tuple __extensions
response extensions
string __id
response identifier
string __inResponseTo
identifier corresponding to the query this response is responding to
datetime.datetime __issueInstant
issue instant for the response
ndg.saml.saml2.core.Issuer __issuer
issuer identifier
ndg.saml.saml2.core.Status __status
status of the response
string __version
SAML version
Properties [hide private]
  version
SAML Version of the response
  id
ID of response
  inResponseTo
unique request identifier for which this is a response
  issueInstant
Issue instant of the response
  destination
Destination of response
  consent
Consent for response
  issuer
Issuer of response
  status
Response status
  extensions
Response extensions

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 superclass
Overrides: object.__init__

__getstate__(self)

source code 

Enable pickling

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

_get_version(self)

source code 
Returns: string
the SAML Version of this response

_set_version(self, version)

source code 
Parameters:
  • version (basestring) - the SAML Version of this response
Raises:
  • TypeError - incorrect type for input version

_get_id(self)

source code 

Sets the ID of this response.

Returns: basestring
the ID of this response

_set_id(self, value)

source code 

Sets the ID of this response.

Parameters:
  • value (basestring) - the ID of this response
Raises:
  • TypeError - incorrect type for input value

_getInResponseTo(self)

source code 

Get the unique request identifier for which this is a response

Returns: basestring
the unique identifier of the originating request

_setInResponseTo(self, value)

source code 

Set the unique request identifier for which this is a response

Parameters:
  • value (basestring) - the unique identifier of the originating request
Raises:
  • TypeError - incorrect type for input value

_get_issueInstant(self)

source code 

Gets the issue instant of this response.

Returns: datetime.datetime
the issue instant of this response

_set_issueInstant(self, issueInstant)

source code 

Set the issue instant of this response

Parameters:
  • issueInstant (datetime.datetime) - the issue instance of this response
Raises:
  • TypeError - incorrect type for input value

_get_destination(self)

source code 

Gets the URI of the destination of the response.

Returns: basestring
the URI of the destination of the response

_set_destination(self, value)

source code 

Sets the URI of the destination of the response.

Parameters:
  • value (basestring) - the URI of the destination of the response
Raises:
  • TypeError - incorrect type for input value

_get_consent(self)

source code 

Get the consent obtained from the principal for sending this response

Returns: basestring
the consent obtained from the principal for sending this response

_set_consent(self, value)

source code 

Sets the consent obtained from the principal for sending this response.

Parameters:
  • value (basestring) - the new consent obtained from the principal for sending this response
Raises:
  • TypeError - incorrect type for input value

_set_issuer(self, issuer)

source code 

Set issuer of response

Parameters:
  • issuer (ndg.saml.saml2.core.Issuer) - issuer of this response sending this response
Raises:
  • TypeError - incorrect type for input value

_get_issuer(self)

source code 

Get the issuer name

Returns: ndg.saml.saml2.core.Issuer
issuer of this response sending this response

_getStatus(self)

source code 

Gets the Status of this response.

Returns: ndg.saml.saml2.core.Status
the Status of this response

_setStatus(self, value)

source code 

Sets the Status of this response.

Parameters:
  • value (ndg.saml.saml2.core.Status) - the Status of this response
Raises:
  • TypeError - incorrect type for input value

_get_extensions(self)

source code 

Gets the Extensions of this response.

Returns: tuple/list/NoneType
the Status of this response

_set_extensions(self, value)

source code 

Sets the Extensions of this response.

Parameters:
  • value (tuple or list) - the Extensions of this response
Raises:
  • TypeError - incorrect type for input value

Class Variable Details [hide private]

TYPE_NAME

QName of the XSI type.
Type:
ndg.saml.common.xml.QName
Value:
QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20P\
_PREFIX)

UNSPECIFIED_CONSENT

Unspecified consent URI
Type:
string
Value:
'urn:oasis:names:tc:SAML:2.0:consent:unspecified'

UNAVAILABLE_CONSENT

Unavailable consent URI
Type:
string
Value:
'urn:oasis:names:tc:SAML:2.0:consent:unavailable'

INAPPLICABLE_CONSENT

Inapplicable consent URI
Type:
string
Value:
'urn:oasis:names:tc:SAML:2.0:consent:inapplicable'

Property Details [hide private]

version

SAML Version of the response

Get Method:
_get_version(self) - Returns: the SAML Version of this response
Set Method:
_set_version(self, version)

id

ID of response

Get Method:
_get_id(self) - Sets the ID of this response.
Set Method:
_set_id(self, value) - Sets the ID of this response.

inResponseTo

unique request identifier for which this is a response

Get Method:
_getInResponseTo(self) - Get the unique request identifier for which this is a response
Set Method:
_setInResponseTo(self, value) - Set the unique request identifier for which this is a response

issueInstant

Issue instant of the response

Get Method:
_get_issueInstant(self) - Gets the issue instant of this response.
Set Method:
_set_issueInstant(self, issueInstant) - Set the issue instant of this response

destination

Destination of response

Get Method:
_get_destination(self) - Gets the URI of the destination of the response.
Set Method:
_set_destination(self, value) - Sets the URI of the destination of the response.

consent

Consent for response

Get Method:
_get_consent(self) - Get the consent obtained from the principal for sending this response
Set Method:
_set_consent(self, value) - Sets the consent obtained from the principal for sending this response.

issuer

Issuer of response

Get Method:
_get_issuer(self) - Get the issuer name
Set Method:
_set_issuer(self, issuer) - Set issuer of response

status

Response status

Get Method:
_getStatus(self) - Gets the Status of this response.
Set Method:
_setStatus(self, value) - Sets the Status of this response.

extensions

Response extensions

Get Method:
_get_extensions(self) - Gets the Extensions of this response.
Set Method:
_set_extensions(self, value) - Sets the Extensions of this response.