psdi.app.signature

Class SignatureCache

java.lang.Object

psdi.app.signature.SignatureCache

All Implemented Interfaces:

MaximoCache, FixedLoggerNames, FixedLoggers

public class SignatureCache
extends java.lang.Object
implements MaximoCache, FixedLoggers

Signature cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	appmenuCache Hashtable for maintaining local cache of MaxMenu for menutype APPMENU.
protected java.util.HashMap	appsearchCache Hashtable for maintaining local cache of MaxMenu for menutype SEARCHMENU.
protected java.util.HashMap	apptoolCache Hashtable for maintaining local cache of MaxMenu for menutype APPTOOL.
protected java.util.Set	authAppCache Set for all application authorize applications for Work centers.
protected java.util.Map	mainNonMobileTbAppCache
protected java.util.Map	mainTbAppCache
protected java.util.HashMap	maxappsCache Hashtable for maintaining local cache of MaxApps.
protected java.util.Map	maxmoduleCache Hashtable for maintaining local cache of MaxModules.
protected java.util.Map	moduleMenuCache HashMap where key = module name and value = TreeMap where key = Integer and value = MaxMenu info.
protected java.util.Map	sigoAppCache Hashtable for maintaining local cache of APPACCESS SigOption.
protected java.util.Map	sigoCache Hashtable for maintaining local cache of OPTION SigOption.
protected java.util.Map	sigoFlagCache Hashtable for maintaining local cache of SigOptFlag.
protected java.util.HashMap	simpleAppmenuCache Hashtable for maintaining local cache of MaxMenu for menutype MODULE.

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Method Summary

Modifier and Type	Method and Description
java.util.Set	getAuthAppCache()
java.util.Map	getMaxAppsCache() Return maxappsCache.
MaxAppsInfo	getMaxAppsCache(java.lang.String appName) Return the MaxApps info for the app.
java.util.Set	getMaxAppsForTb(java.lang.String mainTbName)
MaxModuleInfo	getMaxModuleCache(java.lang.String moduleName) Return the MaxModules info for the module.
java.util.Map	getModuleMenuCache() Return moduleMenuCache (MaxMenu for menutype MODULE).
java.lang.String	getName() Return SIGNATURE.
java.util.List	getNonMobileMaxAppsForTb(java.lang.String mainTbName)
SigOptionInfo	getSigoAppCache(java.lang.String appName) Return the SigOption info for the app.
java.util.Map	getSigoCache(java.lang.String appName) Return a HashMap of SigOptions (Type OPTION) for the app, where key = optionname and element = SigOption info.
java.util.Map	getSigoFlags(java.lang.String appName, java.lang.String optionName) Return a HashMap of SigOptFlag for the app and optionname.
void	init() Initialize all the cache objects to new and empty, and set loaded = False.
void	init(MXServer mxs) Call init and set mxs.
boolean	isLoaded()
boolean	isValidLicense(java.lang.String appName, java.lang.String optionName, boolean checkSigoption) Return True if this app and option have a valid license, or no license is required.
boolean	isValidOption(java.lang.String appName, java.lang.String optionName) Return True if this app and option exist in SigOption.
void	reload() Reload cache.
void	reload(java.lang.String key) For SignatureCache, does nothing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sigoCache

protected java.util.Map sigoCache

Hashtable for maintaining local cache of OPTION SigOption. Key = app name, element = HashMap of sigoptions for the app where key = optionname, element = SigOption info.

See Also:

SigOption

sigoFlagCache

protected java.util.Map sigoFlagCache

Hashtable for maintaining local cache of SigOptFlag. Key = app name + "|" + option name, element = HashMap of flagname (key) and flag value.

See Also:

SigOptFlag

sigoAppCache

protected java.util.Map sigoAppCache

Hashtable for maintaining local cache of APPACCESS SigOption. Key = app name, element = SigOption info.

See Also:

SigOption

maxappsCache

protected java.util.HashMap maxappsCache

Hashtable for maintaining local cache of MaxApps. Key = app name, element = MaxApps info.

See Also:

MaxApps

maxmoduleCache

protected java.util.Map maxmoduleCache

Hashtable for maintaining local cache of MaxModules. Key = module name, element = MaxModules info.

See Also:

MaxModules

moduleMenuCache

protected java.util.Map moduleMenuCache

HashMap where key = module name and value = TreeMap where key = Integer and value = MaxMenu info. The TreeMap will be in sequence by position, subposition within the module.

See Also:

MaxMenu

appmenuCache

protected java.util.Map appmenuCache

Hashtable for maintaining local cache of MaxMenu for menutype APPMENU. Key = app name, element = TreeMap where key = integer, element = MaxMenu info.

See Also:

MaxMenu

simpleAppmenuCache

protected java.util.HashMap simpleAppmenuCache

Hashtable for maintaining local cache of MaxMenu for menutype MODULE. Key = app name, element = MaxMenu info. This is a somewhat arbitrary cache, as it will contain only one entry per app, while in reality an app can exist in more than one module and thus can have more than one MaxMenu info of this type. This cache is provided for legacy purposes.

See Also:

MaxMenu

apptoolCache

protected java.util.HashMap apptoolCache

Hashtable for maintaining local cache of MaxMenu for menutype APPTOOL. Key = app name, element = TreeMap where key = integer, element = MaxMenu info.

See Also:

MaxMenu

appsearchCache

protected java.util.HashMap appsearchCache

Hashtable for maintaining local cache of MaxMenu for menutype SEARCHMENU. Key = app name, element = TreeMap where key = integer, element = MaxMenu info.

See Also:

MaxMenu

mainTbAppCache

protected java.util.Map mainTbAppCache

mainNonMobileTbAppCache

protected java.util.Map mainNonMobileTbAppCache

authAppCache

protected java.util.Set authAppCache

Set for all application authorize applications for Work centers. Key = app name, element = TreeMap where key = integer, element = MaxMenu info.

See Also:

MaxMenu

Method Detail

init

public void init()
          throws MXException

Initialize all the cache objects to new and empty, and set loaded = False.

Specified by:

init in interface MaximoCache

Throws:

MXException

See Also:

MaximoCache.init()

init

public void init(MXServer mxs)
          throws MXException

Call init and set mxs.

Parameters:

mxs - MXServer

Throws:

MXException

reload

public void reload()
            throws MXException

Reload cache.

Specified by:

reload in interface MaximoCache

Throws:

MXException

See Also:

MaximoCache.reload(), SignatureCache.reloadCache()

reload

public void reload(java.lang.String key)
            throws MXException

For SignatureCache, does nothing.

Specified by:

reload in interface MaximoCache

Throws:

MXException

See Also:

MaximoCache.reload(java.lang.String)

getName

public java.lang.String getName()

Return SIGNATURE.

Specified by:

getName in interface MaximoCache

Returns:

See Also:

MaximoCache.getName()

getSigoCache

public java.util.Map getSigoCache(java.lang.String appName)
                           throws MXException,
                                  java.rmi.RemoteException

Return a HashMap of SigOptions (Type OPTION) for the app, where key = optionname and element = SigOption info.

Parameters:

appName - Application name.

Returns:

Element for this app from sigoCache.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

See Also:

SignatureCache.getSigoCache()

isValidOption

public boolean isValidOption(java.lang.String appName,
                             java.lang.String optionName)
                      throws MXException,
                             java.rmi.RemoteException

Return True if this app and option exist in SigOption.

Parameters:

appName - Application name. The string is case sensitive.

optionName - Option name. The string is case sensitive.

Returns:

True if this is a valid option (i.e., exists in sigoption).

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

isValidLicense

public boolean isValidLicense(java.lang.String appName,
                              java.lang.String optionName,
                              boolean checkSigoption)
                       throws MXException,
                              java.rmi.RemoteException

Return True if this app and option have a valid license, or no license is required.

Parameters:

appName - Application name.

optionName - Option name.

checkSigoption - True if sigoption cache should also be checked; false if we already have the sigoption info.

Returns:

True if this is a valid option and either needs no license or the customer has the license.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

getSigoFlags

public java.util.Map getSigoFlags(java.lang.String appName,
                                  java.lang.String optionName)
                           throws MXException,
                                  java.rmi.RemoteException

Return a HashMap of SigOptFlag for the app and optionname.

Parameters:

appName - Application name.

Returns:

HashMap of sigoptflag for this app and optionname. If there are no flags, this will be empty. Otherwise, key = flagname and value = flag value.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

getSigoAppCache

public SigOptionInfo getSigoAppCache(java.lang.String appName)
                              throws MXException,
                                     java.rmi.RemoteException

Return the SigOption info for the app.

Parameters:

appName - Application name.

Returns:

Element for this app from sigoAppCache.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

getMaxAppsCache

public java.util.Map getMaxAppsCache()
                              throws MXException,
                                     java.rmi.RemoteException

Return maxappsCache.

Returns:

maxappsCache

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

See Also:

SignatureCache.reloadCache()

getMaxAppsForTb

public java.util.Set getMaxAppsForTb(java.lang.String mainTbName)
                              throws MXException,
                                     java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getNonMobileMaxAppsForTb

public java.util.List getNonMobileMaxAppsForTb(java.lang.String mainTbName)
                                        throws MXException,
                                               java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getAuthAppCache

public java.util.Set getAuthAppCache()
                              throws MXException,
                                     java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getMaxAppsCache

public MaxAppsInfo getMaxAppsCache(java.lang.String appName)
                            throws MXException,
                                   java.rmi.RemoteException

Return the MaxApps info for the app.

Parameters:

appName - Application name.

Returns:

Element for this app from maxappsCache.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

See Also:

SignatureCache.getMaxAppsCache()

getMaxModuleCache

public MaxModuleInfo getMaxModuleCache(java.lang.String moduleName)
                                throws MXException,
                                       java.rmi.RemoteException

Return the MaxModules info for the module.

Parameters:

moduleName - Module name.

Returns:

Element for this module from maxmoduleCache.

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

See Also:

SignatureCache.getMaxModuleCache()

getModuleMenuCache

public java.util.Map getModuleMenuCache()
                                 throws MXException,
                                        java.rmi.RemoteException

Return moduleMenuCache (MaxMenu for menutype MODULE).

Returns:

moduleMenuCache

Throws:

MXException - if there is problem loading business object information.

java.rmi.RemoteException

See Also:

SignatureCache.reloadCache()

isLoaded

public boolean isLoaded()