psdi.iface.mic

Class PublishChannelCache

java.lang.Object

psdi.iface.mic.PublishChannelCache

All Implemented Interfaces:

MaximoCache, MaximoMTEnabledCache

public class PublishChannelCache
extends java.lang.Object
implements MaximoMTEnabledCache

Author:

Anamitra

Method Summary

Methods

Modifier and Type	Method and Description
MaximoCache	getCache() Return the maximo cache instance.
java.util.List<java.lang.String>	getChannelsForIfaceTb(java.lang.String ifacetbName)
static PublishChannelCache	getInstance()
java.lang.String	getName() Returns the name of the cache object.
PublishChannel	getPublishChannel(java.lang.String pubChannelName)
java.util.Map<java.lang.String,PublishChannel>	getPublishChannelMap()
PublishInfo	getPublishInfo(java.lang.String pubChannelName)
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.
void	unregisterAllListeners()
void	unregisterListeners(java.lang.String pubChannelName)

Methods inherited from class java.lang.Object

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

Method Detail

getPublishInfo

public PublishInfo getPublishInfo(java.lang.String pubChannelName)

Parameters:

pubChannelName -

Returns:

the PublishInfo object for the pubChannelName

getChannelsForIfaceTb

public java.util.List<java.lang.String> getChannelsForIfaceTb(java.lang.String ifacetbName)

Parameters:

ifacetbName - the interface table name

Returns:

the list of channel names

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. 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 key)
            throws MXException

Initialize a specific component of the cache identified by the key. E.g. In Maxvars, a specific maxvar can be reinitiliazed from the database.

Specified by:

reload in interface MaximoCache

Parameters:

key -

Throws:

MXException

getName

public java.lang.String getName()

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:

name of the cache

getInstance

public static final PublishChannelCache getInstance()

Returns:

the cache instance

getPublishChannel

public PublishChannel getPublishChannel(java.lang.String pubChannelName)

Parameters:

pubChannelName -

Returns:

the channel for the pubChannelName

getPublishChannelMap

public java.util.Map<java.lang.String,PublishChannel> getPublishChannelMap()

Returns:

the Map of channels

unregisterAllListeners

public void unregisterAllListeners()
                            throws MXException

Throws:

MXException

unregisterListeners

public void unregisterListeners(java.lang.String pubChannelName)
                         throws MXException

Parameters:

pubChannelName -

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