Changeset 7109 for TI12-security/trunk


Ignore:
Timestamp:
28/06/10 13:54:57 (9 years ago)
Author:
pjkersha
Message:

Incomplete - task 2: XACML-Security Integration

  • updating epydoc ready for release.
Location:
TI12-security/trunk/ndg_xacml/ndg/xacml
Files:
2 added
1 deleted
35 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/apply.py

    r7100 r7109  
    155155        '''functionMap object for PDP to retrieve functions from given XACML 
    156156        function URNs 
    157         @ivar value: function mapping object to map URNs to function  
     157        @param value: function mapping object to map URNs to function  
    158158        class implementations 
    159159        @type value: ndg.xacml.core.functions.FunctionMap 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/attribute.py

    r7101 r7109  
    6666        """Set attribute values 
    6767         
    68         @ivar value: list of attribute values  
     68        @param value: list of attribute values  
    6969        @type value: ndg.xacml.utils.TypedList 
    7070        @raise TypeError: incorrect input type 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/attributedesignator.py

    r7101 r7109  
    356356                                         self.issuer))  
    357357                         
    358         return attributeValueBag  
     358        return attributeValueBag 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/attributevalue.py

    r7101 r7109  
    127127    def _get_value(self): 
    128128        """Get value 
    129         @param: setting for this attribute value 
     129        @return: setting for this attribute value 
    130130        @rtype: any - constrained in derived classes 
    131131        """ 
     
    226226    AttributeValueClassMap 
    227227     
    228     @param __classMap: mapping object to map attribute value URIs to their  
     228    @ivar __classMap: mapping object to map attribute value URIs to their  
    229229    implementations as classes 
    230230    @type __classMap: ndg.xacml.core.attributevalue.AttributeValueClassMap 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/context/pdp.py

    r7087 r7109  
    6464        @param value: policy object for PDP to use to apply access control  
    6565        decisions 
    66         @type policy: ndg.xacml.core.policy.Policy 
     66        @type value: ndg.xacml.core.policy.Policy 
    6767        ''' 
    6868        if not isinstance(value, Policy): 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/context/request.py

    r7087 r7109  
    142142                            '%r' % (CtxHandlerInterface, type(value))) 
    143143             
    144         self.__ctxHandler = value  
     144        self.__ctxHandler = value 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/functions/__init__.py

    r7088 r7109  
    646646        @param key: XACML function URN 
    647647        @type key: basestring 
    648         @param *arg: set a single additional argument if required which is  
     648        @param arg: set a single additional argument if required which is  
    649649        used as the default value should the key not be found in the map 
    650         @type *arg: tuple 
     650        @type arg: tuple 
    651651        @return: function class 
    652652        @rtype: ndg.xacml.core.functions.AbstractFunction / NotImplemented 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/functions/v1/bag.py

    r7087 r7109  
    3636        """return inputs into a bag 
    3737         
    38         @param *args: inputs to add to bag 
     38        @param args: inputs to add to bag 
    3939        @type args: tuple 
    40         @param string2: second string 
    41         @type string2: basestring 
    4240        @return: True if strings match, False otherwise 
    4341        @rtype: bool 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/core/policy.py

    r7108 r7109  
    4141 
    4242class Policy(XacmlCoreBase): 
    43     """NDG MSI Policy. 
     43    """XACML Policy 
    4444     
    4545    @cvar DEFAULT_XACML_VERSION: default is 2.0 
     
    8585    @ivar __ruleCombiningAlg: rule combining algorithm 
    8686    @type __ruleCombiningAlg: NoneType / ndg.xacml.core.rule_combining_alg.RuleCombiningAlgInterface 
    87  
    8887    """  
    8988    DEFAULT_XACML_VERSION = "2.0" 
     
    209208        ''' 
    210209        @return: policy id 
    211         @type basestring: NoneType / basestring 
     210        @rtype: NoneType / basestring 
    212211        ''' 
    213212        return self.__policyId 
     
    328327    @property 
    329328    def obligations(self): 
    330         """@ivar __obligations: obligations 
    331         @type __obligations: ndg.xacml.utils.TypedList 
     329        """@return: obligations 
     330        @rtype: ndg.xacml.utils.TypedList 
    332331        """ 
    333332        return self.__obligations  
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/__init__.py

    r7087 r7109  
    5454     
    5555    def _getPrefix(self): 
     56        """Get prefix 
     57        @return: prefix 
     58        @rtype: string 
     59        """ 
    5660        return self.__prefix 
    5761 
    5862    def _setPrefix(self, value): 
     63        """Set prefix 
     64        @param value: prefix 
     65        @type value: string 
     66        @raise TypeError: invalid input value type 
     67        """ 
    5968        self.__prefix = value 
    6069     
     
    6271 
    6372    def _getLocalPart(self): 
     73        """Get local part 
     74        @return: local part 
     75        @rtype: string 
     76        """ 
    6477        return self.__localPart 
    6578     
    6679    def _setLocalPart(self, value): 
     80        """Set local part 
     81        @param value: local part 
     82        @type value: string 
     83        @raise TypeError: invalid input value type 
     84        """ 
    6785        self.__localPart = value 
    6886         
     
    7088 
    7189    def _getNamespaceURI(self): 
     90        """Get namespace URI 
     91        @return: namespace URI 
     92        @rtype: string 
     93        """ 
    7294        return self.__namespaceURI 
    7395 
    7496    def _setNamespaceURI(self, value): 
     97        """Set namespace URI 
     98        @param value: namespace URI 
     99        @type value: string 
     100        @raise TypeError: invalid input value type 
     101        """ 
    75102        self.__namespaceURI = value 
    76103   
     
    84111        @type qname: ndg.xacml.utils.etree.QName 
    85112        @param qname: Qualified Name to compare with self  
     113        @return: True if input and this object match 
     114        @rtype: bool 
    86115        """ 
    87116        if not isinstance(qname, QName): 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/actionattributedesignatorreader.py

    r7087 r7109  
    1717class ActionAttributeDesignatorReader(AttributeDesignatorReaderBase):  
    1818    '''ElementTree based XACML Action Attribute Designator type parser 
     19     
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: abc.ABCMeta 
    1922    ''' 
    2023    TYPE = ActionAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/actionmatchreader.py

    r7087 r7109  
    1616 
    1717class ActionMatchReader(MatchReaderBase): 
    18     """ElementTree based parser for XACML ActionMatch""" 
     18    """ElementTree based parser for XACML ActionMatch 
     19         
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: type 
     22     
     23    @cvar ATTRIBUTE_DESIGNATOR_TYPE: type of attribute designator that this  
     24    match type holds 
     25    @type ATTRIBUTE_DESIGNATOR_TYPE: abc.ABCMeta 
     26    """ 
    1927    TYPE = ActionMatch 
    2028    ATTRIBUTE_DESIGNATOR_TYPE = ActionAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/actionreader.py

    r7087 r7109  
    1717    '''ElementTree based parser for Action type 
    1818    @cvar TYPE: XACML type to instantiate from parsed object 
    19     @type string: type 
     19    @type TYPE: type 
    2020    ''' 
    21     TYPE = Action     
     21    TYPE = Action 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/applyreader.py

    r7087 r7109  
    3131    '''ElementTree based XACML Apply type parser 
    3232     
    33     @cvar TYPE: XACML type to instantiate from parsed object 
    34     @type string: type 
     33    @cvar FUNCTION_ELEMENT_LOCAL_NAME: XML local name for function element 
     34    @type FUNCTION_ELEMENT_LOCAL_NAME: string 
     35     
     36    @cvar VARIABLE_REFERENCE_ELEMENT_LOCAL_NAME: XML local name for variable 
     37    reference element 
     38    @type VARIABLE_REFERENCE_ELEMENT_LOCAL_NAME: string 
     39     
     40    @cvar TYPE: XACML class type that this reader will read values into 
     41    @type TYPE: abc.ABCMeta 
    3542    ''' 
    3643    TYPE = Apply 
     
    4350     
    4451    def __call__(self, obj): 
    45         """Parse Apply type object""" 
     52        """Parse Apply type object 
     53 
     54        @param obj: input object to parse 
     55        @type obj: ElementTree Element, or stream object 
     56        @return: ElementTree element 
     57        @rtype: xml.etree.Element 
     58        """ 
    4659        elem = super(ApplyReader, self)._parse(obj) 
    4760         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributedesignatorreader.py

    r7087 r7109  
    2020    ''' 
    2121    def _parseExtension(self, elem, attributeDesignator): 
    22         """Parse AttributeDesignator object""" 
     22        """Parse Attribute Designator element 
     23         
     24        @param elem: ElementTree XML element 
     25        @type elem: xml.etree.Element 
     26         
     27        @param attributeDesignator: attribute designator 
     28        @type attributeDesignator: ndg.xacml.core.attributedesignator.AttributeDesignator 
     29         
     30        @raise XMLParseError: error parsing attribute ID XML attribute 
     31         
     32        @return: updated attribute designator 
     33        @rtype: ndg.xacml.core.attributedesignator.AttributeDesignator 
     34        """ 
    2335        xacmlType = self.__class__.TYPE 
    2436         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributeselectorreader.py

    r7087 r7109  
    1010__contact__ = "Philip.Kershaw@stfc.ac.uk" 
    1111__revision__ = "$Id$" 
     12from ndg.xacml.utils import str2Bool 
    1213from ndg.xacml.core.attributeselector import AttributeSelector 
    1314from ndg.xacml.parsers import XMLParseError 
     
    1718 
    1819class AttributeSelectorReader(ExpressionReader): 
    19     '''ElementTree based parser for XACML Attribute Selector type''' 
     20    '''ElementTree based parser for XACML Attribute Selector type 
     21     
     22    @cvar TYPE: XACML class type that this reader will read values into 
     23    @type TYPE: abc.ABCMeta 
     24    ''' 
    2025    TYPE = AttributeSelector 
    2126     
    2227    def _parseExtension(self, elem, attributeSelector): 
     28        """Parse XML Attribute Selector element 
     29         
     30        @param elem: ElementTree XML element 
     31        @type elem: xml.etree.Element 
     32         
     33        @param attributeSelector: attribute selector to be updated with parsed 
     34        values 
     35        @type attributeSelector: ndg.xacml.core.attributeSelector.AttributeSelector 
     36         
     37        @raise XMLParseError: error parsing attribute ID XML attribute 
     38         
     39        @return: updated attribute selector 
     40        @rtype: ndg.xacml.core.attributeSelector.AttributeSelector 
     41        """ 
    2342         
    2443        xacmlType = self.__class__.TYPE 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributevaluereader.py

    r7087 r7109  
    1919class AttributeValueReader(ExpressionReader): 
    2020    '''ElementTree based XACML Expression type parser 
     21     
     22    @cvar TYPE: XACML class type that this reader will read values into 
     23    @type TYPE: abc.ABCMeta 
     24     
     25    @cvar FACTORY: factory function for returning an Attribute value type for a  
     26    given XACML Attribute value URI 
     27    @type FACTORY: ndg.xacml.core.attributevalue.AttributeValueClassFactory 
    2128    ''' 
    2229    TYPE = AttributeValue 
     
    2734        _parseExtension since AttributeValue class is virtual.  A sub-type can 
    2835        be instantiated only once the data type attribute is parsed 
     36         
     37        @param obj: input object to parse 
     38        @type obj: ElementTree Element, or stream object 
     39        @return: new XACML attribute value instance 
     40        @rtype: ndg.xacml.core.attributevalue.AttributeValue derived type  
     41        @raise XMLParseError: error reading element        
    2942        """ 
    3043        elem = super(AttributeValueReader, self)._parse(obj) 
     
    5568     
    5669    def _parseExtension(self, elem, attributeValue): 
     70        """Parse XML Attribute value element 
     71         
     72        @param elem: ElementTree XML element 
     73        @type elem: xml.etree.Element 
     74         
     75        @param attributeValue: attribute selector to be updated with parsed 
     76        values 
     77        @type attributeValue: ndg.xacml.core.attributevalue.AttributeValue 
     78         
     79        @raise XMLParseError: error parsing attribute ID XML attribute 
     80        """ 
    5781        if elem.text is None: 
    5882            raise XMLParseError('No attribute value element found parsing %r' %  
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/conditionreader.py

    r7087 r7109  
    2323     
    2424    @cvar TYPE: XACML type to instantiate from parsed object 
    25     @type string: type 
     25    @type TYPE: type 
    2626    ''' 
    2727    TYPE = Condition 
    2828     
    2929    def __call__(self, obj): 
    30         """Parse policy object""" 
     30        """Parse condition object 
     31         
     32        @param obj: input object to parse 
     33        @type obj: ElementTree Element, or stream object 
     34        @return: new XACML condition instance 
     35        @rtype: ndg.xacml.core.condition.Condition 
     36        @raise XMLParseError: error reading sub-elements 
     37        """ 
    3138        elem = super(ConditionReader, self)._parse(obj) 
    3239         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/environmentreader.py

    r7087 r7109  
    1717    '''ElementTree based XACML Rule parser 
    1818    @cvar TYPE: XACML type to instantiate from parsed object 
    19     @type string: type 
     19    @type TYPE: type 
    2020    ''' 
    21     TYPE = Environment         
     21    TYPE = Environment 
     22  
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/expressionreader.py

    r7087 r7109  
    2020class ExpressionReader(ETreeAbstractReader): 
    2121    '''ElementTree based XACML Expression type parser 
     22     
     23    @cvar TYPE: XACML type to instantiate from parsed object 
     24    @type TYPE: abc.ABCMeta 
    2225    ''' 
    2326    TYPE = Expression 
    2427     
    2528    def __call__(self, obj): 
    26         """Parse AttributeValue object""" 
     29        """Parse Expression object 
     30         
     31        @param obj: input object to parse 
     32        @type obj: ElementTree Element, or stream object 
     33        @return: new XACML expression instance 
     34        @rtype: ndg.xacml.core.expression.Expression derived type  
     35        @raise XMLParseError: error reading element                
     36        """ 
    2737        elem = super(ExpressionReader, self)._parse(obj) 
    2838         
     
    5565    def _parseExtension(self, elem, expression): 
    5666        """Derived classes should implement this method to read any remaining 
    57         attributes and elements specific to their type""" 
     67        attributes and elements specific to their type 
     68         
     69        @param elem: ElementTree XML element 
     70        @type elem: xml.etree.Element 
     71         
     72        @param expression: attribute selector to be updated with parsed 
     73        values 
     74        @type expression: ndg.xacml.core.attributevalue.AttributeValue 
     75         
     76         
     77        @raise NotImplementedError: Derived classes should implement 
     78        """ 
    5879        raise NotImplementedError() 
    5980           
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/matchreader.py

    r7087 r7109  
    2222    '''ElementTree based XACML generic Match parser for subject, resource,  
    2323    action and environment match types 
     24     
     25    @cvar ATTRIBUTE_DESIGNATOR_TYPE: type for attribute designator sub-elements: 
     26    derived class should set to relevant type e.g. for SubjectMatch, 
     27    SubjectAttributeDesignator 
     28    @type ATTRIBUTE_DESIGNATOR_TYPE: NoneType 
    2429    ''' 
    2530    ATTRIBUTE_DESIGNATOR_TYPE = None 
    2631     
    2732    def __init__(self): 
     33        """Virtual method 
     34         
     35        @raise NotImplementedError: ATTRIBUTE_DESIGNATOR_TYPE must be set in a  
     36        derived class 
     37        """ 
    2838        if self.__class__.ATTRIBUTE_DESIGNATOR_TYPE is None: 
    2939            raise NotImplementedError('Extend this class setting the ' 
    30                                       '"ATTRIBUTE_DESIGNATOR_TYPE" ' 
    31                                       'class variable') 
     40                                      '"ATTRIBUTE_DESIGNATOR_TYPE" class ' 
     41                                      'variable') 
    3242             
    3343        super(MatchReaderBase, self).__init__() 
    3444         
    3545    def __call__(self, obj): 
    36         """Parse subject object""" 
     46        """Parse *Match object (where * = Subject, Resource, Environment or 
     47        Action 
     48         
     49        @param obj: input object to parse 
     50        @type obj: ElementTree Element, or stream object 
     51        @return: new XACML match instance 
     52        @rtype: ndg.xacml.core.matchreader.MatchReaderBase derived type  
     53        @raise XMLParseError: error reading element                  
     54        """ 
    3755        elem = super(MatchReaderBase, self)._parse(obj) 
    3856         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/policydefaultsreader.py

    r7087 r7109  
    1818class PolicyDefaultsReader(ETreeAbstractReader): 
    1919    '''ElementTree based XACML PolicyDefaults type parser 
     20     
     21    @cvar TYPE: XACML class type that this reader will read values into 
     22    @type TYPE: type 
    2023    ''' 
    2124    TYPE = PolicyDefaults 
    2225     
    2326    def __call__(self, obj): 
    24         """Parse AttributeValue object""" 
     27        """Parse Policy defaults object 
     28         
     29        @param obj: input object to parse 
     30        @type obj: ElementTree Element, or stream object 
     31        @return: new XACML expression instance 
     32        @rtype: ndg.xacml.core.policydefaults.PolicyDefaults derived type  
     33        @raise XMLParseError: error reading element                
     34        """ 
    2535        elem = super(PolicyDefaultsReader, self)._parse(obj) 
    2636         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/policyreader.py

    r7087 r7109  
    2424    """Parse a Policy Document using ElementTree 
    2525    @cvar TYPE: XACML type to instantiate from parsed object 
    26     @type string: type""" 
     26    @type TYPE: type""" 
    2727    TYPE = Policy 
    2828     
    2929    def __call__(self, obj): 
    30         """Parse policy object""" 
     30        """Parse policy object 
     31         
     32        @param obj: input object to parse 
     33        @type obj: ElementTree Element, or stream object 
     34        @return: new XACML expression instance 
     35        @rtype: ndg.xacml.core.policy.Policy derived type  
     36        @raise XMLParseError: error reading element   
     37        @raise NotImplementedError: parsing is not implemented for rule 
     38        combiner, combiner parameters and obligations elements.          
     39        """ 
    3140        elem = super(PolicyReader, self)._parse(obj) 
    3241         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/reader.py

    r7087 r7109  
    2323     
    2424    @cvar TYPE: XACML type to instantiate from parsed object 
    25     @type string: type""" 
     25    @type TYPE: NoneType""" 
    2626    TYPE = None 
    2727     
    2828    def __init__(self): 
     29        """Initialise ElementTree namespace map for XACML 2.0 namespaces 
     30         
     31        @raise NotImplementedError: TYPE class variable must be set in a  
     32        derived class 
     33        """ 
    2934        if self.__class__.TYPE is None: 
    3035            raise NotImplementedError('No "TYPE" class variable set to specify ' 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/resourceattributedesignatorreader.py

    r7087 r7109  
    1717class ResourceAttributeDesignatorReader(AttributeDesignatorReaderBase):  
    1818    '''ElementTree based XACML Resource Attribute Designator type parser 
     19     
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: abc.ABCMeta 
    1922    ''' 
    2023    TYPE = ResourceAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/resourcematchreader.py

    r7087 r7109  
    1616 
    1717class ResourceMatchReader(MatchReaderBase): 
    18     """ElementTree based parser for XACML ResourceMatch""" 
     18    """ElementTree based parser for XACML ResourceMatch 
     19     
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: abc.ABCMeta 
     22     
     23    @cvar ATTRIBUTE_DESIGNATOR_TYPE: type for attribute designator sub-elements 
     24    @type ATTRIBUTE_DESIGNATOR_TYPE: abc.ABCMeta 
     25    """ 
    1926    TYPE = ResourceMatch 
    2027    ATTRIBUTE_DESIGNATOR_TYPE = ResourceAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/resourcereader.py

    r7087 r7109  
    1717    '''ElementTree based XACML Rule parser 
    1818    @cvar TYPE: XACML type to instantiate from parsed object 
    19     @type string: type 
     19    @type TYPE: type 
    2020    ''' 
    2121    TYPE = Resource 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/rulereader.py

    r7087 r7109  
    2323     
    2424    @cvar TYPE: XACML type to instantiate from parsed object 
    25     @type string: type 
     25    @type TYPE: type 
    2626    ''' 
    2727    TYPE = Rule 
    2828     
    2929    def __call__(self, obj): 
    30         """Parse rule object""" 
     30        """Parse rule object 
     31         
     32        @param obj: input object to parse 
     33        @type obj: ElementTree Element, or stream object 
     34        @return: new XACML expression instance 
     35        @rtype: ndg.xacml.core.rule.Rule derived type  
     36        @raise XMLParseError: error reading element                
     37        """ 
    3138        elem = super(RuleReader, self)._parse(obj) 
    3239         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/subjectattributedesignatorreader.py

    r7087 r7109  
    1717class SubjectAttributeDesignatorReader(AttributeDesignatorReaderBase):  
    1818    '''ElementTree based XACML Subject Attribute Designator type parser 
     19     
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: abc.ABCMeta 
    1922    ''' 
    2023    TYPE = SubjectAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/subjectmatchreader.py

    r7087 r7109  
    1616 
    1717class SubjectMatchReader(MatchReaderBase): 
    18     """ElementTree based parser for XACML SubjectMatch""" 
     18    """ElementTree based parser for XACML SubjectMatch 
     19     
     20    @cvar TYPE: XACML class type that this reader will read values into 
     21    @type TYPE: abc.ABCMeta 
     22     
     23    @cvar ATTRIBUTE_DESIGNATOR_TYPE: type for attribute designator sub-elements 
     24    @type ATTRIBUTE_DESIGNATOR_TYPE: abc.ABCMeta 
     25    """ 
    1926    TYPE = SubjectMatch 
    2027    ATTRIBUTE_DESIGNATOR_TYPE = SubjectAttributeDesignator 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/subjectreader.py

    r7087 r7109  
    1717    '''ElementTree based XACML Rule parser 
    1818    @cvar TYPE: XACML type to instantiate from parsed object 
    19     @type string: type 
     19    @type TYPE: type 
    2020    ''' 
    2121    TYPE = Subject 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/targetchildreader.py

    r7087 r7109  
    1111__contact__ = "Philip.Kershaw@stfc.ac.uk" 
    1212__revision__ = "$Id$" 
    13 from ndg.xacml.core.subject import Subject 
    1413from ndg.xacml.parsers import XMLParseError 
    1514from ndg.xacml.parsers.etree import QName 
     
    2120    '''ElementTree based XACML generic target child element parser 
    2221    @cvar TYPE: XACML type to instantiate from parsed object 
    23     @type string: type 
     22    @type TYPE: type 
    2423    ''' 
    2524 
    2625    def __call__(self, obj): 
    27         """Parse subject object""" 
     26        """Parse target child element object 
     27         
     28        @param obj: input object to parse 
     29        @type obj: ElementTree Element, or stream object 
     30        @return: new XACML expression instance 
     31        @rtype: ndg.xacml.core.TargetChildBase derived type  
     32        @raise XMLParseError: error reading element                
     33        """ 
    2834        elem = super(TargetChildReader, self)._parse(obj) 
    2935         
  • TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/targetreader.py

    r7087 r7109  
    2525     
    2626    @cvar TYPE: XACML type to instantiate from parsed object 
    27     @type string: type""" 
     27    @type TYPE: type 
     28    """ 
    2829    TYPE = Target 
    2930     
    3031    def __call__(self, obj): 
     32        """Parse Target object 
     33         
     34        @param obj: input object to parse 
     35        @type obj: ElementTree Element, or stream object 
     36        @return: new XACML expression instance 
     37        @rtype: ndg.xacml.core.target.Target derived type  
     38        @raise XMLParseError: error reading element                
     39        """ 
    3140        elem = super(TargetReader, self)._parse(obj) 
    3241         
     
    6776                                    "recognised" % localName) 
    6877                 
    69         return target  
     78        return target 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/test/test_context.py

    r7087 r7109  
    4545        @param pepRequest: request from PEP, derived class determines its type 
    4646        e.g. SAML AuthzDecisionQuery 
    47         @type pepRequest: type 
     47        @type myRequest: type 
    4848        @return: PEP response - derived class determines type 
    4949        @rtype: None 
  • TI12-security/trunk/ndg_xacml/ndg/xacml/utils/__init__.py

    r7087 r7109  
    1919    from the list 
    2020    """ 
     21     
    2122    def extend(self, iter): 
     23        """Extend a list with input iterable 
     24        @param iter: iterable object 
     25        @type iter: iterable type 
     26        """ 
    2227        return super(UniqList, self).extend([i for i in iter if i not in self]) 
    2328         
    2429    def __iadd__(self, iter): 
     30        """Extend a list with input iterable 
     31        @param iter: iterable object 
     32        @type iter: iterable type 
     33        """ 
    2534        return super(UniqList, self).__iadd__([i for i in iter  
    2635                                               if i not in self]) 
    2736          
    2837    def append(self, item): 
     38        """Add an item to the list 
     39        @param item: item to append to list 
     40        @type item: any 
     41        """ 
    2942        for i in self: 
    3043            if i == item: 
     
    5063 
    5164    def __repr__(self): 
     65        """@return: represent instance giving type information about the  
     66        elements 
     67        @rtype: string 
     68        """ 
    5269        return "%r type: %s" % (self.__elementType,  
    5370                                super(TypedList, self).__repr__()) 
    5471         
    5572    def _getElementType(self): 
     73        """@return: the element type for this list 
     74        @rtype: type 
     75        """ 
    5676        return self.__elementType 
    5777     
     
    6080      
    6181    def extend(self, iter): 
     82        """Extend a list with input iterable 
     83        @param iter: iterable object 
     84        @type iter: iterable type 
     85        @raise TypeError: input item doesn't match list type 
     86        """ 
    6287        for i in iter: 
    6388            if not isinstance(i, self.__elementType): 
     
    6893         
    6994    def __iadd__(self, iter): 
     95        """Extend a list with input iterable 
     96        @param iter: iterable object 
     97        @type iter: iterable type 
     98        @raise TypeError: input item doesn't match list type 
     99        """ 
    70100        for i in iter: 
    71101            if not isinstance(i, self.__elementType): 
     
    76106          
    77107    def append(self, item): 
     108        """Add an item to the list 
     109        @param iter: iterable object 
     110        @type iter: iterable type 
     111        @raise TypeError: input item doesn't match list type 
     112        """ 
    78113        if not isinstance(item, self.__elementType): 
    79114                raise TypeError("List items must be of type %s" %  
     
    95130           
    96131    def __setitem__(self, key, val): 
     132        """@param key: key for item to set 
     133        @type key: any 
     134        @param val: value to set for this key 
     135        @type val: any 
     136        """ 
    97137        if key not in self.__keyNames: 
    98138            raise KeyError('Key name %r not recognised.  Valid key names ' 
     
    102142 
    103143    def update(self, d, **kw):         
     144        """@param d: dictionary to update from 
     145        @type d: dict 
     146        @param kw: keywords to update dictionary with 
     147        @type kw: dict 
     148        """ 
    104149        for dictArg in (d, kw): 
    105150            for k in dictArg: 
     
    117162class VettedDict(UserDict.DictMixin): 
    118163    """Enforce custom checking on keys and items before addition to a  
    119     dictionary""" 
     164    dictionary 
     165    """ 
    120166     
    121167    def __init__(self, *args): 
     
    145191        filtered out.  Filter functions may also raise an exception if they 
    146192        wish to abort completely 
     193         
     194        @param key: dict key to check 
     195        @type key: basestring 
     196        @param val: value to check 
     197        @type val: any 
    147198        """ 
    148199        if not self.__KeyFilter(key): 
     
    156207                   
    157208    def __setitem__(self, key, val): 
    158         """Enforce type checking when setting new items"""        
     209        """Enforce type checking when setting new items 
     210         
     211        @param key: key for item to set 
     212        @type key: any 
     213        @param val: value to set for this key 
     214        @type val: any 
     215        """        
    159216        if self._verifyKeyValPair(key, val): 
    160217            self.__map[key] = val 
    161218 
    162219    def __getitem__(self, key): 
    163         """Provde implementation for getting items""" 
     220        """Provide implementation for getting items 
     221        @param key: key for item to retrieve 
     222        @type key: any 
     223        @return: value for input key 
     224        @rtype: any 
     225        """ 
    164226        if key not in self.__map: 
    165227            raise KeyError('%r key not found in dict' % key) 
     
    168230     
    169231    def get(self, key, *arg): 
    170         """Provide implementation of get item with default""" 
     232        """Provide implementation of get item with default 
     233         
     234        @param key: key for item to retrieve 
     235        @type key: any 
     236        @param arg: use to set a default argument 
     237        @type arg: tuple 
     238        """ 
    171239        if key in self.__map: 
    172240            return self.__map[key] 
Note: See TracChangeset for help on using the changeset viewer.