Ignore:
Timestamp:
28/06/10 10:19:26 (11 years ago)
Author:
pjkersha
Message:

Incomplete - task 2: XACML-Security Integration

  • updating epydoc ready for release.
File:
1 edited

Legend:

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

    r7103 r7108  
    7676    @type __description: NoneType / basestring 
    7777    @ivar __target: target element 
    78     @type __target: NoneType / basestring 
    79     @ivar __attr: attribute 
    80     @type __attr: NoneType / basestring 
     78    @type __target: NoneType / ndg.xacml.core.target.Target 
     79    @ivar __attr: list of rules 
     80    @type __attr: ndg.xacml.utils.TypedList 
    8181    @ivar __obligations: obligations 
    82     @type __obligations: NoneType / basestring 
     82    @type __obligations: ndg.xacml.utils.TypedList 
    8383    @ivar __ruleCombiningAlgFactory: rule combining algorithm factory 
    84     @type __ruleCombiningAlgFactory: NoneType / basestring 
     84    @type __ruleCombiningAlgFactory: ndg.xacml.core.rule_combining_alg.RuleCombiningAlgClassFactory 
    8585    @ivar __ruleCombiningAlg: rule combining algorithm 
    86     @type __ruleCombiningAlg: NoneType / basestring 
     86    @type __ruleCombiningAlg: NoneType / ndg.xacml.core.rule_combining_alg.RuleCombiningAlgInterface 
    8787 
    8888    """  
     
    129129        self.__description = None 
    130130        self.__target = None 
     131        self.__policyDefaults = None 
    131132         
    132133        # Attr should eventually allow a choice of Rule, CombinerParameter,  
     
    146147 
    147148    def _getRuleCombiningAlgFactory(self): 
     149        """ 
     150        @return: rule combining algorithm factory 
     151        @rtype: NoneType / ndg.xacml.core.rule_combining_alg.RuleCombiningAlgClassFactory 
     152        """ 
    148153        return self.__ruleCombiningAlgFactory 
    149154 
    150155    def _setRuleCombiningAlgFactory(self, value): 
     156        """ 
     157        @param value: rule combining algorithm factory 
     158        @type value: ndg.xacml.core.rule_combining_alg.RuleCombiningAlgClassFactory 
     159        @raise TypeError: incorrect input type 
     160        """ 
    151161        if not isinstance(value, RuleCombiningAlgClassFactory): 
    152162            raise TypeError('Expecting %r derived type for ' 
     
    162172    @property 
    163173    def ruleCombiningAlg(self): 
    164         "Rule Combining algorithm" 
     174        """Rule Combining algorithm 
     175        @return: rule combining algorithm class instance 
     176        @rtype: ndg.xacml.core.rule_combining_alg.RuleCombiningAlgInterface  
     177        derived type 
     178        """ 
    165179        return self.__ruleCombiningAlg 
    166180     
     
    193207         
    194208    def _getPolicyId(self): 
     209        ''' 
     210        @return: policy id 
     211        @type basestring: NoneType / basestring 
     212        ''' 
    195213        return self.__policyId 
    196214 
    197215    def _setPolicyId(self, value): 
     216        '''@param value: policy id 
     217        @type value: basestring 
     218        @raise TypeError: incorrect input type 
     219        ''' 
    198220        if not isinstance(value, basestring): 
    199221            raise TypeError('Expecting string type for "policyId" ' 
     
    205227 
    206228    def _getVersion(self): 
     229        '''@return: policy version 
     230        @rtype: NoneType / basestring 
     231        ''' 
    207232        return self.__version 
    208233 
    209234    def _setVersion(self, value): 
     235        '''@param value: policy version 
     236        @type value: basestring 
     237        @raise TypeError: incorrect input type 
     238        ''' 
    210239        if not isinstance(value, basestring): 
    211240            raise TypeError('Expecting string type for "version" ' 
     
    217246 
    218247    def _getRuleCombiningAlgId(self): 
     248        '''@return: rule combining algorithm ID 
     249        @rtype: NoneType / basestring 
     250        ''' 
    219251        return self.__ruleCombiningAlgId 
    220252 
    221253    def _setRuleCombiningAlgId(self, value): 
     254        '''@param value: rule combining algorithm ID 
     255        @type value: NoneType / basestring 
     256        @raise TypeError: incorrect input type 
     257        ''' 
    222258        if not isinstance(value, basestring): 
    223259            raise TypeError('Expecting string type for "ruleCombiningAlgId" ' 
     
    228264         
    229265    def _setRuleCombiningAlgFromId(self): 
    230         """Set the rule combining algorithm implementation from the Id set 
     266        """Set the rule combining algorithm implementation from the Id set in 
     267        __ruleCombiningAlgId the attribute 
     268         
     269        @raise TypeError: incorrect input type 
     270        @raise UnsupportedStdFunctionError: no implementation is avaliable for 
     271        this XACML rule combining algorithm  
     272        @raise UnsupportedFunctionError: the rule combining algorithm is not 
     273        recognised as a standard XACML one 
    231274        """ 
    232275        # Look-up rule combining algorithm 
     
    256299    @property 
    257300    def combinerParameters(self): 
     301        """@raise NotImplementedError: combiner parameters property is not 
     302        currently implemented 
     303        """ 
    258304        raise NotImplementedError() 
    259305     
    260306    @property 
    261307    def ruleCombinerParameters(self): 
     308        """@raise NotImplementedError: rule combiner parameters property is not 
     309        currently implemented 
     310        """ 
    262311        raise NotImplementedError() 
    263312     
    264313    @property 
    265314    def variableDefinitions(self): 
     315        """@raise NotImplementedError: variable definitions parameters property  
     316        is not currently implemented 
     317        """ 
    266318        raise NotImplementedError() 
    267319     
    268320    @property 
    269321    def rules(self): 
     322        """Return the list of rules 
     323        @return: list of rules 
     324        @rtype: ndg.xacml.utils.TypedList 
     325        """ 
    270326        return self.__attr 
    271327     
    272328    @property 
    273329    def obligations(self): 
     330        """@ivar __obligations: obligations 
     331        @type __obligations: ndg.xacml.utils.TypedList 
     332        """ 
    274333        return self.__obligations  
    275334 
    276335    def _getTarget(self): 
     336        """@return: target element 
     337        @rtype: NoneType / ndg.xacml.core.target.Target 
     338        """ 
    277339        return self.__target 
    278340 
    279341    def _setTarget(self, value): 
     342        """@param value: target element 
     343        @type value: ndg.xacml.core.target.Target 
     344        @raise TypeError: incorrect input type 
     345        """ 
    280346        if not isinstance(value, Target): 
    281347            raise TypeError('Expecting Target for "target" ' 
     
    286352 
    287353    def _getDescription(self): 
     354        '''@return: policy description text 
     355        @rtype: NoneType / basestring 
     356        ''' 
    288357        return self.__description 
    289358 
    290359    def _setDescription(self, value): 
     360        '''@param value: policy description text 
     361        @type value: basestring 
     362        @raise TypeError: incorrect input type 
     363        ''' 
    291364        if not isinstance(value, basestring): 
    292365            raise TypeError('Expecting string type for "description" ' 
     
    298371 
    299372    def _getPolicyDefaults(self): 
     373        '''@return: policy defaults 
     374        @rtype: NoneType / ndg.xacml.core.policydefaults.PolicyDefaults 
     375        ''' 
    300376        return self.__policyDefaults 
    301377 
    302378    def _setPolicyDefaults(self, value): 
     379        '''@param value: policy defaults 
     380        @type value: ndg.xacml.core.policydefaults.PolicyDefaults 
     381        @raise TypeError: incorrect input type 
     382        ''' 
    303383        if not isinstance(value, PolicyDefaults): 
    304384            raise TypeError('Expecting string type for "policyDefaults" ' 
     
    320400        @return: XACML response instance 
    321401        @rtype: ndg.xacml.core.context.response.Response 
     402        @raise XacmlContextError: error evaluating input request context 
    322403        """ 
    323404        response = Response() 
Note: See TracChangeset for help on using the changeset viewer.