DTMA Class contents main functional of DTMA application, class inherits from foundation.CementApp. More...

Inheritance diagram for dtma.DTMA.DTMA:

Collaboration diagram for dtma.DTMA.DTMA:

Classes
class	Meta

Public Member Functions
def	__init__ (self, connectionBuilder=None)
	constructor initialise all class variable and recieve connectionBuilder as param(not mandatory) More...

def	fillError (self, errorStr, errorCode)
	fillError method calls from error-code point from main processing (...from event handlers) More...

def	connectionInit (self)
	connectionInit method initializes internal variables that containts network connections/communications More...

def	generateEmptyResponse (self, task)
	generateEmptyResponse method If here was some critical error, we generate empty response here , instead real response More...

def	configReader (self)
	configReader method Method try to read config file by prereared paths, return count of readed configs More...

def	checkAdditionalArgs (self, cmd)
	checkAdditionalArgs method Method checks additions mandatory argument's present More...

def	transportCommunications (self, cmd, requestObjects)
	taskProcessingDeserialize method Method serializes incoming task to the JSON string More...

def	loadLogConfigFile (self)
	load logging load logging configuration (log file, log level, filters) More...

def	setup (self)
	setup method Method calls before run application More...

def	run (self)
	run method Method contains main application functionality More...

def	close (self)
	close method Method calls after application run More...

Public Attributes
	config

	connectionBuilder

	localConnection

	eventBuilder

	dTMAObjectsFiller

	errorCode

	errorStr

Static Public Attributes
	label = CONSTANTS.APP_NAME

Detailed Description

DTMA Class contents main functional of DTMA application, class inherits from foundation.CementApp.

Definition at line 36 of file DTMA.py.

Constructor & Destructor Documentation

◆ init()

def dtma.DTMA.DTMA.__init__	(	self,
		connectionBuilder = `None`
	)

constructor initialise all class variable and recieve connectionBuilder as param(not mandatory)

Definition at line 44 of file DTMA.py.

   def __init__(self, connectionBuilder=None):
     foundation.CementApp.__init__(self)
     self.config = ConfigParser.ConfigParser()
     self.connectionBuilder = connectionBuilder
     self.localConnection = None
     self.eventBuilder = EventBuilder()
     self.dTMAObjectsFiller = DTMAObjectsFiller()
     self.errorCode = CONSTANTS.ERROR_NOERROR
     self.errorStr = ""
 
 

Member Function Documentation

◆ checkAdditionalArgs()

def dtma.DTMA.DTMA.checkAdditionalArgs	(	self,
		cmd
	)

checkAdditionalArgs method Method checks additions mandatory argument's present

Definition at line 122 of file DTMA.py.

   def checkAdditionalArgs(self, cmd):
     ret = True
     if cmd in CONSTANTS.TASKS[1:3]:
       if self.pargs.fields is None or self.pargs.classes is None:
         self.fillError(CONSTANTS.ERROR_STR2, CONSTANTS.ERROR_ARGS2)
         ret = False
     elif cmd == CONSTANTS.TASKS[0] or cmd == CONSTANTS.TASKS[3]:
       if self.pargs.classes is None:
         optionName = [CONSTANTS.SERVER_CONFIG_OPTION_NAME, CONSTANTS.SERVER_CONFIG_OPTION_NAME2]\
                      [cmd == CONSTANTS.TASKS[3]]
         try:
           self.pargs.classes = str(self.config.get(CONSTANTS.SERVER_CONFIG_SECTION_NAME, optionName))
         except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
           self.fillError(CONSTANTS.ERROR_STR3.format(CONSTANTS.SERVER_CONFIG_SECTION_NAME, optionName),
                          CONSTANTS.ERROR_CONFIG_SECTION)
           ret = False
     return ret
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ close()

def dtma.DTMA.DTMA.close ( self )

close method Method calls after application run

Definition at line 259 of file DTMA.py.

   def close(self):
     foundation.CementApp.close(self)
 

◆ configReader()

def dtma.DTMA.DTMA.configReader ( self )

configReader method Method try to read config file by prereared paths, return count of readed configs

Definition at line 109 of file DTMA.py.

   def configReader(self):
     configReadList = []
     if self.pargs.config is None:
       configReadList = self.config.read(CONSTANTS.DEFAULT_CONFIG_NAME1)
       if len(configReadList) == 0:
         configReadList = self.config.read(CONSTANTS.DEFAULT_CONFIG_NAME2)
     else:
       configReadList = self.config.read(self.pargs.config)
     return len(configReadList)
 
 

Here is the caller graph for this function:

◆ connectionInit()

def dtma.DTMA.DTMA.connectionInit ( self )

connectionInit method initializes internal variables that containts network connections/communications

Definition at line 65 of file DTMA.py.

   def connectionInit(self):
     if self.connectionBuilder is None:
       self.connectionBuilder = ConnectionBuilderLight()
     host = str(self.config.get(CONSTANTS.APP_NAME, CONSTANTS.DTM_HOST))
     if len(host) > 1 and host[0] == "\"":
       host = host[1:]
     if host[-1] == "\"":
       host = host[0:-1]
     port = str(self.config.get(CONSTANTS.APP_NAME, CONSTANTS.DTM_PORT))
     addr = host + ":" + port
     self.localConnection = self.connectionBuilder.build(transport.Consts.CLIENT_CONNECT, addr,
                                                         transport.Consts.TCP_TYPE)
 
 

Here is the caller graph for this function:

◆ fillError()

def dtma.DTMA.DTMA.fillError	(	self,
		errorStr,
		errorCode
	)

fillError method calls from error-code point from main processing (...from event handlers)

Definition at line 57 of file DTMA.py.

   def fillError(self, errorStr, errorCode):
     self.errorCode = errorCode
     self.errorStr = errorStr
     logger.error(self.errorStr)
 
 

Here is the caller graph for this function:

◆ generateEmptyResponse()

def dtma.DTMA.DTMA.generateEmptyResponse	(	self,
		task
	)

generateEmptyResponse method If here was some critical error, we generate empty response here , instead real response

Definition at line 81 of file DTMA.py.

   def generateEmptyResponse(self, task):
     ret = []
     obj = None
     if task is None:
       obj = dtm.EventObjects.GeneralResponse()
     elif task == CONSTANTS.TASKS[0]:
       obj = dtm.EventObjects.AdminStatData("")
     elif task == CONSTANTS.TASKS[1]:
       obj = dtm.EventObjects.AdminConfigVars("")
     elif task == CONSTANTS.TASKS[2]:
       obj = dtm.EventObjects.AdminConfigVars("")
     elif task == CONSTANTS.TASKS[3]:
       obj = dtm.EventObjects.GeneralResponse()
     elif task == CONSTANTS.TASKS[4]:
       obj = dtm.EventObjects.GeneralResponse()
     elif task == CONSTANTS.TASKS[5]:
       obj = dtm.EventObjects.GeneralResponse()
     elif task == CONSTANTS.TASKS[6]:
       obj = dtm.EventObjects.CustomResponse(None, None, None)
 
     obj.errorCode = self.errorCode
     obj.errorMessage = self.errorStr
     ret.append(obj)
     return json.dumps([ret], default=lambda o: o.__dict__, sort_keys=True, indent=4)
 
 

Here is the caller graph for this function:

◆ loadLogConfigFile()

def dtma.DTMA.DTMA.loadLogConfigFile ( self )

load logging load logging configuration (log file, log level, filters)

Definition at line 194 of file DTMA.py.

   def loadLogConfigFile(self):
     global logger  # pylint: disable=W0603
     try:
       logIniFileName = self.config.get(CONSTANTS.LOG_CONFIG_SECTION_NAME, CONSTANTS.LOG_CONFIG_OPTION_NAME)
       if logIniFileName != None:
         logging.config.fileConfig(logIniFileName, disable_existing_loggers=False)
     except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
       self.errorStr = CONSTANTS.ERROR_STR8
       self.errorCode = CONSTANTS.ERROR_LOG_SECTION_ERROR
     except Exception, err:
       self.errorStr = CONSTANTS.ERROR_STR10 + ': ' + str(err)
       self.errorCode = CONSTANTS.ERROR_LOG_INIT
     logger = Utils.MPLogger().getLogger()
 
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

def dtma.DTMA.DTMA.run ( self )

run method Method contains main application functionality

Definition at line 218 of file DTMA.py.

   def run(self):
     foundation.CementApp.run(self)
     isHelpArg = False
     if '-h' in self.argv or '--help' in self.argv:
       isHelpArg = True
     requestObjects = None
     jsonBuf = None
     if self.configReader() > 0:
       self.loadLogConfigFile()
 
       if self.errorCode == CONSTANTS.ERROR_NOERROR:
         try:
           self.connectionInit()
         except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
           self.fillError(CONSTANTS.ERROR_STR3, CONSTANTS.ERROR_CONFIG_SECTION)
         if not isHelpArg and self.pargs.cmd is None:
           self.fillError(CONSTANTS.ERROR_STR1, CONSTANTS.ERROR_ARGS1)
         elif self.pargs.cmd is not None and self.pargs.cmd in CONSTANTS.TASKS and \
         self.checkAdditionalArgs(self.pargs.cmd):
           try:
             requestObjects = self.dTMAObjectsFiller.generateObjectsList(self.pargs.cmd, self.pargs.fields,
                                                                         self.pargs.classes)
             responseObjects = self.transportCommunications(self.pargs.cmd, requestObjects)
             jsonBuf = json.dumps(responseObjects, default=lambda o: o.__dict__, sort_keys=True, indent=4)
           except (DTMAExceptions.DTMAEmptyFields, DTMAExceptions.DTMANameValueException):
             self.fillError(CONSTANTS.ERROR_STR4, CONSTANTS.ERROR_FIELDS_ARG)
           except DTMAExceptions.DTMAEmptyClasses:
             self.fillError(CONSTANTS.ERROR_STR5, CONSTANTS.ERROR_CLASSES_ARG)
     else:
       self.errorStr = CONSTANTS.ERROR_STR9
       self.errorCode = CONSTANTS.ERROR_NO_CONFIG
 
     if jsonBuf is None:
       jsonBuf = self.generateEmptyResponse(self.pargs.cmd)
     sys.stdout.write(jsonBuf)
     # Finish logging
     logger.info(APP_CONSTS.LOGGER_DELIMITER_LINE)
 
 

Here is the call graph for this function:

◆ setup()

def dtma.DTMA.DTMA.setup ( self )

setup method Method calls before run application

Definition at line 212 of file DTMA.py.

   def setup(self):
     foundation.CementApp.setup(self)

◆ transportCommunications()

def dtma.DTMA.DTMA.transportCommunications	(	self,
		cmd,
		requestObjects
	)

taskProcessingDeserialize method Method serializes incoming task to the JSON string

Definition at line 143 of file DTMA.py.

   def transportCommunications(self, cmd, requestObjects):
     responses = []
     retEvent = None
     eventType = None
     timeout = None
     responseTuple = []
     emptyResponse = None
     try:
       timeout = self.config.get(CONSTANTS.APP_NAME, CONSTANTS.TCP_TIMEOUT_CONFIG_NAME)
     except ConfigParser.NoSectionError:
       timeout = CONSTANTS.TCP_TIMEOUT
     except ConfigParser.NoOptionError:
       timeout = CONSTANTS.TCP_TIMEOUT
 
     for requestObject in requestObjects:
       if cmd == CONSTANTS.TASKS[0]:
         eventType = EVENT_TYPES.ADMIN_FETCH_STAT_DATA
         emptyResponse = dtm.EventObjects.AdminStatData(requestObject.className)
       elif cmd == CONSTANTS.TASKS[1]:
         eventType = EVENT_TYPES.ADMIN_SET_CONFIG_VARS
         emptyResponse = dtm.EventObjects.AdminConfigVars(requestObject.className)
       elif cmd == CONSTANTS.TASKS[2]:
         eventType = EVENT_TYPES.ADMIN_GET_CONFIG_VARS
         emptyResponse = dtm.EventObjects.AdminConfigVars(requestObject.className)
       elif cmd == CONSTANTS.TASKS[3]:
         eventType = EVENT_TYPES.ADMIN_STATE
         emptyResponse = dtm.EventObjects.GeneralResponse()
       elif cmd == CONSTANTS.TASKS[4]:
         eventType = EVENT_TYPES.ADMIN_SUSPEND
         emptyResponse = dtm.EventObjects.GeneralResponse()
       elif cmd == CONSTANTS.TASKS[5]:
         eventType = EVENT_TYPES.ADMIN_SYSTEM
         emptyResponse = dtm.EventObjects.GeneralResponse()
       elif cmd == CONSTANTS.TASKS[6]:
         eventType = EVENT_TYPES.ADMIN_SQL_CUSTOM
         emptyResponse = dtm.EventObjects.CustomResponse(None, None, None)
 
       event = self.eventBuilder.build(eventType, requestObject)
       self.localConnection.send(event)
       if self.localConnection.poll(timeout) == 0:
         responseTuple = [emptyResponse, CONSTANTS.ERROR_NETWORK]
       else:
         retEvent = self.localConnection.recv()
         responseTuple = [retEvent.eventObj, CONSTANTS.ERROR_NOERROR]
       responses.append(responseTuple)
     return responses
 
 

Here is the caller graph for this function:

Member Data Documentation

◆ config

dtma.DTMA.DTMA.config

Definition at line 46 of file DTMA.py.

◆ connectionBuilder

dtma.DTMA.DTMA.connectionBuilder

Definition at line 47 of file DTMA.py.

◆ dTMAObjectsFiller

dtma.DTMA.DTMA.dTMAObjectsFiller

Definition at line 50 of file DTMA.py.

◆ errorCode

dtma.DTMA.DTMA.errorCode

Definition at line 51 of file DTMA.py.

◆ errorStr

dtma.DTMA.DTMA.errorStr

Definition at line 52 of file DTMA.py.

◆ eventBuilder

dtma.DTMA.DTMA.eventBuilder

Definition at line 49 of file DTMA.py.

◆ label

dtma.DTMA.DTMA.label = CONSTANTS.APP_NAME

static

Definition at line 39 of file DTMA.py.

◆ localConnection

dtma.DTMA.DTMA.localConnection

Definition at line 48 of file DTMA.py.

The documentation for this class was generated from the following file:

sources/hce/dtma/DTMA.py

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ checkAdditionalArgs()

◆ close()

◆ configReader()

◆ connectionInit()

◆ fillError()

◆ generateEmptyResponse()

◆ loadLogConfigFile()

◆ run()

◆ setup()

◆ transportCommunications()

Member Data Documentation

◆ config

◆ connectionBuilder

◆ dTMAObjectsFiller

◆ errorCode

◆ errorStr

◆ eventBuilder

◆ label

◆ localConnection

◆ init()