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

Class Status

source code


SAML 2.0 Core Status

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
ndg.saml.saml2.core.StatusCode
_getStatusCode(self)
Get the Code of this Status
source code
 
_setStatusCode(self, value)
Set the Code of this Status
source code
ndg.saml.saml2.core.StatusMessage
_getStatusMessage(self)
Get the Message of this Status.
source code
 
_setStatusMessage(self, value)
Set the Message of this Status
source code
ndg.saml.saml2.core.StatusDetail
_getStatusDetail(self)
Get the Detail of this Status
source code
 
_setStatusDetail(self, value)
Sets the Detail of this Status.
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 = 'Status'
default XML element name - derived classes must specify
ndg.common.xml.QName DEFAULT_ELEMENT_NAME = QName(SAMLConstants.SAML20P_NS, DEFAULT...
Default element name.
string TYPE_LOCAL_NAME = 'StatusType'
Local name of the XSI type.
ndg.common.xml.QName TYPE_NAME = QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, S...
QName of the XSI type.
Instance Variables [hide private]
ndg.saml.saml2.core.StatusCode __statusCode
status code
ndg.saml.saml2.core.StatusDetail __statusDetail
status detail
ndg.saml.saml2.core.StatusMessage __statusMessage
status message
Properties [hide private]
  statusCode
status code object
  statusMessage
status message
  statusDetail
status detail

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:
  • namespaceURI - the namespace the element is in
  • elementLocalName - the local name of the XML element this Object represents, defaults to DEFAULT_ELEMENT_LOCAL_NAME. Ensure that this is set to a valid string in derived classes rather the None base class setting
  • namespacePrefix - the prefix for the given namespace
Overrides: object.__init__
(inherited documentation)

__getstate__(self)

source code 

Enable pickling

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

_getStatusCode(self)

source code 

Get the Code of this Status

Returns: ndg.saml.saml2.core.StatusCode
Status object's StatusCode

_setStatusCode(self, value)

source code 

Set the Code of this Status

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

_getStatusMessage(self)

source code 

Get the Message of this Status.

Returns: ndg.saml.saml2.core.StatusMessage
Status message

_setStatusMessage(self, value)

source code 

Set the Message of this Status

Parameters:
  • value (ndg.saml.saml2.core.StatusMessage) - the Message associated with this Status
Raises:
  • TypeError - incorrect input value type

_getStatusDetail(self)

source code 

Get the Detail of this Status

Returns: ndg.saml.saml2.core.StatusDetail
Status object's StatusDetail

_setStatusDetail(self, value)

source code 

Sets the Detail of this Status.

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

Class Variable Details [hide private]

DEFAULT_ELEMENT_NAME

Default element name.
Type:
ndg.common.xml.QName
Value:
QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConsta\
nts.SAML20P_PREFIX)

TYPE_NAME

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

Property Details [hide private]

statusCode

status code object

Get Method:
_getStatusCode(self) - Get the Code of this Status
Set Method:
_setStatusCode(self, value) - Set the Code of this Status

statusMessage

status message

Get Method:
_getStatusMessage(self) - Get the Message of this Status.
Set Method:
_setStatusMessage(self, value) - Set the Message of this Status

statusDetail

status detail

Get Method:
_getStatusDetail(self) - Get the Detail of this Status
Set Method:
_setStatusDetail(self, value) - Sets the Detail of this Status.