Changeset 7108 for TI12-security/trunk/ndg_xacml/ndg/xacml/core/target.py

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:

• TI12-security/trunk/ndg_xacml/ndg/xacml/core/target.py (modified) (4 diffs)

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

@@ -27 +27 @@
 
 class Target(XacmlCoreBase):
-    """XACML Target element"""
+    """XACML Target element
+    
+    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
+    @type ELEMENT_LOCAL_NAME: string
+    @cvar SUBJECTS_ELEMENT_LOCAL_NAME: XML local name for the subjects element
+    @type SUBJECTS_ELEMENT_LOCAL_NAME: string
+    @cvar ACTIONS_ELEMENT_LOCAL_NAME: XML local name for the actions element
+    @type ACTIONS_ELEMENT_LOCAL_NAME: string
+    @cvar RESOURCES_ELEMENT_LOCAL_NAME: XML local name for the resources element
+    @type RESOURCES_ELEMENT_LOCAL_NAME: string
+    @cvar ENVIRONMENTS_ELEMENT_LOCAL_NAME: XML local name for the environments
+    element
+    @type ENVIRONMENTS_ELEMENT_LOCAL_NAME: string
+    @cvar CHILD_ATTRS: list of the XML child element names for <Target/>
+    @type CHILD_ATTRS: tuple
+    
+    @ivar __subjects: list of subjects for this target
+    @type __subjects: ndg.xacml.utils.TypedList
+    @ivar __resources: list of resources for this target
+    @type __resources: ndg.xacml.utils.TypedList
+    @ivar __actions: list of actions for this target
+    @type __actions: ndg.xacml.utils.TypedList
+    @ivar __environments: list of environment settings for this target
+    @type __environments: ndg.xacml.utils.TypedList
+    """
     ELEMENT_LOCAL_NAME = "Target"
     SUBJECTS_ELEMENT_LOCAL_NAME = "Subjects"
@@ -46 +70 @@
     @property
     def subjects(self):
+        """Get subjects
+        @return: list of subjects for this target
+        @rtype: ndg.xacml.utils.TypedList
+        """
         return self.__subjects
     
     @property
     def resources(self):
+        """Get resources
+        @return: list of resources for this target
+        @rtype: ndg.xacml.utils.TypedList
+        """
         return self.__resources
     
     @property
     def actions(self):
+        """Get actions
+        @return: list of actions for this target
+        @rtype: ndg.xacml.utils.TypedList
+        """
         return self.__actions
     
     @property
     def environments(self):
+        """Get environments
+        @return: list of environments for this target
+        @rtype: ndg.xacml.utils.TypedList
+        """
         return self.__environments
             
@@ -63 +103 @@
         """Generic method to match a <Target> element to the request context
         
-        @param target: XACML target element
-        @type target: ndg.xacml.core.target.Target
         @param request: XACML request context
         @type request: ndg.xacml.core.context.request.Request
@@ -136 +174 @@
         object
         @type targetChild: ndg.xacml.core.TargetChildBase
-        @param requestChild: Request Subject, Resource, Action or Environment
-        object
-        @type requestChild: ndg.xacml.core.context.RequestChildBase
+        @param request: Request context object
+        @type request: ndg.xacml.core.context.request.Request
         @return: True if request context matches something in the target
         @rtype: bool