From 48a859fbe280fbaca6204bb58d43b83235b2d68f Mon Sep 17 00:00:00 2001
From: Sinisa Veseli <sveseli@aps.anl.gov>
Date: Mon, 6 Apr 2015 19:24:56 +0000
Subject: [PATCH] added base dm object class, user info class, object manager,
and authorization principal class
---
src/python/dm/common/__init__.py | 0
src/python/dm/common/objects/__init__.py | 0
.../common/objects/authorizationPrincipal.py | 29 ++++
src/python/dm/common/objects/dmObject.py | 155 ++++++++++++++++++
.../dm/common/objects/dmObjectManager.py | 29 ++++
src/python/dm/common/objects/userInfo.py | 11 ++
6 files changed, 224 insertions(+)
create mode 100644 src/python/dm/common/__init__.py
create mode 100644 src/python/dm/common/objects/__init__.py
create mode 100755 src/python/dm/common/objects/authorizationPrincipal.py
create mode 100755 src/python/dm/common/objects/dmObject.py
create mode 100755 src/python/dm/common/objects/dmObjectManager.py
create mode 100755 src/python/dm/common/objects/userInfo.py
diff --git a/src/python/dm/common/__init__.py b/src/python/dm/common/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/src/python/dm/common/objects/__init__.py b/src/python/dm/common/objects/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/src/python/dm/common/objects/authorizationPrincipal.py b/src/python/dm/common/objects/authorizationPrincipal.py
new file mode 100755
index 00000000..271138e7
--- /dev/null
+++ b/src/python/dm/common/objects/authorizationPrincipal.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+from dmObject import DmObject
+
+class AuthorizationPrincipal(DmObject):
+
+ def __init__(self, name, token=None, userInfo={}):
+ DmObject.__init__(self,{'name' : name, 'token' : token, 'userInfo' : userInfo})
+
+ def getName(self):
+ return self.get('name')
+
+ def getAuthenticationToken(self):
+ return self.get('token')
+
+ def getToken(self):
+ return self.get('token')
+
+ def setRole(self, role):
+ self['role'] = role
+
+ def getRole(self):
+ return self.get('role')
+
+ def setUserInfo(self, userInfo):
+ self['userInfo'] = userInfo
+
+ def getUserInfo(self):
+ return self.get('userInfo')
diff --git a/src/python/dm/common/objects/dmObject.py b/src/python/dm/common/objects/dmObject.py
new file mode 100755
index 00000000..5c85b8ea
--- /dev/null
+++ b/src/python/dm/common/objects/dmObject.py
@@ -0,0 +1,155 @@
+#!/usr/bin/env python
+
+#
+# DM Object class.
+#
+
+#######################################################################
+
+import UserDict
+import UserList
+import types
+import json
+import datetime
+
+from dm.common.exceptions.invalidArgument import InvalidArgument
+from dm.common.utility import loggingManager
+
+class DmObject(UserDict.UserDict):
+ """ Base dm object class. """
+ ALL_KEYS = '__all__'
+ DEFAULT_KEYS = '__default__'
+
+ DICT_DISPLAY_FORMAT = 'dict'
+ TEXT_DISPLAY_FORMAT = 'text'
+ JSON_DISPLAY_FORMAT = 'json'
+
+ DEFAULT_KEY_LIST = [ 'id', 'name' ]
+
+ def __init__(self, dict={}):
+ if isinstance(dict, types.DictType):
+ UserDict.UserDict.__init__(self, dict)
+ elif isinstance(dict, UserDict.UserDict):
+ UserDict.UserDict.__init__(self, dict.data)
+ else:
+ raise InvalidArgument('DmObject instance must be initialized using dictionary.')
+ self.logger = None
+
+ def getLogger(self):
+ if not self.logger:
+ self.logger = loggingManager.getLogger(self._class__.__name__)
+ return self.logger
+
+ @classmethod
+ def getFromDict(cls, dict):
+ inst = cls()
+ for key in dict.keys():
+ inst[key] = dict[key]
+ return inst
+
+ def getRepKeyList(self, keyList):
+ if keyList is None:
+ return self.DEFAULT_KEY_LIST
+ elif type(keyList) == types.ListType:
+ if not len(keyList):
+ return self.DEFAULT_KEY_LIST
+ else:
+ return keyList
+ elif type(keyList) == types.StringType:
+ if keyList == DmObject.ALL_KEYS:
+ return self.data.keys()
+ elif keyList == DmObject.DEFAULT_KEYS:
+ return self.DEFAULT_KEY_LIST
+ else:
+ # Assume keys are separated by comma
+ return keyList.split(',')
+ else:
+ # Unknown key list parameter.
+ raise InvalidArgument('Key list parameter must be one of: None, string "%s", string "%s", string containing comma-separated keys, or list of strings.' (DmObject.ALL_KEYS, DmObject.DEFAULT_KEYS))
+
+
+ def getDictRep(self, keyList=None):
+ # Dict representation is dict
+ dictRep = {}
+ displayKeyList = self.getRepKeyList(keyList)
+ for key in displayKeyList:
+ value = self.get(key)
+ if isinstance(value, DmObject):
+ dictRep[key] = value.getDictRep('__all__')
+ elif type(value) == types.ListType:
+ itemList = []
+ for item in value:
+ if isinstance(item, DmObject):
+ itemList.append(item.getDictRep('__all__'))
+ else:
+ itemList.append(item)
+ dictRep[key] = itemList
+ else:
+ if value is not None:
+ if isinstance(value, datetime.datetime):
+ dictRep[key] = str(value)
+ else:
+ dictRep[key] = value
+ return dictRep
+
+ def getTextRep(self, keyList=None):
+ display = ''
+ displayKeyList = self.getRepKeyList(keyList)
+ for key in displayKeyList:
+ value = self.get(key)
+ if isinstance(value, DmObject):
+ display = display + '%s={ %s} ' % (key, value.getTextRep())
+ elif isinstance(value, types.ListType):
+ display = display + '%s=[ ' % key
+ for item in value:
+ if isinstance(item, DmObject):
+ display = display + '{ %s}, ' % (item)
+ else:
+ display = display + ' %s, ' % (item)
+ display = display + '] '
+ else:
+ if value is not None:
+ display = display + '%s=%s ' % (key, value)
+ return display
+
+ def getJsonRep(self, keyList=None):
+ dictRep = self.getDictRep(keyList)
+ return json.dumps(dictRep)
+
+ def getFullJsonRep(self):
+ dictRep = self.getDictRep(DmObject.ALL_KEYS)
+ return json.dumps(dictRep)
+
+ @classmethod
+ def fromJsonString(cls, jsonString):
+ return cls.getFromDict(json.loads(jsonString))
+
+ def getDisplayString(self, displayKeyList=[], displayFormat=TEXT_DISPLAY_FORMAT):
+ """ Get display string. """
+ if displayFormat == DmObject.DICT_DISPLAY_FORMAT:
+ return self.getDictRep(displayKeyList)
+ elif displayFormat == DmObject.TEXT_DISPLAY_FORMAT:
+ return self.getTextRep(displayKeyList)
+ elif displayFormat == DmObject.JSON_DISPLAY_FORMAT:
+ return self.getJsonRep(displayKeyList)
+ raise InvalidArgument('Unrecognized display displayFormat: %s.' (displayFormat))
+
+
+#######################################################################
+# Testing.
+
+if __name__ == '__main__':
+ x = {'name' : 'XYZ', 'one':1, 'two':2 }
+ o = DmObject(x)
+ print 'DM Object: ', o
+ print 'Type of DM object: ', type(o)
+ print 'JSON Rep: ', o.getJsonRep()
+ print 'Type of JSON rep: ', type(o.getJsonRep())
+ j = '{"name" : "XYZ", "one":1, "two":2 }'
+ print 'String: ', j
+ x2 = DmObject.fromJsonString(j)
+ print 'DM Object 2: ', x2
+ print 'Type of DM object 2: ', type(x2)
+ print x2.getDisplayString(displayKeyList='__all__')
+
+
diff --git a/src/python/dm/common/objects/dmObjectManager.py b/src/python/dm/common/objects/dmObjectManager.py
new file mode 100755
index 00000000..e5232cbf
--- /dev/null
+++ b/src/python/dm/common/objects/dmObjectManager.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+
+#
+# Base object manager class.
+#
+
+#######################################################################
+
+import threading
+from dm.common.utility.loggingManager import LoggingManager
+
+#######################################################################
+
+class DmObjectManager:
+ """ Base object manager class. """
+
+ def __init__(self):
+ self.logger = LoggingManager.getInstance().getLogger(self.__class__.__name__)
+ self.lock = threading.RLock()
+
+ def getLogger(self):
+ return self.logger
+
+ def acquireLock(self):
+ self.lock.acquire()
+
+ def releaseLock(self):
+ self.lock.release()
+
diff --git a/src/python/dm/common/objects/userInfo.py b/src/python/dm/common/objects/userInfo.py
new file mode 100755
index 00000000..772f90c6
--- /dev/null
+++ b/src/python/dm/common/objects/userInfo.py
@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+from dmObject import DmObject
+
+class UserInfo(DmObject):
+
+ DEFAULT_KEY_LIST = [ 'id', 'username', 'firstName', 'lastName', 'middleName', 'email', 'description' ]
+
+ def __init__(self, dict):
+ DmObject.__init__(self, dict)
+
--
GitLab