com.ibm.tivoli.maximo.interaction.process

Class InteractionCache

java.lang.Object

com.ibm.tivoli.maximo.interaction.process.InteractionCache

All Implemented Interfaces:

MaximoCache, MaximoMTEnabledCache

public class InteractionCache
extends java.lang.Object
implements MaximoMTEnabledCache

Loads information from MAXINTERACTION, MAXINTMAPPING, MAXINTMAPPINGDETAIL tables

Version:

1.0

Author:

Boris Dozortsev

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,InteractionInfo>	getAllInteractions() Get all the defined interactions InteractionInfo objects
MaximoCache	getCache() Return the maximo cache instance.
static InteractionCache	getInstance() Always use one instance of InteractionCache
InteractionInfo	getInteractionInfo(java.lang.String name) Get the InteractionInfo object
InteractionInfo	getInteractionInfo(java.lang.String sigoption, java.lang.String appname) Get the InteractionInfo object for SigOption name and Application Name
InteractionInfo	getInteractionInfo(java.lang.String mainObjectName, java.lang.String relation, java.lang.String topObject) Get the InteractionInfo object for Request Relation, Name of Main object for request and Application Main Object Name
java.lang.String	getName() Returns the name as registered in Maximo Cache
void	init() Initialize the EndPointCache
boolean	isLoaded()
void	reload() Refresh the EndPointCache
void	reload(java.lang.String key) Reload a paricular key in memory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static InteractionCache getInstance()
                                    throws MXException

Always use one instance of InteractionCache

Throws:

MXException - MAXIMO exception

init

public void init()
          throws MXException

Initialize the EndPointCache

Specified by:

init in interface MaximoCache

Throws:

MXException - Maximo Exception

reload

public void reload()
            throws MXException

Refresh the EndPointCache

Specified by:

reload in interface MaximoCache

Throws:

MXException - Maximo Exception

reload

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

Reload a paricular key in memory. Not implemented (exists only for compilation sake)

Specified by:

reload in interface MaximoCache

Parameters:

key - to reload

Throws:

MXException - Maximo Exception

getName

public java.lang.String getName()

Returns the name as registered in Maximo Cache

Specified by:

getName in interface MaximoCache

Returns:

MAXENDPOINT

getAllInteractions

public java.util.Map<java.lang.String,InteractionInfo> getAllInteractions()

Get all the defined interactions InteractionInfo objects

Returns:

map of all the defined interactions

getInteractionInfo

public InteractionInfo getInteractionInfo(java.lang.String name)

Get the InteractionInfo object

Parameters:

name - interaction name

Returns:

InteractionInfo object

getInteractionInfo

public InteractionInfo getInteractionInfo(java.lang.String sigoption,
                                 java.lang.String appname)

Get the InteractionInfo object for SigOption name and Application Name

Parameters:

sigoption - signature option name

appname - application name

Returns:

InteractionInfo object

getInteractionInfo

public InteractionInfo getInteractionInfo(java.lang.String mainObjectName,
                                 java.lang.String relation,
                                 java.lang.String topObject)
                                   throws MXException

Get the InteractionInfo object for Request Relation, Name of Main object for request and Application Main Object Name

Parameters:

mainObjectName - interaction main object name

relation - request relation name

topObject - name of top MBo in request OS

Returns:

InteractionInfo object

Throws:

MXException

getCache

public MaximoCache getCache()

Description copied from interface: MaximoMTEnabledCache

Return the maximo cache instance. This method is called to obtain the cache object. In multi-tenancy enviroment, if the cache is specific to the tenant, this method should return the cache instance based on the tenant id of the context. In non-multi-tenant environment, or the cache is not tenant specific, then it returns to the one cache object.

Specified by:

getCache in interface MaximoMTEnabledCache

Returns:

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface MaximoMTEnabledCache