Changeset 7100 for TI12-security/trunk/ndg_xacml

Timestamp:

25/06/10 16:12:02 (11 years ago)

Author:

pjkersha

Message:

Incomplete - task 2: XACML-Security Integration

• updating epydoc ready for release.

Location:

TI12-security/trunk/ndg_xacml/ndg/xacml/core

Files:

• action.py (modified) (2 diffs)
• apply.py (modified) (8 diffs)
• environment.py (modified) (2 diffs)
• resource.py (modified) (2 diffs)
• subject.py (modified) (2 diffs)

TI12-security/trunk/ndg_xacml/ndg/xacml/core/action.py

@@ -15 +15 @@
 
 class Action(TargetChildBase):
+    """XACML Action Target Policy element
+    
+    @cvar MATCH_TYPE: Sets the type for match attributes in this 
+    TargetChildBase derived class
+    implementation e.g. ResourceMatch, SubjectMatch etc.
+    @type MATCH_TYPE: ndg.xacml.core.match.ActionMatch
+    @cvar ELEMENT_LOCAL_NAME: XML element local name
+    @type ELEMENT_LOCAL_NAME: string
+    """
     MATCH_TYPE = ActionMatch
     ELEMENT_LOCAL_NAME = 'Action'
@@ -22 +31 @@
     @property
     def actionMatches(self):
+        """Convenience wrapper to base class method
+        @return: list of matches
+        @rtype: ndg.xacml.utils.TypedList 
+        """
         return self.matches

TI12-security/trunk/ndg_xacml/ndg/xacml/core/apply.py

@@ -18 +18 @@
 
 class Apply(Expression):
-    """XACML Apply type"""
+    """XACML Apply type
+    
+    @cvar ELEMENT_LOCAL_NAME: XML element local name
+    @type ELEMENT_LOCAL_NAME: string
+    @cvar FUNCTION_ID_ATTRIB_NAME: function ID XML attribute name
+    @type FUNCTION_ID_ATTRIB_NAME: string
+
+    @ivar __functionId: URN corresponding to function to be applied
+    @type __functionId: basestring/NoneType
+    @ivar __function: function to be applied
+    @type __function: ndg.xacml.core.functions.AbstractFunction derived type
+    @ivar __functionMap: function mapping object to map URNs to function class
+    implementations
+    @type __functionMap: ndg.xacml.core.functions.FunctionMap
+    @ivar __loadFunctionFromId: boolean determines whether or not to load
+    function classes for given function URN in functionId set property method
+    @type __loadFunctionFromId: bool
+    @ivar __expressions: list of expressions contained in the Apply statement
+    @type __expressions: ndg.xacml.utils.TypedList
+    """
     ELEMENT_LOCAL_NAME = 'Apply'
     FUNCTION_ID_ATTRIB_NAME = 'FunctionId'
@@ -31 +50 @@
     
     def __init__(self):
+        """Initialise attributes"""
         super(Apply, self).__init__()
         self.__functionId = None
@@ -41 +61 @@
     def loadFunctionFromId(self):
         """Set to False to stop the functionId property set method automatically
-        trying to load the corresponding function for the given functionId""" 
+        trying to load the corresponding function for the given functionId
+        
+        @return: flag setting
+        @rtype: bool""" 
         return self.__loadFunctionFromId
     
     @loadFunctionFromId.setter
     def loadFunctionFromId(self, value):
+        """Set to False to stop the functionId property set method automatically
+        trying to load the corresponding function for the given functionId
+        
+        @param value: flag setting
+        @type value: bool
+        @raise TypeError: incorrect input type
+        """ 
         if not isinstance(value, bool):
             raise TypeError('Expecting %r type for "loadFunctionFromId" '
@@ -53 +83 @@
         
     def _get_functionId(self):
+        """Get function ID
+        @return: function ID for this Apply statement
+        @rtype: basestring/NoneType
+        """
         return self.__functionId
 
     def _set_functionId(self, value):
+        """Set function ID
+        @param value: function URN
+        @type value: basestring
+        @raise TypeError: incorrect input type
+        """ 
         if not isinstance(value, basestring):
             raise TypeError('Expecting %r type for "functionId" '
@@ -76 +115 @@
         
         loadFunctionFromId = False
+    
+        @param functionMap: function mapping object to map URNs to function 
+        class implementations
+        @type functionMap: ndg.xacml.core.functions.FunctionMap
         
         @raise UnsupportedStdFunctionError: policy references a function type 
@@ -102 +145 @@
     def functionMap(self):
         """functionMap object for PDP to retrieve functions from given XACML
-        function URNs"""
+        function URNs
+        @return: function mapping object
+        @rtype: ndg.xacml.core.functions.FunctionMap
+        """
         return self.__functionMap
     
@@ -108 +154 @@
     def functionMap(self, value):
         '''functionMap object for PDP to retrieve functions from given XACML
-        function URNs'''
+        function URNs
+        @ivar value: function mapping object to map URNs to function 
+        class implementations
+        @type value: ndg.xacml.core.functions.FunctionMap
+        @raise TypeError: incorrect type for input value
+        '''
         if not isinstance(value, FunctionMap):
             raise TypeError('Expecting %r derived type for "functionMap" '
@@ -117 +168 @@
     @property  
     def function(self):
-        "Function for this <Apply> instance"
+        """Get Function for this <Apply> instance
+        @return: function to be applied
+        @rtype: ndg.xacml.core.functions.AbstractFunction derived type
+        """
         return self.__function
         
     @property
     def expressions(self):
-        """List of expression sub-elements"""
+        """List of expression sub-elements
+        @return: list of expressions contained in the Apply statement
+        @rtype: ndg.xacml.utils.TypedList
+        """
         return self.__expressions 
     

TI12-security/trunk/ndg_xacml/ndg/xacml/core/environment.py

@@ -15 +15 @@
 
 class Environment(TargetChildBase):
+    """XACML Environment Target Policy element
+    
+    @cvar MATCH_TYPE: Sets the type for match attributes in this 
+    TargetChildBase derived class
+    @type MATCH_TYPE: ndg.xacml.core.match.EnvironmentMatch
+    @cvar ELEMENT_LOCAL_NAME: XML element local name
+    @type ELEMENT_LOCAL_NAME: string
+    """
     MATCH_TYPE = EnvironmentMatch
     ELEMENT_LOCAL_NAME = 'Environment'
@@ -22 +30 @@
     @property
     def environmentMatches(self):
+        """Convenience wrapper to base class method
+        @return: list of matches
+        @rtype: ndg.xacml.utils.TypedList 
+        """
         return self.matches

TI12-security/trunk/ndg_xacml/ndg/xacml/core/resource.py

@@ -15 +15 @@
 
 class Resource(TargetChildBase):
+    """XACML Resource Target Policy element
+    
+    @cvar MATCH_TYPE: Sets the type for match attributes in this 
+    TargetChildBase derived class
+    @type MATCH_TYPE: ndg.xacml.core.match.ResourceMatch
+    @cvar ELEMENT_LOCAL_NAME: XML element local name
+    @type ELEMENT_LOCAL_NAME: string
+    """
     MATCH_TYPE = ResourceMatch
     ELEMENT_LOCAL_NAME = 'Resource'
@@ -22 +30 @@
     @property
     def resourceMatches(self):
+        """Convenience wrapper to base class method
+        @return: list of matches
+        @rtype: ndg.xacml.utils.TypedList 
+        """
         return self.matches

TI12-security/trunk/ndg_xacml/ndg/xacml/core/subject.py

@@ -14 +14 @@
 
 class Subject(TargetChildBase):
+    """XACML Subject Target Policy element
+    
+    @cvar MATCH_TYPE: Sets the type for match attributes in this 
+    TargetChildBase derived class
+    @type MATCH_TYPE: ndg.xacml.core.match.SubjectMatch
+    @cvar ELEMENT_LOCAL_NAME: XML element local name
+    @type ELEMENT_LOCAL_NAME: string
+    """
     MATCH_TYPE = SubjectMatch
     ELEMENT_LOCAL_NAME = 'Subject'
@@ -21 +29 @@
     @property
     def subjectMatches(self):
+        """Convenience wrapper to base class method
+        @return: list of matches
+        @rtype: ndg.xacml.utils.TypedList 
+        """
         return self.matches