psdi.mbo

Class MaxMessageCache

java.lang.Object

psdi.mbo.MaxMessageCache

All Implemented Interfaces:

MaximoCache, FixedLoggerNames, FixedLoggers

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

The maximo cache to store the max messages and their multi-language texts. The cache is loaded by group and language code on demand.

Author:

wang To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
MaxMessageCache()

Method Summary

Methods

Modifier and Type	Method and Description
MaxMessage	getMaxMessage(java.lang.String group, java.lang.String key) Get the MaxMessage object in base language.
MaxMessage	getMaxMessage(java.lang.String group, java.lang.String key, java.lang.String langCode) Get the message for group,key and language
MaxMessage	getMaxMessage(java.lang.String group, java.lang.String key, UserInfo ui) Get the MaxMessage object in the language specified in the userinfo.
Message	getMessage(java.lang.String group, java.lang.String key) Get the psdi.util.Message of the base language.
Message	getMessage(java.lang.String group, java.lang.String key, UserInfo ui) Get the psdi.util.Message object of the message specified by the group, key, in the language of the user info.
java.lang.String	getName() Returns the name of the cache object MAXMESSAGECACHE.
static Message	getTaggedMessage(MaxMessage mmsg)
static Message	getTaggedMessage(MaxMessageBase mmsg)
Message	getTaggedMessage(java.lang.String group, java.lang.String key) Called from MXException This message will tag the group and key information also Get the psdi.util.Message of the base language.
Message	getTaggedMessage(java.lang.String group, java.lang.String key, java.lang.String langCode) Get the message for the group,key and language
Message	getTaggedMessage(java.lang.String group, java.lang.String key, UserInfo ui) Called from MXException This message will tag the group and key information also Get the psdi.util.Message object of the message specified by the group, key, in the language of the user info.
void	init() Initialize the cache object.
boolean	isMsgBundleLoaded(java.lang.String msgGroup, java.lang.String langCode) Returns true if the message group has already loaded for the language specified in the userinfo.
void	loadMsgGroup(java.lang.String group, UserInfo ui) Load the entire message group to the cache for the language specified in the userInfo.
void	reload() Reloads the cache object.
void	reload(java.lang.String hashKey) Initialize a specific component of the cache identified by the key.
void	reload(java.lang.String group, java.lang.String key, java.lang.String langCode) Reload a specific message in a particular language.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxMessageCache

public MaxMessageCache()

Method Detail

init

public void init()
          throws MXException

Initialize the cache object. This will be called by the app server on startup.

Specified by:

init in interface MaximoCache

Throws:

MXException

reload

public void reload()
            throws MXException

Reloads the cache object. It simply clears everything in the cache. The value then will be reloaded on demand. This will be called by the app server whenever the cache needs to be refreshed.

Specified by:

reload in interface MaximoCache

Throws:

MXException

reload

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

Initialize a specific component of the cache identified by the key. If the key is composed as message group and message key seperated by a bar "|", the already loaded message of all languages will be reloaded. If the key is only one string. It will be interpruted as the group name, then everything of this group in all languages will be unloaded. The messages of the group will be loaded on demand when requested. If nothing was loaded when the reload request is issued, the messages will remain unloaded until a request to reference a message of the group is issued.

Specified by:

reload in interface MaximoCache

Parameters:

key - group|key or group only if there is no bar in the string

Throws:

MXException

reload

public void reload(java.lang.String group,
          java.lang.String key,
          java.lang.String langCode)
            throws MXException,
                   java.rmi.RemoteException

Reload a specific message in a particular language. A query will be made the the database for this message and the information will be re-cached.

Parameters:

group - message group

key - message key

langCode - language code

Throws:

MXException

java.rmi.RemoteException

getName

public java.lang.String getName()

Returns the name of the cache object MAXMESSAGECACHE.

Specified by:

getName in interface MaximoCache

Returns:

getMaxMessage

public MaxMessage getMaxMessage(java.lang.String group,
                       java.lang.String key,
                       UserInfo ui)
                         throws MXException,
                                java.rmi.RemoteException

Get the MaxMessage object in the language specified in the userinfo.

Parameters:

bundle -

key -

ui -

Returns:

Throws:

MXException

java.rmi.RemoteException

getMaxMessage

public MaxMessage getMaxMessage(java.lang.String group,
                       java.lang.String key,
                       java.lang.String langCode)
                         throws MXException,
                                java.rmi.RemoteException

Get the message for group,key and language

Parameters:

group -

key -

langCode -

Returns:

Message

Throws:

MXException

java.rmi.RemoteException

getMessage

public Message getMessage(java.lang.String group,
                 java.lang.String key,
                 UserInfo ui)
                   throws MXException,
                          java.rmi.RemoteException

Get the psdi.util.Message object of the message specified by the group, key, in the language of the user info.

Parameters:

group -

key -

ui -

Returns:

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

public Message getTaggedMessage(java.lang.String group,
                       java.lang.String key,
                       UserInfo ui)
                         throws MXException,
                                java.rmi.RemoteException

Called from MXException This message will tag the group and key information also Get the psdi.util.Message object of the message specified by the group, key, in the language of the user info.

Parameters:

group -

key -

ui -

Returns:

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

public Message getTaggedMessage(java.lang.String group,
                       java.lang.String key,
                       java.lang.String langCode)
                         throws MXException,
                                java.rmi.RemoteException

Get the message for the group,key and language

Parameters:

group -

key -

langCode -

Returns:

Message

Throws:

MXException

java.rmi.RemoteException

getMaxMessage

public MaxMessage getMaxMessage(java.lang.String group,
                       java.lang.String key)
                         throws MXException,
                                java.rmi.RemoteException

Get the MaxMessage object in base language.

Parameters:

bundle -

key -

Returns:

Throws:

MXException

java.rmi.RemoteException

getMessage

public Message getMessage(java.lang.String group,
                 java.lang.String key)
                   throws MXException,
                          java.rmi.RemoteException

Get the psdi.util.Message of the base language.

Parameters:

group -

key -

Returns:

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

public Message getTaggedMessage(java.lang.String group,
                       java.lang.String key)
                         throws MXException,
                                java.rmi.RemoteException

Called from MXException This message will tag the group and key information also Get the psdi.util.Message of the base language.

Parameters:

group -

key -

Returns:

Throws:

MXException

java.rmi.RemoteException

getTaggedMessage

public static Message getTaggedMessage(MaxMessage mmsg)

getTaggedMessage

public static Message getTaggedMessage(MaxMessageBase mmsg)

loadMsgGroup

public void loadMsgGroup(java.lang.String group,
                UserInfo ui)
                  throws MXException,
                         java.rmi.RemoteException

Load the entire message group to the cache for the language specified in the userInfo.

Parameters:

ui -

Throws:

MXException

java.rmi.RemoteException

isMsgBundleLoaded

public boolean isMsgBundleLoaded(java.lang.String msgGroup,
                        java.lang.String langCode)

Returns true if the message group has already loaded for the language specified in the userinfo.

Parameters:

ui -

Returns: