org.norther.tammi.core.cache
Class DefaultCacheClient

java.lang.Object
  org.norther.tammi.core.base.Adaptee
      org.norther.tammi.core.cache.DefaultCacheClient

All Implemented Interfaces:

Serializable, EventListener, NotificationBroadcaster, NotificationEmitter, NotificationListener, Manageable, MBeanDelegate, Refreshable, CacheClient

Direct Known Subclasses:

DefaultKeyCacheClient

public class DefaultCacheClient
extends Adaptee
implements CacheClient, NotificationListener

A default implementation of CacheClient.

Author:

Ilkka Priha

See Also:

Serialized Form

Field Summary

Fields inherited from class org.norther.tammi.core.base.Adaptee

ADAPTEE_NOTIF_DESCRIPTION, ADAPTEE_NOTIFICATIONS

Fields inherited from interface org.norther.tammi.core.base.MBeanDelegate

ARRAY_TYPE, OBJECT_TYPE, PRIMITIVE_TYPE, STRING_TYPE

Constructor Summary

DefaultCacheClient()
Constructs a new client.

DefaultCacheClient(ObjectName client)
Constructs a new named client.

Method Summary

void	clearCached() Clears all cached entries without notifying.
void	expireCached(long timestamp) Expires all cached entries notifying them about expiration.
void	expireFraction(long timestamp, float fraction) Expires the specified fraction of cached entries notifying them about expiration.
ConcurrentMap	getCache(boolean create) Gets and optionally creates the cache.
protected CachedMap	getClientCache(boolean create) Gets the client cache.
long	getExpired() Gets the last expire timestamp.
long	getRefreshed() Gets the last refresh timestamp.
protected SharedCache	getSharedCache() Gets the referent of the shared cache MBean.
void	handleNotification(Notification notif, Object handback) Handle domain cache removals.
boolean	isCachingDisabled() Checks whether the caching is disabled.
void	postmanaged() This method is called when the implementing adaptee has been managed either during post-registration of the corresponding adapter MBean or just after it is explicitly added to the adapter MBean during run-time.
void	refresh() Refreshes the MBean.
void	removeCache() Removes the cache.
void	setCachingDisabled(boolean flag) Sets the caching disabled flag.
void	unmanaged() This method is called when the implementing adaptee is unmanaged either during pre-deregistration of the corresponding adapter MBean or just before it is explicitly removed from the adapter MBean during run-time.

Methods inherited from class org.norther.tammi.core.base.Adaptee

addAdaptee, addNotificationListener, getAttributeSupport, getBroker, getCanonicalName, getDomain, getFactory, getLoader, getLog, getLog, getMBean, getMBeanServer, getNotificationInfo, getObjectName, getRegistrationTime, getSequenceNumber, hasListeners, isRegistered, premanaged, removeNotificationListener, removeNotificationListener, sendNotification, sendNotification, sendNotification, sendNotification, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheClient

public DefaultCacheClient()

Constructs a new client.

DefaultCacheClient

public DefaultCacheClient(ObjectName client)

Constructs a new named client.

Parameters:

client - the client name.

Method Detail

postmanaged

public void postmanaged()

Description copied from interface: Manageable

This method is called when the implementing adaptee has been managed either during post-registration of the corresponding adapter MBean or just after it is explicitly added to the adapter MBean during run-time.

Specified by:

postmanaged in interface Manageable

Overrides:

postmanaged in class Adaptee

unmanaged

public void unmanaged()
               throws Exception

Description copied from interface: Manageable

This method is called when the implementing adaptee is unmanaged either during pre-deregistration of the corresponding adapter MBean or just before it is explicitly removed from the adapter MBean during run-time.

Specified by:

unmanaged in interface Manageable

Overrides:

unmanaged in class Adaptee

Throws:

Exception - if the adaptee refused to be unmanaged.

isCachingDisabled

public boolean isCachingDisabled()

Description copied from interface: CacheClient

Checks whether the caching is disabled.

Specified by:

isCachingDisabled in interface CacheClient

Returns:

true if the caching is disabled, true otherwise.

setCachingDisabled

public void setCachingDisabled(boolean flag)

Description copied from interface: CacheClient

Sets the caching disabled flag.

Specified by:

setCachingDisabled in interface CacheClient

Parameters:

flag - the caching disabled flag.

expireCached

public void expireCached(long timestamp)

Description copied from interface: CacheClient

Expires all cached entries notifying them about expiration.

Specified by:

expireCached in interface CacheClient

Parameters:

timestamp - the timestamp of the expiration.

expireFraction

public void expireFraction(long timestamp,
                           float fraction)

Description copied from interface: CacheClient

Expires the specified fraction of cached entries notifying them about expiration.

Specified by:

expireFraction in interface CacheClient

Parameters:

timestamp - the timestamp of the expiration.

fraction - the fraction of entries to expire (0.0..1.0).

clearCached

public void clearCached()

Description copied from interface: CacheClient

Clears all cached entries without notifying.

Specified by:

clearCached in interface CacheClient

getCache

public ConcurrentMap getCache(boolean create)

Description copied from interface: CacheClient

Gets and optionally creates the cache.

Specified by:

getCache in interface CacheClient

Parameters:

create - true to create a missing cache.

Returns:

the cache or null if disabled.

removeCache

public void removeCache()

Description copied from interface: CacheClient

Removes the cache.

Specified by:

removeCache in interface CacheClient

refresh

public void refresh()

Description copied from interface: Refreshable

Refreshes the MBean.

Specified by:

refresh in interface Refreshable

getRefreshed

public long getRefreshed()

Description copied from interface: Refreshable

Gets the last refresh timestamp.

Specified by:

getRefreshed in interface Refreshable

Returns:

the timestamp of the last refresh.

getExpired

public long getExpired()

Gets the last expire timestamp.

Returns:

the timestamp of the last expire.

handleNotification

public void handleNotification(Notification notif,
                               Object handback)

Handle domain cache removals.

Specified by:

handleNotification in interface NotificationListener

Parameters:

notif - the notification.

handback - not used.

getSharedCache

protected SharedCache getSharedCache()

Gets the referent of the shared cache MBean.

Returns:

the referent of the client cache MBean or null.

getClientCache

protected CachedMap getClientCache(boolean create)

Gets the client cache.

Parameters:

create - true to create a missing cache.

Returns:

the cache for the specified key or null.