com.ibm.tivoli.maximo.oslc.consumer

Class OslcInteractionCache

java.lang.Object

com.ibm.tivoli.maximo.oslc.consumer.OslcInteractionCache

All Implemented Interfaces:

MaximoCache, MaximoMTEnabledCache

public class OslcInteractionCache
extends java.lang.Object
implements MaximoMTEnabledCache

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Map<java.lang.String,OslcInteractionInfo>>	getAllInteractions()
java.util.Map<java.lang.String,OslcInteractionInfo>	getAllInteractionsForProvider(java.lang.String oslcProviderName)
MaximoCache	getCache() Return the maximo cache instance.
static OslcInteractionCache	getInstance()
OslcInteractionInfo	getInteraction(java.lang.String interactionName, java.lang.String oslcProviderName)
OslcInteractionInfo	getInteractionInfo(java.lang.String oslcProviderName, java.lang.String interactionName)
java.lang.String	getName() Returns the name of the cache object.
void	init() Initialize the cache object.
boolean	isLoaded()
void	reload() Reloads the cache object.
void	reload(java.lang.String key) Initialize a specific component of the cache identified by the key.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static final OslcInteractionCache getInstance()

Returns:

the cache instance

getInteraction

public OslcInteractionInfo getInteraction(java.lang.String interactionName,
                                 java.lang.String oslcProviderName)

init

public void init()
          throws MXException

Description copied from interface: MaximoCache

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

Specified by:

init in interface MaximoCache

Throws:

MXException

getAllInteractions

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

getAllInteractionsForProvider

public java.util.Map<java.lang.String,OslcInteractionInfo> getAllInteractionsForProvider(java.lang.String oslcProviderName)

getInteractionInfo

public OslcInteractionInfo getInteractionInfo(java.lang.String oslcProviderName,
                                     java.lang.String interactionName)

reload

public void reload()
            throws MXException

Description copied from interface: MaximoCache

Reloads the cache object. This will be called by the app server whenever the cache needs to be refreshed. Don't call this method directly. Instead call MXServer.reloadCache(String, boolean).

Specified by:

reload in interface MaximoCache

Throws:

MXException

reload

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

Description copied from interface: MaximoCache

Initialize a specific component of the cache identified by the key. E.g. In Maxvars, a specific maxvar can be reinitiliazed from the database. Don't call this method directly. Instead call MXServer.reloadCache(String, String, boolean).

Specified by:

reload in interface MaximoCache

Throws:

MXException

getName

public java.lang.String getName()

Description copied from interface: MaximoCache

Returns the name of the cache object. Should be unique within the app server. This name is used to uniquely identify the cache object among all cached object for both accessing the cache object as well as refreshing the cache object. Ex. MaximoDD returns "MAXIMODD"

Specified by:

getName in interface MaximoCache

Returns:

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