com.atlassian.confluence.cluster.coherence
Class TangosolClusterManager

java.lang.Object
  com.atlassian.confluence.cluster.coherence.TangosolClusterManager

All Implemented Interfaces:

ClusterManager, NameResolver, LockFactory

public class TangosolClusterManager
extends java.lang.Object
implements ClusterManager

Implementation of ClusterManager that uses Tangosol Coherence.

Nested Class Summary

static class	TangosolClusterManager.CacheServices
static class	TangosolClusterManager.RetryOperation<T>

Constructor Summary

TangosolClusterManager(com.atlassian.config.ApplicationConfig applicationConfig, java.lang.ClassLoader applicationClassLoader, SynchronizationManager synchronizationManager)

Method Summary

void	configure(ClusterConfig config) Set a new cluster config but do not cycle the service
static java.util.Collection<com.tangosol.net.CacheService>	enumerateCacheServices() Deprecated. since 3.0, use getCacheServices()
java.util.Collection<ClusterNodeInformation>	getAllNodesInformation()
static TangosolClusterManager.CacheServices	getCacheServices()
ClusteredLock	getClusteredLock(java.lang.String key) Get a distributed lock -- getting the lock does *not* imply that it has been acquired.
ClusterInformation	getClusterInformation() Get information about the running cluster.
ClusterInvariants	getClusterInvariants() Get all attributes of the server that must be consistent between cluster nodes.
<T> com.atlassian.core.task.FifoBuffer<T>	getFifoBuffer(java.lang.String name) Get a distributed FIFO buffer
Lock	getLock(java.lang.String key) Get a lock -- getting the lock does *not* imply that it has been acquired.
java.util.Map<java.lang.Integer,NodeStatus>	getNodeStatuses() Gets status information from all members of the cluster.
java.util.Map	getNodeStatusesForCluster()
int	getPermittedClusterNodes()
java.io.Serializable	getPublishedObject(java.lang.String key) Retrieve an object which another node in the cluster has shared, return null if no such object exists
ClusterNodeInformation	getThisNodeInformation() Get the identity of this node in the cluster.
void	init() Start the Invocation Service to listen for invocations (@see EventInvocable) from other nodes in the cluster.
boolean	isClustered()
boolean	isClusterSupported() Check whether this Confluence distribution is capable of running in a cluster.
boolean	isConfigured()
void	publishEvent(ConfluenceEvent event) Publish an event as a ClusterEventWrapper to other nodes
void	publishObject(java.lang.String key, java.io.Serializable object) Share an object to the cluster under a particular key.
void	reconfigure(ClusterConfig config) Bootstrap a new cluster configuration.
protected void	registerClusterMemberEventLogger()
java.net.InetAddress	resolveName(java.lang.String name) Use this manager to resolve a cluster name to an IP address
void	shutdown()
void	startCluster() Start the clustering service
void	stopCluster() Stop the clustering service

Methods inherited from class java.lang.Object

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

Constructor Detail

TangosolClusterManager

public TangosolClusterManager(com.atlassian.config.ApplicationConfig applicationConfig,
                              java.lang.ClassLoader applicationClassLoader,
                              SynchronizationManager synchronizationManager)

Method Detail

enumerateCacheServices

@Deprecated
public static java.util.Collection<com.tangosol.net.CacheService> enumerateCacheServices()

Deprecated. since 3.0, use getCacheServices()

Returns:

A collection of cache services running in the cluster

getCacheServices

public static TangosolClusterManager.CacheServices getCacheServices()

init

public void init()

Start the Invocation Service to listen for invocations (@see EventInvocable) from other nodes in the cluster.

shutdown

public void shutdown()

registerClusterMemberEventLogger

protected void registerClusterMemberEventLogger()

isClusterSupported

public boolean isClusterSupported()

Description copied from interface: ClusterManager

Check whether this Confluence distribution is capable of running in a cluster. This differs from ClusterManager.isClustered() in that it will return true if the code to support clustering is present, even if this instance does not have a clustered license or a current clustering configuration.

Specified by:

isClusterSupported in interface ClusterManager

Returns:

true if this Confluence installation is capable of running in a cluster

publishObject

public void publishObject(java.lang.String key,
                          java.io.Serializable object)

Description copied from interface: ClusterManager

Share an object to the cluster under a particular key. Note that once an object is published it will remain available for the duration of the cluster.

Specified by:

publishObject in interface ClusterManager

getPublishedObject

public java.io.Serializable getPublishedObject(java.lang.String key)

Description copied from interface: ClusterManager

Retrieve an object which another node in the cluster has shared, return null if no such object exists

Specified by:

getPublishedObject in interface ClusterManager

Returns:

a shared Object

isClustered

public boolean isClustered()

Specified by:

isClustered in interface ClusterManager

Returns:

true if this instance is configured to allow clustering with other nodes

getPermittedClusterNodes

public int getPermittedClusterNodes()

Specified by:

getPermittedClusterNodes in interface ClusterManager

Returns:

the number of clustered nodes permitted by the license. Returns a value less than or equal to zero if clustering is not permitted.

getClusterInformation

public ClusterInformation getClusterInformation()

Description copied from interface: ClusterManager

Get information about the running cluster.

Specified by:

getClusterInformation in interface ClusterManager

getLock

public Lock getLock(java.lang.String key)

Description copied from interface: LockFactory

Get a lock -- getting the lock does *not* imply that it has been acquired. Call Lock.tryLock() or Lock.lock() on the returned object to acquire the lock.

Specified by:

getLock in interface LockFactory

getClusteredLock

public ClusteredLock getClusteredLock(java.lang.String key)

Description copied from interface: ClusterManager

Get a distributed lock -- getting the lock does *not* imply that it has been acquired. Call Lock.tryLock() or Lock.lock() on the returned object to acquire the lock.

Specified by:

getClusteredLock in interface ClusterManager

getFifoBuffer

public <T> com.atlassian.core.task.FifoBuffer<T> getFifoBuffer(java.lang.String name)

Description copied from interface: ClusterManager

Get a distributed FIFO buffer

Specified by:

getFifoBuffer in interface ClusterManager

publishEvent

public void publishEvent(ConfluenceEvent event)

Description copied from interface: ClusterManager

Publish an event as a ClusterEventWrapper to other nodes

Specified by:

publishEvent in interface ClusterManager

getNodeStatuses

public java.util.Map<java.lang.Integer,NodeStatus> getNodeStatuses()

Description copied from interface: ClusterManager

Gets status information from all members of the cluster.

Specified by:

getNodeStatuses in interface ClusterManager

Returns:

a map of node IDs to node statuses

getThisNodeInformation

public ClusterNodeInformation getThisNodeInformation()

Description copied from interface: ClusterManager

Get the identity of this node in the cluster. ClusterNodeInformation implements equals().

Specified by:

getThisNodeInformation in interface ClusterManager

Returns:

the identity of this node in the cluster. May return null if the node is not in a cluster.

getAllNodesInformation

public java.util.Collection<ClusterNodeInformation> getAllNodesInformation()

Specified by:

getAllNodesInformation in interface ClusterManager

stopCluster

public void stopCluster()

Description copied from interface: ClusterManager

Stop the clustering service

Specified by:

stopCluster in interface ClusterManager

startCluster

public void startCluster()

Description copied from interface: ClusterManager

Start the clustering service

Specified by:

startCluster in interface ClusterManager

resolveName

public java.net.InetAddress resolveName(java.lang.String name)

Use this manager to resolve a cluster name to an IP address

Specified by:

resolveName in interface NameResolver

Parameters:

name - Name of the cluster

Returns:

Address of the cluster

configure

public void configure(ClusterConfig config)

Set a new cluster config but do not cycle the service

Specified by:

configure in interface ClusterManager

Parameters:

config - Cluster config

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface ClusterManager

Returns:

true if ClusterManager.configure(ClusterConfig) has been called with a valid configuration, otherwise false.

reconfigure

public void reconfigure(ClusterConfig config)

Bootstrap a new cluster configuration. This will cycle the clustering service

Specified by:

reconfigure in interface ClusterManager

Parameters:

config - Cluster config

getClusterInvariants

public ClusterInvariants getClusterInvariants()
                                       throws ClusterException

Description copied from interface: ClusterManager

Get all attributes of the server that must be consistent between cluster nodes. They are to be retrieved from another member in the cluster. If there are no other members currently active in the cluster, then return null.

Specified by:

getClusterInvariants in interface ClusterManager

Returns:

the cluster invariants of this server

Throws:

ClusterException - if the invariants can not be gathered for some reason

getNodeStatusesForCluster

public java.util.Map getNodeStatusesForCluster()

Specified by:

getNodeStatusesForCluster in interface ClusterManager