Home       Trees       Indices       Help   
NERC DataGrid SAML 2.0
Package ndg :: Package saml :: Package saml2 :: Module core :: Class AuthzDecisionQuery
[hide private]

Class AuthzDecisionQuery

source code

SAML 2.0 AuthzDecisionQuery

Instance Methods [hide private]
 
__init__(self, normalizeResource=True, safeNormalizationChars='/%')
Create new authorisation decision query		 source code
dict
__getstate__(self)
Enable pickling		 source code
bool
_getNormalizeResource(self)
Returns: flag to set whether to apply normalisation of resource URI or not		 source code
 
_setNormalizeResource(self, value) source code
string
_getSafeNormalizationChars(self)
Returns: safe normalisation characters for input into normalisation of resource URI.		 source code
 
_setSafeNormalizationChars(self, value) source code
basestring
_getResource(self)
Get the Resource attrib value of this query		 source code
 
_setResource(self, value)
Sets the Resource attrib value of this query.		 source code
ndg.saml.saml2.core.Evidence or NoneType
_getEvidence(self)
Get the Evidence of this query		 source code
 
_setEvidence(self, value)
Set the Evidence of this query		 source code
tuple
getOrderedChildren(self)
Return attributes for this element as a tuple		 source code

Inherited from SubjectQuery (private): _getSubject, _setSubject

Inherited from RequestAbstractType (private): _get_consent, _get_destination, _get_extensions, _get_id, _get_issueInstant, _get_issuer, _get_version, _set_consent, _set_destination, _set_extensions, _set_id, _set_issueInstant, _set_issuer, _set_version

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 = 'AuthzDecisionQuery'
default XML element name - derived classes must specify
string DEFAULT_ELEMENT_NAME = QName(SAMLConstants.SAML20P_NS, DEFAULT...
Default element name.
string TYPE_LOCAL_NAME = 'AuthzDecisionQueryType'
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 RESOURCE_ATTRIB_NAME = 'Resource'
Resource attribute name.

Inherited from RequestAbstractType: CONSENT_ATTRIB_NAME, DESTINATION_ATTRIB_NAME, EXPLICIT_CONSENT, ID_ATTRIB_NAME, IMPLICIT_CONSENT, INAPPLICABLE_CONSENT, ISSUE_INSTANT_ATTRIB_NAME, OBTAINED_CONSENT, PRIOR_CONSENT, UNAVAILABLE_CONSENT, UNSPECIFIED_CONSENT, VERSION_ATTRIB_NAME

Instance Variables [hide private]
bool normalizeResource
Set to Truefor normalization of resource URIs in property set method
string safeNormalizationChars
safe character settings for normalisation
string resource
Resource attribute value.
string actions
Action child elements.
string evidence
Evidence child element.
Properties [hide private]
  __actions
  __evidence
  __normalizeResource
  __resource
  __safeNormalizationChars

Inherited from SubjectQuery: subject

Inherited from RequestAbstractType: consent, destination, extensions, id, issueInstant, issuer, version

Inherited from common.SAMLObject: qname

Inherited from object: __class__

Method Details [hide private]

__init__(self, normalizeResource=True, safeNormalizationChars='/%')
(Constructor)

source code 

Create new authorisation decision query

Parameters:
  • kw - keywords to set attributes of superclasses
Overrides: object.__init__

__getstate__(self)

source code 

Enable pickling

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

_getNormalizeResource(self)

source code 
Returns: bool
flag to set whether to apply normalisation of resource URI or not

_setNormalizeResource(self, value)

source code 
Parameters:
  • value (bool) - flag to set whether to apply normalisation of resource URI or not
Raises:
  • TypeError - incorrect type for input value

_getSafeNormalizationChars(self)

source code 
Returns: string
safe normalisation characters for input into normalisation of resource URI.

_setSafeNormalizationChars(self, value)

source code 
Parameters:
  • value (string) - safe normalisation characters for input into normalisation of resource URI. It only applies if normalizeResource is set to True
Raises:
  • TypeError - incorrect type for input value

_getResource(self)

source code 

Get the Resource attrib value of this query

Returns: basestring
the Resource attrib value of this query

_setResource(self, value)

source code 

Sets the Resource attrib value of this query.

If normalizeResource attribute is True, the path is normalized removing spurious port numbers (80 for HTTP and 443 for HTTPS) and converting the host component to lower case.

Parameters:
  • value (basestring) - the new Resource attrib value of this query
Raises:
  • TypeError - if incorrect input type

_getEvidence(self)

source code 

Get the Evidence of this query

Returns: ndg.saml.saml2.core.Evidence or NoneType
the Evidence of this query

_setEvidence(self, value)

source code 

Set the Evidence of this query

Parameters:
  • value (ndg.saml.saml2.core.Evidence) - the new Evidence of this query
Raises:
  • TypeError - incorrect input type

getOrderedChildren(self)

source code 

Return attributes for this element as a tuple

Returns: tuple
attributes for this element

Class Variable Details [hide private]

DEFAULT_ELEMENT_NAME

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

TYPE_NAME

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

Instance Variable Details [hide private]

normalizeResource

Set to Truefor normalization of resource URIs in property set method
Get Method:
_getNormalizeResource(self) - Returns: flag to set whether to apply normalisation of resource URI or not
Set Method:
_setNormalizeResource(self, value)

safeNormalizationChars

safe character settings for normalisation
Get Method:
_getSafeNormalizationChars(self) - Returns: safe normalisation characters for input into normalisation of resource URI.
Set Method:
_setSafeNormalizationChars(self, value)

resource

Resource attribute value.
Get Method:
_getResource(self) - Get the Resource attrib value of this query
Set Method:
_setResource(self, value) - Sets the Resource attrib value of this query.

actions

Action child elements.
Get Method:
unreachable.actions(self) - The actions for which authorisation is requested
Type:
string

evidence

Evidence child element.
Get Method:
_getEvidence(self) - Get the Evidence of this query
Set Method:
_setEvidence(self, value) - Set the Evidence of this query

   Home       Trees       Indices       Help   
NERC DataGrid SAML 2.0
Generated by Epydoc 3.0.1 on Wed Apr 4 22:19:25 2012 http://epydoc.sourceforge.net