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

Class RequestAbstractType

source code


SAML 2.0 Core RequestAbstractType

Instance Methods [hide private]
 
__init__(self, **kw)
Request abstract type
source code
dict
__getstate__(self)
Enable pickling
source code
ndg.saml.common.SAMLVersion
_get_version(self)
Returns: the SAML Version of this assertion
source code
 
_set_version(self, version) source code
datetime.datetime
_get_issueInstant(self)
Get the date/time the request was issued
source code
 
_set_issueInstant(self, value)
Sets the date/time the request was issued
source code
basestring
_get_id(self)
Get the unique identifier for this request
source code
 
_set_id(self, value)
Set the unique identifier for this request
source code
basestring
_get_destination(self)
Get the URI of the destination of the request
source code
 
_set_destination(self, value)
Set the URI of the destination of the request
source code
basestring
_get_consent(self)
Get the consent obtained from the principal for sending this request
source code
 
_set_consent(self, value)
Set the consent obtained from the principal for sending this request
source code
 
_set_issuer(self, issuer)
Set issuer of request
source code
ndg.saml.saml2.coreIssuer
_get_issuer(self)
Get the issuer name
source code
iterable
_get_extensions(self)
Get the Extensions of this request
source code
 
_set_extensions(self, value)
Sets the Extensions of this request.
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 = 'RequestAbstractType'
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 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 request
string __extensions
request extensions
string __id
request identifier
string __issueInstant
issue instant
string __issuer
request issuer identifier
string __version
SAML version
Properties [hide private]
  version
SAML Version of the assertion
  issueInstant
Issue instant of the request
  id
ID of request
  destination
Destination of request
  consent
Consent for request
  issuer
Issuer of request
  extensions
Request extensions

Inherited from common.SAMLObject: qname

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kw)
(Constructor)

source code 

Request abstract type

Parameters:
  • kw (dict) - see SAMLObject.__init__
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: ndg.saml.common.SAMLVersion
the SAML Version of this assertion

_set_version(self, version)

source code 
Parameters:
  • version (ndg.saml.common.SAMLVersion) - the SAML Version of this assertion
Raises:
  • TypeError - incorrect input version value type

_get_issueInstant(self)

source code 

Get the date/time the request was issued

Returns: datetime.datetime
the issue instance of this request

_set_issueInstant(self, value)

source code 

Sets the date/time the request was issued

Parameters:
  • value (datetime.datetime) - the issue instance of this request

_get_id(self)

source code 

Get the unique identifier for this request

Returns: basestring
the ID of this request

_set_id(self, value)

source code 

Set the unique identifier for this request

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

_get_destination(self)

source code 

Get the URI of the destination of the request

Returns: basestring
the URI of the destination of the request

_set_destination(self, value)

source code 

Set the URI of the destination of the request

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

_get_consent(self)

source code 

Get the consent obtained from the principal for sending this request

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

_set_consent(self, value)

source code 

Set the consent obtained from the principal for sending this request

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

_set_issuer(self, issuer)

source code 

Set issuer of request

Parameters:
  • issuer (ndg.saml.saml2.coreIssuer) - issuer of the request
Raises:
  • TypeError - incorrect input type

_get_issuer(self)

source code 

Get the issuer name

Returns: ndg.saml.saml2.coreIssuer
issuer of the request

_get_extensions(self)

source code 

Get the Extensions of this request

Returns: iterable
the Status of this request

_set_extensions(self, value)

source code 

Sets the Extensions of this request.

Parameters:
  • value (iterable) - the Extensions of this request

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 assertion

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

issueInstant

Issue instant of the request

Get Method:
_get_issueInstant(self) - Get the date/time the request was issued
Set Method:
_set_issueInstant(self, value) - Sets the date/time the request was issued

id

ID of request

Get Method:
_get_id(self) - Get the unique identifier for this request
Set Method:
_set_id(self, value) - Set the unique identifier for this request

destination

Destination of request

Get Method:
_get_destination(self) - Get the URI of the destination of the request
Set Method:
_set_destination(self, value) - Set the URI of the destination of the request

consent

Consent for request

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

issuer

Issuer of request

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

extensions

Request extensions

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