Changeset 7098

Timestamp:

25/06/10 14:51:24 (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:

• __init__.py (modified) (4 diffs)
• context/resource.py (modified) (1 diff)

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

@@ -14 +14 @@
     
 class XacmlCoreBase(object):
-    """Base class for all XACML types"""
+    """Base class for all XACML types
+    
+    @cvar XACML_1_0_NS_PREFIX: XACML version 1.0 namespace prefix
+    @type XACML_1_0_NS_PREFIX: string
+    @cvar XACML_2_0_NS_PREFIX: XACML version 2.0 namespace prefix
+    @type XACML_2_0_NS_PREFIX: string
+    @cvar XMLNS: list of valid XACML namespaces
+    @type XMLNS: tuple
+    @cvar ELEMENT_LOCAL_NAME: XML element local name for the given type
+    @type ELEMENT_LOCAL_NAME: NoneType but implement as string in derived 
+    classes
+    
+    @ivar __xmlns: XML namespace for the XACML type
+    @type __xmlns: NoneType / basestring
+        
+    @ivar __elem: XML element 
+    @type __elem: NoneType / dependent on Python XML parser used
+    """
     XACML_1_0_NS_PREFIX = "urn:oasis:names:tc:xacml:1.0"
     XACML_2_0_NS_PREFIX = "urn:oasis:names:tc:xacml:2.0"
-
+    
+    XMLNS = (XACML_1_0_NS_PREFIX, XACML_2_0_NS_PREFIX)
+    
     __slots__ = ('__xmlns', '__reader', '__writer', '__elem')
 
@@ -23 +42 @@
     
     def __init__(self):
+        """Element local name check makes this a virtual method
+        
+        @raise NotImplementedError: derived classes must set 
+        ELEMENT_LOCAL_NAME to a string
+        """
         self.__xmlns = None
-        self.__reader = None
-        self.__writer = None
         self.__elem = None
         
@@ -33 +55 @@
         
     def _getXmlns(self):
-        """XML Namespace for this XACML type"""
+        """Get XML Namespace for this XACML type
+        @return: the XML namespace set
+        @rtype: basestring/NoneType        
+        """
         return self.__xmlns
 
     def _setXmlns(self, value):
-        """XML Namespace for this XACML type"""
+        """Set XML Namespace for this XACML type
+        @param value: the XML namespace to set
+        @type value: basestring/NoneType                 
+        """
         if not isinstance(value, basestring):
             raise TypeError('Expecting string type for "xmlns" '
@@ -48 +76 @@
     @property
     def isValidXmlns(self):
+        """Check XML namespace fits with the known XACML namespaces
+        @return: True if valid, False otherwise
+        @rtype: bool
+        """
         return self.xmlns in XacmlCoreBase.XMLNS
-
-    def read(self, obj):
-        """Read using callable assinged to reader property"""
-        if self.__reader is None:
-            raise AttributeError('No reader set for %r' % self.__class__)
-        
-        self.__reader(self, obj)
-
-    @classmethod
-    def Read(cls, obj):
-        """Construct a new Policy""" 
-        xacmlObj = cls()
-        xacmlObj.read(obj)
-        return xacmlObj
-    
-    def write(self, obj):
-        """Read using callable assinged to reader property"""
-        if self.__writer is None:
-            raise AttributeError('No writer set for %r' % self.__class__)
-        
-        self.__writer(self, obj)
         
     @property

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

@@ -43 +43 @@
 
     def _set_resourceContent(self, value):
+        """Set resource content
+        @param value: content
+        @type value: any
         """
         self.__resourceContent = value