Changeset 7109 for TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/matchreader.py

Timestamp:

28/06/10 13:54:57 (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/parsers/etree/matchreader.py (modified) (1 diff)

TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/matchreader.py

@@ -22 +22 @@
     '''ElementTree based XACML generic Match parser for subject, resource, 
     action and environment match types
+    
+    @cvar ATTRIBUTE_DESIGNATOR_TYPE: type for attribute designator sub-elements:
+    derived class should set to relevant type e.g. for SubjectMatch,
+    SubjectAttributeDesignator
+    @type ATTRIBUTE_DESIGNATOR_TYPE: NoneType
     '''
     ATTRIBUTE_DESIGNATOR_TYPE = None
     
     def __init__(self):
+        """Virtual method
+        
+        @raise NotImplementedError: ATTRIBUTE_DESIGNATOR_TYPE must be set in a 
+        derived class
+        """
         if self.__class__.ATTRIBUTE_DESIGNATOR_TYPE is None:
             raise NotImplementedError('Extend this class setting the '
-                                      '"ATTRIBUTE_DESIGNATOR_TYPE" '
-                                      'class variable')
+                                      '"ATTRIBUTE_DESIGNATOR_TYPE" class '
+                                      'variable')
             
         super(MatchReaderBase, self).__init__()
         
     def __call__(self, obj):
-        """Parse subject object"""
+        """Parse *Match object (where * = Subject, Resource, Environment or
+        Action
+        
+        @param obj: input object to parse
+        @type obj: ElementTree Element, or stream object
+        @return: new XACML match instance
+        @rtype: ndg.xacml.core.matchreader.MatchReaderBase derived type 
+        @raise XMLParseError: error reading element                 
+        """
         elem = super(MatchReaderBase, self)._parse(obj)