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

Class StatusMessage

source code


Implementation of SAML 2.0 Status Message

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
_getValue(self)
Returns: message text
source code
 
_setValue(self, value) 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 = 'StatusMessage'
default XML element name - derived classes must specify
ndg.saml.common.xml.QName DEFAULT_ELEMENT_NAME = QName(SAMLConstants.SAML20P_NS, DEFAULT...
Default element name
Instance Variables [hide private]
basestring __value
message text
Properties [hide private]
  value
Status message value

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__

_getValue(self)

source code 
Returns: basestring
message text

_setValue(self, value)

source code 
Parameters:
  • value (basestring) - message text
Raises:
  • TypeError - incorrect type for input value

Class Variable Details [hide private]

DEFAULT_ELEMENT_NAME

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

Property Details [hide private]

value

Status message value

Get Method:
_getValue(self) - Returns: message text
Set Method:
_setValue(self, value)