com.liferay.portal.cache

Class BasePortalCacheManager<K extends java.io.Serializable,V>

java.lang.Object

com.liferay.portal.cache.BasePortalCacheManager<K,V>

All Implemented Interfaces:

PortalCacheManager<K,V>

Direct Known Subclasses:

TestPortalCacheManager

public abstract class BasePortalCacheManager<K extends java.io.Serializable,V>
extends java.lang.Object
implements PortalCacheManager<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregatedPortalCacheManagerListener	aggregatedPortalCacheManagerListener
protected PortalCacheListenerFactory	portalCacheListenerFactory
protected PortalCacheManagerListenerFactory<PortalCacheManager<K,V>>	portalCacheManagerListenerFactory
protected java.util.concurrent.ConcurrentMap<java.lang.String,PortalCache<K,V>>	portalCaches

Fields inherited from interface com.liferay.portal.kernel.cache.PortalCacheManager

PORTAL_CACHE_MANAGER_NAME, PORTAL_CACHE_MANAGER_TYPE

Constructor Summary

Constructors

Constructor and Description
BasePortalCacheManager()

Method Summary

Modifier and Type	Method and Description
void	clearAll()
protected abstract PortalCache<K,V>	createPortalCache(PortalCacheConfiguration portalCacheConfiguration)
void	destroy()
protected abstract void	doClearAll()
protected abstract void	doDestroy()
protected abstract void	doRemovePortalCache(java.lang.String portalCacheName)
PortalCache<K,V>	fetchPortalCache(java.lang.String portalCacheName)
PortalCache<K,V>	getPortalCache(java.lang.String portalCacheName)
PortalCache<K,V>	getPortalCache(java.lang.String portalCacheName, boolean blocking) Deprecated. As of Athanasius (7.3.x), replaced by getPortalCache(String)
PortalCache<K,V>	getPortalCache(java.lang.String portalCacheName, boolean blocking, boolean mvcc)
protected abstract PortalCacheManagerConfiguration	getPortalCacheManagerConfiguration()
java.util.Set<PortalCacheManagerListener>	getPortalCacheManagerListeners()
java.lang.String	getPortalCacheManagerName()
java.lang.String[]	getTransactionalPortalCacheNames()
protected void	initialize()
protected abstract void	initPortalCacheManager()
boolean	isBlockingPortalCacheAllowed() Deprecated. As of Athanasius (7.3.x), with no direct replacement
boolean	isClusterAware()
protected boolean	isTransactionalPortalCache(java.lang.String portalCacheName)
boolean	isTransactionalPortalCacheEnabled()
protected void	reconfigPortalCache(PortalCacheManagerConfiguration portalCacheManagerConfiguration)
boolean	registerPortalCacheManagerListener(PortalCacheManagerListener portalCacheManagerListener)
protected abstract void	removeConfigurableEhcachePortalCacheListeners(PortalCache<K,V> portalCache)
void	removePortalCache(java.lang.String portalCacheName)
void	setBlockingPortalCacheAllowed(boolean blockingPortalCacheAllowed) Deprecated. As of Athanasius (7.3.x), with no direct replacement
void	setClusterAware(boolean clusterAware)
void	setMpiOnly(boolean mpiOnly) Deprecated. As of Athanasius (7.3.x), with no direct replacement
void	setPortalCacheManagerName(java.lang.String portalCacheManagerName)
void	setTransactionalPortalCacheEnabled(boolean transactionalPortalCacheEnabled)
void	setTransactionalPortalCacheNames(java.lang.String[] transactionalPortalCacheNames)
boolean	unregisterPortalCacheManagerListener(PortalCacheManagerListener portalCacheManagerListener)
void	unregisterPortalCacheManagerListeners()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.cache.PortalCacheManager

reconfigurePortalCaches, reconfigurePortalCaches

Field Detail

aggregatedPortalCacheManagerListener

protected final AggregatedPortalCacheManagerListener aggregatedPortalCacheManagerListener

portalCacheListenerFactory

protected PortalCacheListenerFactory portalCacheListenerFactory

portalCacheManagerListenerFactory

protected PortalCacheManagerListenerFactory<PortalCacheManager<K extends java.io.Serializable,V>> portalCacheManagerListenerFactory

portalCaches

protected final java.util.concurrent.ConcurrentMap<java.lang.String,PortalCache<K extends java.io.Serializable,V>> portalCaches

Constructor Detail

BasePortalCacheManager

public BasePortalCacheManager()

Method Detail

clearAll

public void clearAll()
              throws PortalCacheException

Specified by:

clearAll in interface PortalCacheManager<K extends java.io.Serializable,V>

Throws:

PortalCacheException

destroy

public void destroy()

Specified by:

destroy in interface PortalCacheManager<K extends java.io.Serializable,V>

fetchPortalCache

public PortalCache<K,V> fetchPortalCache(java.lang.String portalCacheName)

Specified by:

fetchPortalCache in interface PortalCacheManager<K extends java.io.Serializable,V>

getPortalCache

public PortalCache<K,V> getPortalCache(java.lang.String portalCacheName)
                                throws PortalCacheException

Specified by:

getPortalCache in interface PortalCacheManager<K extends java.io.Serializable,V>

Throws:

PortalCacheException

getPortalCache

@Deprecated
public PortalCache<K,V> getPortalCache(java.lang.String portalCacheName,
                                                   boolean blocking)
                                            throws PortalCacheException

Deprecated. As of Athanasius (7.3.x), replaced by getPortalCache(String)

Specified by:

getPortalCache in interface PortalCacheManager<K extends java.io.Serializable,V>

Throws:

PortalCacheException

getPortalCache

public PortalCache<K,V> getPortalCache(java.lang.String portalCacheName,
                                       boolean blocking,
                                       boolean mvcc)
                                throws PortalCacheException

Specified by:

getPortalCache in interface PortalCacheManager<K extends java.io.Serializable,V>

Throws:

PortalCacheException

getPortalCacheManagerListeners

public java.util.Set<PortalCacheManagerListener> getPortalCacheManagerListeners()

Specified by:

getPortalCacheManagerListeners in interface PortalCacheManager<K extends java.io.Serializable,V>

getPortalCacheManagerName

public java.lang.String getPortalCacheManagerName()

Specified by:

getPortalCacheManagerName in interface PortalCacheManager<K extends java.io.Serializable,V>

getTransactionalPortalCacheNames

public java.lang.String[] getTransactionalPortalCacheNames()

isBlockingPortalCacheAllowed

@Deprecated
public boolean isBlockingPortalCacheAllowed()

Deprecated. As of Athanasius (7.3.x), with no direct replacement

isClusterAware

public boolean isClusterAware()

Specified by:

isClusterAware in interface PortalCacheManager<K extends java.io.Serializable,V>

isTransactionalPortalCacheEnabled

public boolean isTransactionalPortalCacheEnabled()

registerPortalCacheManagerListener

public boolean registerPortalCacheManagerListener(PortalCacheManagerListener portalCacheManagerListener)

Specified by:

registerPortalCacheManagerListener in interface PortalCacheManager<K extends java.io.Serializable,V>

removePortalCache

public void removePortalCache(java.lang.String portalCacheName)

Specified by:

removePortalCache in interface PortalCacheManager<K extends java.io.Serializable,V>

setBlockingPortalCacheAllowed

@Deprecated
public void setBlockingPortalCacheAllowed(boolean blockingPortalCacheAllowed)

Deprecated. As of Athanasius (7.3.x), with no direct replacement

setClusterAware

public void setClusterAware(boolean clusterAware)

setMpiOnly

@Deprecated
public void setMpiOnly(boolean mpiOnly)

Deprecated. As of Athanasius (7.3.x), with no direct replacement

setPortalCacheManagerName

public void setPortalCacheManagerName(java.lang.String portalCacheManagerName)

setTransactionalPortalCacheEnabled

public void setTransactionalPortalCacheEnabled(boolean transactionalPortalCacheEnabled)

setTransactionalPortalCacheNames

public void setTransactionalPortalCacheNames(java.lang.String[] transactionalPortalCacheNames)

unregisterPortalCacheManagerListener

public boolean unregisterPortalCacheManagerListener(PortalCacheManagerListener portalCacheManagerListener)

Specified by:

unregisterPortalCacheManagerListener in interface PortalCacheManager<K extends java.io.Serializable,V>

unregisterPortalCacheManagerListeners

public void unregisterPortalCacheManagerListeners()

Specified by:

unregisterPortalCacheManagerListeners in interface PortalCacheManager<K extends java.io.Serializable,V>

createPortalCache

protected abstract PortalCache<K,V> createPortalCache(PortalCacheConfiguration portalCacheConfiguration)

doClearAll

protected abstract void doClearAll()

doDestroy

protected abstract void doDestroy()

doRemovePortalCache

protected abstract void doRemovePortalCache(java.lang.String portalCacheName)

getPortalCacheManagerConfiguration

protected abstract PortalCacheManagerConfiguration getPortalCacheManagerConfiguration()

initialize

protected void initialize()

initPortalCacheManager

protected abstract void initPortalCacheManager()

isTransactionalPortalCache

protected boolean isTransactionalPortalCache(java.lang.String portalCacheName)

reconfigPortalCache

protected void reconfigPortalCache(PortalCacheManagerConfiguration portalCacheManagerConfiguration)

removeConfigurableEhcachePortalCacheListeners

protected abstract void removeConfigurableEhcachePortalCacheListeners(PortalCache<K,V> portalCache)