Changeset 7088 for TI12-security/trunk/ndg_xacml/ndg/xacml/core/functions/__init__.py

Timestamp:

25/06/10 13:14:03 (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/functions/__init__.py (modified) (9 diffs)

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

@@ -23 +23 @@
 
 class AbstractFunction(object):
-    """Base class for all XACML matching functions"""
-    
+    """Abstract Base class for all XACML matching functions
+    @cvar FUNCTION_NS: namespace for the given function
+    @type FUNCTION_NS: NoneType (must be string in derived type)
+    
+    @cvar V1_0_FUNCTION_NS: XACML 1.0 function namespace prefix
+    @type V1_0_FUNCTION_NS: string
+    
+    @cvar V2_0_FUNCTION_NS: XACML 2.0 function namespace prefix
+    @type V2_0_FUNCTION_NS: string
+    """
     __metaclass__ = ABCMeta
+    
     FUNCTION_NS = None
     V1_0_FUNCTION_NS = "urn:oasis:names:tc:xacml:1.0:function:"
@@ -31 +40 @@
     
     def __init__(self):
+        """
+        @raise TypeError: if FUNCTION_NS not set correctly
+        """
         if self.__class__.FUNCTION_NS is None:
             raise TypeError('"FUNCTION_NS" class variable must be defined in '
@@ -38 +50 @@
     def evaluate(self, *inputs):
         """Evaluate the function from the given input arguments and context
+        
         @param inputs: input arguments need to evaluate the function
         @type inputs: tuple
-        @return: True for match, False otherwise
-        @rtype: bool
+        @return: derived type should return True for match, False otherwise
+        @rtype: bool (derived type), NoneType for THIS implementation
         """
         
 class XacmlFunctionNames(object):
-    """XACML standard match function names"""
+    """XACML standard match function names
+    
+    @cvar FUNCTION_NAMES: list of all the XACML function URNs
+    @type FUNCTION_NAMES: tuple    
+    """
     FUNCTION_NAMES = (
 'urn:oasis:names:tc:xacml:1.0:function:string-equal',
@@ -275 +292 @@
         @return: at least one member of class corresponding to the given input
         identifier
-        @rtype: AbstractFunction derived type or None if no match is 
-        found
+        @rtype: AbstractFunction derived type or NoneType if no match is found
         '''
         return None
@@ -462 +478 @@
     FunctionClassFactoryInterface implementations so that a function class can 
     be obtained directly from a given XACML function URN.  
+    
+    @cvar FUNCTION_PKG_PREFIX: python package path for functions package
+    @type FUNCTION_PKG_PREFIX: string
+    
+    @cvar V1_0_PKG_PREFIX: python package path for XACML 1.0 functions package
+    @type V1_0_PKG_PREFIX: string
+    
+    @cvar V2_0_PKG_PREFIX: python package path for XACML 2.0 functions package
+    @type V2_0_PKG_PREFIX: string
+    
+    @cvar SUPPORTED_NSS: mapping of function URN prefix to Python package
+    @type SUPPORTED_NSS: dict
+    
+    @cvar FUNCTION_CLASS_FACTORY_CLASSNAME: standard name for class factory
+    which should be present in each generic function module.  This factory is 
+    invoked to create the function class for any given function URN related to
+    that module
+    @type FUNCTION_CLASS_FACTORY_CLASSNAME: string
     """
     FUNCTION_PKG_PREFIX = 'ndg.xacml.core.functions.'
@@ -496 +530 @@
     @staticmethod
     def keyFilter(key):
-        """Enforce string type keys"""
+        """Enforce string type keys
+        
+        @param key: function URN
+        @type key: basestring
+        @return: True for valid key type
+        @rtype: bool
+        @raise TypeError: invalid key type
+        """
         if not isinstance(key, basestring):
             raise TypeError('Expecting %r type for key; got %r' % 
@@ -505 +546 @@
     @staticmethod
     def valueFilter(value):
-        """Enforce AbstractFunction derived types for match functions"""
+        """Enforce AbstractFunction derived types for match functions
+        
+        @param value: function URN
+        @type value: ndg.xacml.core.functions.AbstractFunction / NotImplemented
+        @return: True for valid function type
+        @rtype: bool
+        @raise TypeError: invlaid key type
+        """
         if value is NotImplemented:
             return True
@@ -580 +628 @@
         """Override base class implementation to load and cache function classes
         if they don't otherwise exist
+        
+        @param key: function URN
+        @type key: basestring
+        @return: function class
+        @rtype: ndg.xacml.core.functions.AbstractFunction / NotImplemented
         """
         functionClass = VettedDict.get(self, key)
@@ -590 +643 @@
         """Likewise to __getitem__, enable loading and caching of function 
         classes if they don't otherwise exist
+        
+        @param key: XACML function URN
+        @type key: basestring
+        @param *arg: set a single additional argument if required which is 
+        used as the default value should the key not be found in the map
+        @type *arg: tuple
+        @return: function class
+        @rtype: ndg.xacml.core.functions.AbstractFunction / NotImplemented
         """
         functionClass = VettedDict.get(self, key, *arg)