Changeset 2911


Ignore:
Timestamp:
28/09/07 15:45:24 (12 years ago)
Author:
pjkersha
Message:

ndg.security.common.AttCert?: more fixes to epydoc mark-up

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/python/ndg.security.common/ndg/security/common/AttCert.py

    r2910 r2911  
    172172         
    173173        @param **kw: keywords to XMLSec.XMLSecDoc.toString() 
    174         @rtype string 
    175         @return content of document""" 
     174        @rtype: string 
     175        @return: content of document""" 
    176176 
    177177        # If doc hasn't been parsed by parent (ie. not signed) return elements 
     
    424424    #_________________________________________________________________________     
    425425    def __getIssuerName(self): 
    426         """@return the name of the issuer""" 
     426        """@rtype: string 
     427        @return: the name of the issuer""" 
    427428        return self.__dat['issuerName'] 
    428429 
     
    441442    #_________________________________________________________________________     
    442443    def __getIssuerSerialNumber(self): 
    443         """@return the issuer serial number""" 
     444        """@rtype: string 
     445        @return: the issuer serial number""" 
    444446        return self.__dat['issuerSerialNumber'] 
    445447     
     
    480482        Nb. time may not have been set - if so it will be set to None 
    481483         
    482         @return the not before time as string or datetime type - see above""" 
     484        @rtype: string/datetime 
     485        @return: the not before time""" 
    483486        if asDatetime is True: 
    484487            return self.__dtNotBefore 
     
    497500        Nb. time may not have been set - if so it will be set to None 
    498501         
    499         @return the not after time as string or datetime type - see above""" 
     502        @rtype: string/datetime 
     503        @return: the not after time""" 
    500504        if asDatetime is True: 
    501505            return self.__dtNotAfter 
     
    510514    def __getRoleSet(self): 
    511515        """@rtype: list of dict type 
    512         @return the roleSet as a list of role dictionaries.""" 
     516        @return: the roleSet as a list of role dictionaries.""" 
    513517        return self.__dat['attributes']['roleSet'] 
    514518 
     
    520524        """Return roles as a list 
    521525         
    522         @return list of roles contained in the certificate""" 
     526        @rtype: list 
     527        @return: list of roles contained in the certificate""" 
    523528         
    524529        try: 
     
    549554        """Get the provenance for the certificate. 
    550555         
    551         @return provenance of certificate mapped or original""" 
     556        @rtype: string 
     557        @return: provenance of certificate mapped or original""" 
    552558        return self.__dat['provenance'] 
    553559 
     
    567573        checked i.e. self.__dat['provenance'].  Set this keyword to override 
    568574        and check against an alternate provenance setting. 
    569         @return True if certificate has a valid provenance setting 
     575         
     576        @rtype: bool 
     577        @return: True if certificate has a valid provenance setting 
    570578        """ 
    571579         
     
    579587    def isOriginal(self): 
    580588        """Check for original provenance. 
    581         @return True if certificate has original roles""" 
     589        @rtype: bool 
     590        @return: True if certificate has original roles""" 
    582591        return self.__dat['provenance'] == self.__class__.origProvenance 
    583592 
     
    586595    def isMapped(self): 
    587596        """Check for mapped provenance. 
    588         @return True if certificate contain roles mapped from another""" 
     597        @rtype: bool 
     598        @return: True if certificate contain roles mapped from another""" 
    589599        return self.__dat['provenance'] == self.__class__.mappedProvenance 
    590600 
     
    611621        @param rtnRootElem: boolean set to True to return the ElementTree 
    612622        root element 
    613         @return root element if rtnRootElem keyword is set to True""" 
     623         
     624        @rtype: ElementTree root element 
     625        @return: root element if rtnRootElem keyword is set to True""" 
    614626         
    615627        rootElem = ElementTree.XML(xmlTxt) 
     
    759771        str() 
    760772 
    761         @return xmlTxt: formatted XML for certificate as a string""" 
     773        @rtype: string 
     774        @return: formatted XML for certificate as a string""" 
    762775 
    763776        # Nb. 
     
    908921         
    909922        @param dtVal: input datetime 
    910         @return datetime converted into correct string format for AttCert""" 
     923         
     924        @rtype: string 
     925        @return: datetime converted into correct string format for AttCert""" 
    911926 
    912927        if not isinstance(dtVal, datetime): 
     
    932947         
    933948        @param sTime: time in string format as used by AttCert 
    934         @return datetime type equivalent of string input""" 
     949        @rtype: datetime 
     950        @return: datetime type equivalent of string input""" 
    935951 
    936952        try: 
     
    958974        raised if the time is invalid, instead False is returned 
    959975         
    960         @return boolean True if time is valid, False if invalid.  Also see 
     976        @rtype: bool 
     977        @return: boolean True if time is valid, False if invalid.  Also see 
    961978        raiseExcep keyword above.""" 
    962979 
     
    10001017        """Check Attribute Certificate XML file version 
    10011018         
    1002         @return boolean True if certificate version matches the expected one, 
     1019        @rtype: bool 
     1020        @return: boolean True if certificate version matches the expected one, 
    10031021        False otherwise. 
    10041022        """ 
     
    10411059        XMLSecDoc.verifyEnvelopedSignature(). 
    10421060         
    1043         @return boolean True if certificate is valid, False otherwise.  Also 
     1061        @rtype: bool 
     1062        @return: boolean True if certificate is valid, False otherwise.  Also 
    10441063        see explanation for raiseExcep keyword.                          
    10451064        """ 
Note: See TracChangeset for help on using the changeset viewer.