Changeset 6906


Ignore:
Timestamp:
28/05/10 14:58:47 (9 years ago)
Author:
pjkersha
Message:

Incomplete - task 6: Put NDG SAML package on PyPI

  • updating epydoc for 'core' module
Location:
TI12-security/trunk/ndg_saml/ndg/saml
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/ndg_saml/ndg/saml/common/xml.py

    r6901 r6906  
    396396    def _setPrefix(self, value): 
    397397        """Set prefix 
    398         @param: prefix 
     398        @param value: prefix 
    399399        @type: string 
    400400        @raise TypeError: invalid input value type 
  • TI12-security/trunk/ndg_saml/ndg/saml/saml2/core.py

    r6902 r6906  
    993993    @type TYPE_NAME: ndg.saml.common.xml.QName 
    994994     
    995     @ivar __baseID: 
    996     @type __baseID: 
    997     @ivar __nameID: 
    998     @type __nameID: 
    999     @ivar __encryptedID: 
    1000     @type __encryptedID: 
    1001     @ivar __subjectConfirmations: 
    1002     @type __subjectConfirmations:     
     995    @ivar __baseID: base identifier 
     996    @type __baseID: basestring 
     997    @ivar __nameID: name identifier 
     998    @type __nameID: basestring 
     999    @ivar __encryptedID: encrypted identifier 
     1000    @type __encryptedID: any - not implemented for type checking 
     1001    @ivar __subjectConfirmations: list of subject confirmations 
     1002    @type __subjectConfirmations: list 
    10031003    ''' 
    10041004     
     
    10271027     
    10281028    def __init__(self, **kw): 
     1029        ''' 
     1030        @param **kw: keywords for initialisation of parent class attributes 
     1031        @type **kw: dict 
     1032        ''' 
    10291033        super(Subject, self).__init__(**kw) 
    10301034         
     
    10591063     
    10601064    def _getBaseID(self):  
     1065        """Get base identifier 
     1066        @return: base identifier 
     1067        @rtype: basestring 
     1068        """  
    10611069        return self.__baseID 
    10621070 
    10631071    def _setBaseID(self, value): 
     1072        """Set base identifier 
     1073        @param: base identifier 
     1074        @type: basestring 
     1075        @raise TypeError: invalid input value type 
     1076        """  
    10641077        if not isinstance(value, basestring): 
    10651078            raise TypeError("Expecting %r type for \"baseID\" got %r" % 
     
    10721085       
    10731086    def _getNameID(self): 
     1087        """Get name identifier 
     1088        @return: name identifier 
     1089        @rtype: basestring 
     1090        """  
    10741091        return self.__nameID 
    10751092     
    10761093    def _setNameID(self, value): 
     1094        """Set name identifier 
     1095        @param: name identifier 
     1096        @type: basestring 
     1097        @raise TypeError: invalid input value type 
     1098        """  
    10771099        if not isinstance(value, NameID): 
    10781100            raise TypeError("Expecting %r type for \"nameID\" got %r" % 
     
    10851107     
    10861108    def _getEncryptedID(self): 
     1109        """Get encrypted identifier 
     1110        @return: encrypted identifier 
     1111        @rtype: basestring 
     1112        """  
    10871113        return self.__encryptedID 
    10881114     
    10891115    def _setEncryptedID(self, value):  
     1116        """Set encrypted identifier 
     1117         
     1118        @param: encrypted identifier 
     1119        @type: any type 
     1120        @raise TypeError: invalid input value type 
     1121        """  
    10901122        self.__encryptedID = value 
    10911123 
     
    10951127     
    10961128    def _getSubjectConfirmations(self):  
     1129        """Get list of subject confirmations 
     1130        @return: list of subject confirmations 
     1131        @rtype: list 
     1132        """  
    10971133        return self.__subjectConfirmations 
    10981134 
     
    11011137     
    11021138    def getOrderedChildren(self):  
     1139        """Get list containing base, name and encrypted IDs and the subject  
     1140        confirmations 
     1141         
     1142        @return: list of all child attributes 
     1143        @rtype: list 
     1144        """  
    11031145        children = [] 
    11041146 
     
    11181160 
    11191161class AbstractNameIDType(SAMLObject): 
    1120     '''Abstract implementation of NameIDType''' 
     1162    '''Abstract implementation of NameIDType 
     1163     
     1164    @cvar SP_NAME_QUALIFIER_ATTRIB_NAME: SPNameQualifier attribute name. 
     1165    @type SP_NAME_QUALIFIER_ATTRIB_NAME: string 
     1166    @cvar FORMAT_ATTRIB_NAME: Format attribute name. 
     1167    @type FORMAT_ATTRIB_NAME: string 
     1168    @cvar SPPROVIDED_ID_ATTRIB_NAME: SPProviderID attribute name. 
     1169    @type SPPROVIDED_ID_ATTRIB_NAME: string 
     1170    @cvar UNSPECIFIED: URI for unspecified name format. 
     1171    @type UNSPECIFIED: string 
     1172    @cvar EMAIL: URI for email name format. 
     1173    @type EMAIL: string 
     1174    @cvar X509_SUBJECT: URI for X509 subject name format. 
     1175    @type X509_SUBJECT: string 
     1176    @cvar WIN_DOMAIN_QUALIFIED: URI for windows domain qualified name name  
     1177    format. 
     1178    @type WIN_DOMAIN_QUALIFIED: string 
     1179    @cvar KERBEROS: URI for kerberos name format. 
     1180    @type KERBEROS: string 
     1181    @cvar ENTITY: URI for SAML entity name format. 
     1182    @type ENTITY: string 
     1183    @cvar PERSISTENT: URI for persistent name format. 
     1184    @type PERSISTENT: string 
     1185    @cvar TRANSIENT: URI for transient name format. 
     1186    @type TRANSIENT: string 
     1187    @cvar ENCRYPTED: Special URI used by NameIDPolicy to indicate a NameID  
     1188    should be encrypted 
     1189    @type ENCRYPTED: string 
     1190 
     1191    @ivar __name: Name of the Name ID. 
     1192    @type __name: string 
     1193    @ivar __nameQualifier: Name Qualifier of the Name ID. 
     1194    @type __nameQualifier: string 
     1195    @ivar __spNameQualifier: SP Name Qualifier of the Name ID. 
     1196    @type __spNameQualifier: string 
     1197    @ivar __format: Format of the Name ID. 
     1198    @type __format: string 
     1199    @ivar __spProvidedID: SP ProvidedID of the NameID. 
     1200    @type __spProvidedID: string 
     1201    ''' 
    11211202 
    11221203    # SPNameQualifier attribute name. 
     
    11671248     
    11681249    def __init__(self, **kw):  
    1169         '''@param namespaceURI: the namespace the element is in 
    1170         @param elementLocalName: the local name of the XML element this Object  
    1171         represents 
    1172         @param namespacePrefix: the prefix for the given namespace 
     1250        ''' 
     1251        @param **kw: keywords to set attributes of parent class 
     1252        @type **kw: dict 
    11731253        ''' 
    11741254        super(AbstractNameIDType, self).__init__(**kw) 
     
    12101290              
    12111291    def _getValue(self): 
     1292        """Get name value 
     1293        @return: name value 
     1294        @rtype: string 
     1295        """ 
    12121296        return self.__value 
    12131297         
    12141298    def _setValue(self, value): 
     1299        """Set name value 
     1300        @param: name value 
     1301        @type: string 
     1302        @raise TypeError: invalid input value type 
     1303        """ 
    12151304        if not isinstance(value, basestring): 
    12161305            raise TypeError("\"value\" must be a basestring derived type, " 
     
    12221311     
    12231312    def _getNameQualifier(self):  
     1313        """Get name qualifier 
     1314        @return: name qualifier 
     1315        @rtype: string 
     1316        """ 
    12241317        return self.__nameQualifier 
    12251318     
    12261319    def _setNameQualifier(self, value):  
     1320        """Set name qualifier 
     1321        @param: name qualifier 
     1322        @type: string 
     1323        """ 
    12271324        self.__nameQualifier = value 
    12281325 
     
    12321329 
    12331330    def _getSPNameQualifier(self):  
     1331        """Get SP name qualifier 
     1332        @return: SP name qualifier 
     1333        @rtype: string 
     1334        """ 
    12341335        return self.__spNameQualifier 
    12351336     
    12361337    def _setSPNameQualifier(self, value):  
     1338        """Set SP name qualifier 
     1339        @param: SP name qualifier 
     1340        @type: string 
     1341        """ 
    12371342        self.__spNameQualifier = value 
    12381343 
     
    12421347     
    12431348    def _getFormat(self): 
     1349        """Get name format 
     1350        @return: name format 
     1351        @rtype: string 
     1352        """ 
    12441353        return self.__format 
    12451354         
    12461355    def _setFormat(self, format): 
     1356        """Set name format 
     1357        @param: name format 
     1358        @type: string 
     1359        @raise TypeError: invalid input value type 
     1360        """ 
    12471361        if not isinstance(format, basestring): 
    12481362            raise TypeError("\"format\" must be a basestring derived type, " 
     
    12541368     
    12551369    def _getSPProvidedID(self):  
     1370        """Get SP provided identifier 
     1371        @return: SP provided identifier 
     1372        @rtype: string 
     1373        """ 
    12561374        return self.__spProvidedID 
    12571375     
    12581376    def _setSPProvidedID(self, value):  
     1377        """Set SP provided identifier 
     1378        @param: SP provided identifier 
     1379        @type: string 
     1380        """ 
    12591381        self.__spProvidedID = value 
    12601382 
     
    12631385     
    12641386    def getOrderedChildren(self):  
     1387        """Get attributes as a list - not currently implemented 
     1388        @return: list of object attribute values 
     1389        @rtype: tuple 
     1390        @raise NotImplementedError: not implemented in this version 
     1391        """ 
    12651392        raise NotImplementedError() 
    12661393 
    12671394    
    12681395class Issuer(AbstractNameIDType): 
    1269     """SAML 2.0 Core Issuer type""" 
     1396    """SAML 2.0 Core Issuer type 
     1397     
     1398    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     1399    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     1400    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     1401    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName 
     1402    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     1403    @type TYPE_LOCAL_NAME: string 
     1404    @cvar TYPE_NAME: Qualified Name of the XSI type. 
     1405    @type TYPE_NAME: ndg.saml.common.xml.QName 
     1406    """ 
    12701407     
    12711408    # Element local name.  
     
    12891426      
    12901427class NameID(AbstractNameIDType): 
    1291     '''SAML 2.0 Core NameID''' 
     1428    '''SAML 2.0 Core NameID 
     1429    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     1430    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     1431    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     1432    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName 
     1433    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     1434    @type TYPE_LOCAL_NAME: string 
     1435    @cvar TYPE_NAME: Qualified Name of the XSI type. 
     1436    @type TYPE_NAME: ndg.saml.common.xml.QName 
     1437    ''' 
     1438     
    12921439    # Element local name.  
    12931440    DEFAULT_ELEMENT_LOCAL_NAME = "NameID" 
     
    13101457 
    13111458class Conditions(SAMLObject):  
    1312     '''SAML 2.0 Core Conditions.''' 
     1459    '''SAML 2.0 Core Conditions. 
     1460     
     1461    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     1462    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     1463    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     1464    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName 
     1465    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     1466    @type TYPE_LOCAL_NAME: string 
     1467    @cvar TYPE_NAME: Qualified Name of the XSI type. 
     1468    @type TYPE_NAME: ndg.saml.common.xml.QName 
     1469    @cvar NOT_BEFORE_ATTRIB_NAME: NotBefore attribute name. 
     1470    @type NOT_BEFORE_ATTRIB_NAME: string 
     1471    @cvar NOT_ON_OR_AFTER_ATTRIB_NAME: NotOnOrAfter attribute name. 
     1472    @type NOT_ON_OR_AFTER_ATTRIB_NAME: string 
     1473     
     1474    @ivar self.__conditions: A list of Conditions. 
     1475    @type self.__conditions: list 
     1476    @ivar self.__notBefore: Not Before condition 
     1477    @type self.__notBefore: NoneType / datetime.datetime 
     1478    @ivar self.__notOnOrAfter: Not On Or After conditions. 
     1479    @type self.__notOnOrAfter: NoneType / datetime.datetime 
     1480    ''' 
    13131481     
    13141482    # Element local name. 
     
    13431511        super(Conditions, self).__init__(**kw) 
    13441512         
    1345         # A Condition. 
     1513        # A list of Conditions 
    13461514        self.__conditions = [] 
    13471515     
    1348         # Not Before conditions. 
     1516        # Not Before time condition 
    13491517        self.__notBefore = None 
    13501518     
    1351         # Not On Or After conditions. 
     1519        # Not On Or After time conditions 
    13521520        self.__notOnOrAfter = None 
    13531521 
     
    13581526        @rtype: dict 
    13591527        ''' 
    1360  
    13611528        _dict = super(Conditions, self).__getstate__() 
    13621529        for attrName in Conditions.__slots__: 
     
    13731540        '''Get the date/time before which the assertion is invalid. 
    13741541         
    1375         @return: the date/time before which the assertion is invalid''' 
     1542        @return: the date/time before which the assertion is invalid 
     1543        @rtype: NoneType / datetime.datetime 
     1544        ''' 
    13761545        return self.__notBefore 
    13771546     
     
    13801549         
    13811550        @param value: the date/time before which the assertion is invalid 
     1551        @type: datetime.datetime 
    13821552        ''' 
    13831553        if not isinstance(value, datetime): 
     
    13901560         
    13911561        @return: the date/time on, or after, which the assertion is invalid' 
     1562        @rtype: NoneType / datetime.datetime 
    13921563        ''' 
    13931564        return self.__notOnOrAfter 
     
    13981569        @param value: the date/time on, or after, which the assertion  
    13991570        is invalid 
     1571        @type: datetime.datetime 
    14001572        ''' 
    14011573        if not isinstance(value, datetime): 
     
    14151587         
    14161588        @return: all the conditions on the assertion 
     1589        @rtype: list 
    14171590        ''' 
    14181591        return self.__conditions 
    14191592     
    14201593    def _getAudienceRestrictions(self): 
    1421         '''Gets the audience restriction conditions for the assertion. 
     1594        '''Get the audience restriction conditions for the assertion. 
    14221595         
    14231596        @return: the audience restriction conditions for the assertion 
     1597        @rtype: list 
     1598        @raise NotImplementedError: not currently implemented 
    14241599        ''' 
    14251600        raise NotImplementedError() 
    14261601 
    14271602    def _getOneTimeUse(self): 
    1428         '''Gets the OneTimeUse condition for the assertion. 
     1603        '''Get the OneTimeUse condition for the assertion 
    14291604         
    14301605        @return: the OneTimeUse condition for the assertion 
     1606        @rtype: ? 
     1607        @raise NotImplementedError: not currently implemented 
    14311608        ''' 
    14321609        raise NotImplementedError() 
    14331610 
    14341611    def _getProxyRestriction(self):     
    1435         '''Gets the ProxyRestriction condition for the assertion. 
     1612        '''Get the ProxyRestriction condition for the assertion 
    14361613         
    14371614        @return: the ProxyRestriction condition for the assertion 
     1615        @rtype: ? 
     1616        @raise NotImplementedError: not currently implemented 
    14381617        ''' 
    14391618        raise NotImplementedError() 
     
    14411620     
    14421621class Advice(SAMLObject): 
    1443     '''SAML 2.0 Core Advice. 
     1622    '''SAML 2.0 Core Advice.  Only the skeleton of this class is implemented 
     1623     
     1624    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     1625    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     1626    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     1627    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName 
     1628    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     1629    @type TYPE_LOCAL_NAME: string 
    14441630    ''' 
    14451631 
     
    14671653         
    14681654        @return: the list of all child elements attached to this advice 
     1655        @rtype: list 
     1656        @raise NotImplementedError: not currently implemented 
    14691657        ''' 
    14701658        raise NotImplementedError() 
     
    14741662         
    14751663        @return: the list of AssertionID references used as advice 
     1664        @rtype: list 
     1665        @raise NotImplementedError: not currently implemented 
    14761666        ''' 
    14771667        raise NotImplementedError() 
     
    14811671         
    14821672        @return: the list of AssertionURI references used as advice 
     1673        @rtype: list 
     1674        @raise NotImplementedError: not currently implemented 
    14831675        ''' 
    14841676        raise NotImplementedError() 
     
    14881680         
    14891681        @return: the list of Assertions used as advice 
     1682        @rtype: list 
     1683        @raise NotImplementedError: not currently implemented 
    14901684        ''' 
    14911685        raise NotImplementedError() 
     
    14951689         
    14961690        @return: the list of EncryptedAssertions used as advice 
     1691        @rtype: list 
     1692        @raise NotImplementedError: not currently implemented 
    14971693        ''' 
    14981694        raise NotImplementedError() 
     
    15011697class Assertion(SAMLObject): 
    15021698    """SAML 2.0 Attribute Assertion for use with NERC DataGrid     
    1503     """     
     1699 
     1700    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     1701    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     1702    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     1703    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName 
     1704    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     1705    @type TYPE_LOCAL_NAME: string 
     1706    @cvar TYPE_NAME: QName of the XSI type. 
     1707    @type TYPE_NAME: ndg.saml.common.xml.QName 
     1708    @cvar VERSION_ATTRIB_NAME: Version attribute name. 
     1709    @type VERSION_ATTRIB_NAME: string 
     1710    @cvar ISSUE_INSTANT_ATTRIB_NAME: IssueInstant attribute name. 
     1711    @type ISSUE_INSTANT_ATTRIB_NAME: string 
     1712    @cvar ID_ATTRIB_NAME: ID attribute name. 
     1713    @type ID_ATTRIB_NAME: string 
     1714     
     1715    @ivar __version: SAML version used 
     1716    @type __version: ndg.saml.common.SAMLVersion 
     1717    @ivar __issueInstant: issue instant for assertion 
     1718    @type __issueInstant: datetime.datetime 
     1719    @ivar __id: assertion identifier 
     1720    @type __id: string 
     1721    @ivar __issuer: issuer of this assertion 
     1722    @type __issuer: ndg.saml.saml2.core.Issuer 
     1723    @ivar __subject: subject of this assertion 
     1724    @type __subject: ndg.saml.saml2.core.Subject 
     1725    @ivar __conditions: conditions for this assertion 
     1726    @type __conditions: ndg.saml.saml2.core.Conditions 
     1727    @ivar __advice: advice statement 
     1728    @type __advice: string 
     1729    @ivar __statements: asserted statements 
     1730    @type __statements: ndg.saml.utils.TypedList 
     1731    @ivar __authnStatements: asserted authentication statements 
     1732    @type __authnStatements: list 
     1733    @ivar __authzDecisionStatements: asserted authorization decision statements 
     1734    @type __authzDecisionStatements: ndg.saml.utils.TypedList 
     1735    @ivar __attributeStatements: asserted attribute statements 
     1736    @type __attributeStatements: ndg.saml.utils.TypedList 
     1737    """    
     1738      
    15041739    # Element local name. 
    15051740    DEFAULT_ELEMENT_LOCAL_NAME = "Assertion" 
     
    15541789        self.__statements = TypedList(Statement) 
    15551790         
    1556         # TODO: Implement AuthnStatement and AuthzDecisionStatement classes 
     1791        # TODO: Implement AuthnStatement class 
    15571792        self.__authnStatements = [] 
    15581793        self.__authzDecisionStatements = TypedList(AuthzDecisionStatement) 
     
    15651800        @rtype: dict 
    15661801        ''' 
    1567  
    15681802        _dict = super(Assertion, self).__getstate__() 
    15691803        for attrName in Assertion.__slots__: 
     
    15781812                  
    15791813    def _get_version(self): 
    1580         '''@return: the SAML Version of this assertion. 
     1814        ''' 
     1815        @return: the SAML Version of this assertion 
     1816        @rtype: ndg.saml.common.SAMLVersion/NoneType 
    15811817        ''' 
    15821818        return self.__version 
    15831819     
    15841820    def _set_version(self, version): 
    1585         '''@param version: the SAML Version of this assertion 
     1821        ''' 
     1822        @param version: the SAML Version of this assertion 
     1823        @type version: ndg.saml.common.SAMLVersion 
     1824        @raise TypeError: incorrect type for input value 
    15861825        ''' 
    15871826        if not isinstance(version, SAMLVersion): 
     
    15981837        '''Gets the issue instance of this assertion. 
    15991838         
    1600         @return: the issue instance of this assertion''' 
     1839        @return: the issue instance of this assertion 
     1840        @rtype: datetime.datetime/NoneType 
     1841        ''' 
    16011842        return self.__issueInstant 
    16021843     
     
    16051846         
    16061847        @param issueInstant: the issue instance of this assertion 
     1848        @type issueInstant: datetime.datetime/NoneType 
     1849        @raise TypeError: incorrect type for input value 
    16071850        ''' 
    16081851        if not isinstance(issueInstant, datetime): 
     
    16171860 
    16181861    def _get_id(self): 
    1619         '''Sets the ID of this assertion. 
     1862        '''Get the ID of this assertion 
    16201863         
    16211864        @return: the ID of this assertion 
     1865        @rtype: basestring/NoneType 
    16221866        ''' 
    16231867        return self.__id 
    16241868     
    16251869    def _set_id(self, _id): 
    1626         '''Sets the ID of this assertion. 
     1870        '''Set the ID of this assertion 
    16271871         
    16281872        @param _id: the ID of this assertion 
     1873        @type _id: basestring 
     1874        @raise TypeError: incorrect type for input value 
    16291875        ''' 
    16301876        if not isinstance(_id, basestring): 
     
    16361882     
    16371883    def _set_issuer(self, issuer): 
    1638         """Set issuer""" 
     1884        """Set issuer 
     1885        @param issuer: issuer of the assertion 
     1886        @type issuer: ndg.saml.saml2.core.Issuer 
     1887        @raise TypeError: incorrect type for input value 
     1888        """ 
    16391889        if not isinstance(issuer, Issuer): 
    16401890            raise TypeError("issuer must be %r, got %r" % (Issuer,  
     
    16431893     
    16441894    def _get_issuer(self): 
    1645         """Get the issuer name """ 
     1895        """Get the issuer name  
     1896        @return: issuer name 
     1897        @rtype: ndg.saml.saml2.core.Issuer 
     1898        """ 
    16461899        return self.__issuer 
    16471900 
     
    16511904     
    16521905    def _set_subject(self, subject): 
    1653         """Set subject string.""" 
     1906        """Set subject string 
     1907        @param subject: subject of this assertion 
     1908        @type subject: ndg.saml.saml2.core.Subject 
     1909        @raise TypeError: incorrect type for input value""" 
    16541910        if not isinstance(subject, Subject): 
    16551911            raise TypeError("subject must be %r, got %r" % (Subject,  
     
    16591915     
    16601916    def _get_subject(self): 
    1661         """Get subject string.""" 
     1917        """Get subject string 
     1918         
     1919        @return: subject of this assertion 
     1920        @rtype subject: ndg.saml.saml2.core.Subject 
     1921        """ 
    16621922        return self.__subject 
    16631923 
     
    16671927     
    16681928    def _get_conditions(self): 
    1669         """Get conditions string.""" 
     1929        """Get conditions  
     1930        @return: conditions for this assertion 
     1931        @rtype: ndg.saml.saml2.core.Conditions 
     1932        """ 
    16701933        return self.__conditions 
    16711934     
    16721935    def _set_conditions(self, value): 
    1673         """Get conditions string.""" 
     1936        """Set conditions  
     1937        @param value: conditions for this assertion 
     1938        @type value: ndg.saml.saml2.core.Conditions 
     1939        @raise TypeError: incorrect type for input value""" 
    16741940        if not isinstance(value, Conditions): 
    16751941            raise TypeError("Conditions must be %r, got %r" % (Conditions,  
     
    16831949     
    16841950    def _set_advice(self, advice): 
    1685         """Set advice string.""" 
     1951        """Set advice string 
     1952         
     1953        @param advice: advice for this assertion 
     1954        @type advice: basestring 
     1955        @raise TypeError: incorrect type for input value""" 
    16861956        if not isinstance(advice, basestring): 
    16871957            raise TypeError("advice must be a string") 
     
    16901960     
    16911961    def _get_advice(self): 
    1692         """Get advice string.""" 
     1962        """Get advice string 
     1963         
     1964        @return: advice for this assertion 
     1965        @rtype: basestring 
     1966        """ 
    16931967        return self.__advice 
    16941968 
     
    16991973    @property 
    17001974    def statements(self): 
    1701         """Attribute Assertion statements""" 
     1975        """Assertion statements 
     1976         
     1977        @return: list of assertion statements 
     1978        @rtype: ndg.saml.utils.TypedList 
     1979        """ 
    17021980        return self.__statements 
    17031981     
    17041982    @property 
    17051983    def authnStatements(self): 
    1706         """Attribute Assertion authentication""" 
     1984        """Attribute Assertion authentication 
     1985         
     1986        @return: list of assertion statements 
     1987        @rtype: ndg.saml.utils.TypedList 
     1988        """ 
    17071989        return self.__authnStatements 
    17081990     
    17091991    @property 
    17101992    def authzDecisionStatements(self): 
    1711         """Attribute Assertion authorisation decision statements""" 
     1993        """Attribute Assertion authorisation decision statements 
     1994         
     1995        @return: list of assertion statements 
     1996        @rtype: ndg.saml.utils.TypedList 
     1997        """ 
    17121998        return self.__authzDecisionStatements 
    17131999     
    17142000    @property 
    17152001    def attributeStatements(self): 
    1716         """Attribute Assertion attribute statements""" 
     2002        """Attribute Assertion attribute statements 
     2003         
     2004        @return: list of assertion statements 
     2005        @rtype: ndg.saml.utils.TypedList 
     2006        """ 
    17172007        return self.__attributeStatements 
    17182008     
    17192009 
    17202010class AttributeValue(SAMLObject): 
    1721     """Base class for Attribute Value type""" 
     2011    """Base class for Attribute Value type 
     2012     
     2013    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element name, no namespace 
     2014    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     2015    @cvar DEFAULT_ELEMENT_NAME: Default element name 
     2016    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName     
     2017    """ 
    17222018     
    17232019    # Element name, no namespace 
     
    17322028 
    17332029class XSStringAttributeValue(AttributeValue): 
    1734     """XML XS:String Attribute Value type""" 
     2030    """XML XS:String Attribute Value type 
     2031     
     2032    @cvar TYPE_LOCAL_NAME: Local name of the XSI type 
     2033    @type TYPE_LOCAL_NAME: string 
     2034    @cvar TYPE_NAME: QName of the XSI type 
     2035    @type TYPE_NAME: ndg.saml.common.xml.QName 
     2036     
     2037    @ivar __value: value of this attribute 
     2038    @type __value: basestring 
     2039    """ 
    17352040     
    17362041    # Local name of the XSI type 
     
    17472052     
    17482053    def __init__(self, **kw): 
     2054        """ 
     2055        @param **kw: keywords for setting attributes of parent class 
     2056        @type **kw: dict 
     2057        """ 
    17492058        super(XSStringAttributeValue, self).__init__(**kw) 
    17502059        self.__value = None 
     
    17562065        @rtype: dict 
    17572066        ''' 
    1758  
    17592067        _dict = super(XSStringAttributeValue, self).__getstate__() 
    17602068        for attrName in XSStringAttributeValue.__slots__: 
     
    17692077             
    17702078    def _getValue(self): 
     2079        """Set value of XS string 
     2080        @return: value of string to assign 
     2081        @rtype: string 
     2082        """ 
    17712083        return self.__value 
    17722084         
    17732085    def _setValue(self, value): 
     2086        """Set value of XS string 
     2087        @param: value 
     2088        @type: string 
     2089        @raise TypeError: invalid input value type 
     2090        """ 
    17742091        if not isinstance(value, basestring): 
    17752092            raise TypeError("Input must be a basestring derived type, got %r" % 
     
    17822099 
    17832100class StatusDetail(SAMLObject): 
    1784     '''Implementation of SAML 2.0 StatusDetail''' 
     2101    '''Implementation of SAML 2.0 StatusDetail 
     2102     
     2103    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Local Name of StatusDetail. 
     2104    @type DEFAULT_ELEMENT_LOCAL_NAME: string 
     2105    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     2106    @type DEFAULT_ELEMENT_NAME: string 
     2107    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     2108    @type TYPE_LOCAL_NAME: string 
     2109    @cvar TYPE_NAME: QName of the XSI type. 
     2110    @type TYPE_NAME: string 
     2111     
     2112    @ivar __unknownChildren: unknown child elements 
     2113    @type __unknownChildren: ndg.saml.common.SAMLObject 
     2114     
     2115    ''' 
    17852116     
    17862117    # Local Name of StatusDetail. 
     
    18032134     
    18042135    def __init__(self, **kw): 
     2136        """ 
     2137        @param **kw: keywords for setting attributes of parent class 
     2138        @type **kw: dict 
     2139        """ 
    18052140        super(StatusDetail, self).__init__(**kw) 
    18062141         
     
    18262161        return _dict 
    18272162     
    1828     def getUnknownXMLTypes(self, qname=None):  
     2163    def getUnknownXMLTypes(self, qname=None): 
     2164        """Retrieve unknown child attributes 
     2165         
     2166        This is untested 
     2167        @param qname: qualified name for matching types to be retrieved 
     2168        @type qname: ndg.saml.common.xml.QName 
     2169        @raise TypeError: incorrect type for qname keyword 
     2170        """  
    18292171        if qname is not None: 
    18302172            if not isinstance(qname, QName): 
Note: See TracChangeset for help on using the changeset viewer.