org.terracotta.modules.ehcache.wan

Class WANUtil

java.lang.Object

org.terracotta.modules.ehcache.wan.WANUtil

public class WANUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
WANUtil(ToolkitInstanceFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addCurrentOrchestrator(String cacheManagerName, String cacheName, String orchestrator)
void	cleanUpCacheMetaData(String cacheManagerName, String cacheName) This method is used by clean-up scripts to clean the Cache status for WAN.
void	clearWANReady(String cacheManagerName) This method clears the WAN meta-data available status for the given cacheManager
boolean	isCacheBidirectional(String cacheManagerName, String cacheName)
boolean	isCacheReplica(String cacheManagerName, String cacheName)
boolean	isWanEnabledCache(String cacheManagerName, String cacheName) This method returns true if the cache is wan-enabled else false.
boolean	isWANReady(String cacheManagerName) This method is used to check whether the WAN meta-data is available or not.
void	markCacheAsBidirectional(String cacheManagerName, String cacheName)
void	markCacheAsMaster(String cacheManagerName, String cacheName)
void	markCacheAsReplica(String cacheManagerName, String cacheName)
void	markCacheAsUnidirectional(String cacheManagerName, String cacheName)
void	markCacheWanDisabled(String cacheManagerName, String cacheName) This method is used by Client to mark the cache as wan-disabled.
void	markCacheWanEnabled(String cacheManagerName, String cacheName) This method is used by Orchestrator to mark the cache as wan-enabled.
void	markWANReady(String cacheManagerName) This method marks that WAN meta-data is available for the given cacheManager
void	waitForOrchestrator(String cacheManagerName) This method is used to wait until the Orchestrator is running.

Methods inherited from class java.lang.Object

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

Constructor Detail

WANUtil

public WANUtil(ToolkitInstanceFactory factory)

Method Detail

markWANReady

public void markWANReady(String cacheManagerName)

This method marks that WAN meta-data is available for the given cacheManager

Parameters:

cacheManagerName - name of the CacheManager

clearWANReady

public void clearWANReady(String cacheManagerName)

This method clears the WAN meta-data available status for the given cacheManager

Parameters:

cacheManagerName - name of the CacheManager

isWANReady

public boolean isWANReady(String cacheManagerName)

This method is used to check whether the WAN meta-data is available or not.

Parameters:

cacheManagerName -

Returns:

true if meta-data is available else false.

waitForOrchestrator

public void waitForOrchestrator(String cacheManagerName)

This method is used to wait until the Orchestrator is running.

Parameters:

cacheManagerName -

markCacheWanEnabled

public void markCacheWanEnabled(String cacheManagerName,
                                String cacheName)

This method is used by Orchestrator to mark the cache as wan-enabled.

Parameters:

cacheManagerName -

cacheName -

Throws:

IllegalConfigurationException - if the cache is already marked as wan disabled

markCacheAsReplica

public void markCacheAsReplica(String cacheManagerName,
                               String cacheName)

markCacheAsMaster

public void markCacheAsMaster(String cacheManagerName,
                              String cacheName)

isCacheReplica

public boolean isCacheReplica(String cacheManagerName,
                              String cacheName)

markCacheAsBidirectional

public void markCacheAsBidirectional(String cacheManagerName,
                                     String cacheName)

markCacheAsUnidirectional

public void markCacheAsUnidirectional(String cacheManagerName,
                                      String cacheName)

addCurrentOrchestrator

public void addCurrentOrchestrator(String cacheManagerName,
                                   String cacheName,
                                   String orchestrator)

isCacheBidirectional

public boolean isCacheBidirectional(String cacheManagerName,
                                    String cacheName)

markCacheWanDisabled

public void markCacheWanDisabled(String cacheManagerName,
                                 String cacheName)

This method is used by Client to mark the cache as wan-disabled.

Parameters:

cacheName -

Throws:

IllegalConfigurationException - if the cache is already marked as wan enabled

isWanEnabledCache

public boolean isWanEnabledCache(String cacheManagerName,
                                 String cacheName)

This method returns true if the cache is wan-enabled else false. This method should only be used by Client and not by the Orchestrator.

Parameters:

cacheManagerName - name of the CacheManager

cacheName - name of the Cache

cleanUpCacheMetaData

public void cleanUpCacheMetaData(String cacheManagerName,
                                 String cacheName)

This method is used by clean-up scripts to clean the Cache status for WAN.

Parameters:

cacheManagerName - name of the CacheManager

cacheName - name of the Cache