com.atlassian.confluence.cluster.hazelcast

Class HazelcastClusterManager

java.lang.Object

com.atlassian.confluence.cluster.hazelcast.HazelcastClusterManager

All Implemented Interfaces:

com.atlassian.beehive.ClusterLockService, ClusterManager, NameResolver, LockFactory, Supplier<com.hazelcast.core.HazelcastInstance>

@ParametersAreNonnullByDefault
 @Internal
public class HazelcastClusterManager
extends Object
implements ClusterManager, com.atlassian.beehive.ClusterLockService, com.google.common.base.Supplier<com.hazelcast.core.HazelcastInstance>, com.atlassian.util.concurrent.Supplier<com.hazelcast.core.HazelcastInstance>, Supplier<com.hazelcast.core.HazelcastInstance>

Hazelcast implementation of ClusterManager

Since:

5.6

Field Summary

Fields inherited from interface com.atlassian.confluence.cluster.ClusterManager

DEFAULT_EXECUTOR_SVC_NAME

Constructor Summary

Constructors

Constructor and Description

HazelcastClusterManager(com.atlassian.config.ApplicationConfig applicationConfig, ClassLoader classLoader, String configResourceName, SynchronizationManager synchronizationManager, com.atlassian.hazelcast.serialization.OsgiSafeStreamSerializer osgiSafeStreamSerializer, com.hazelcast.core.OutOfMemoryHandler outOfMemoryHandler, io.micrometer.core.instrument.MeterRegistry micrometerRegistry, MBeanServer mbeanServer)

Method Summary

Modifier and Type	Method and Description
void	configure(ClusterConfig clusterConfig) Set a new cluster configuration.
protected com.hazelcast.core.HazelcastInstance	createHazelcastInstance()
com.hazelcast.core.HazelcastInstance	get()
Collection<ClusterNodeInformation>	getAllNodesInformation()
ClusteredLock	getClusteredLock(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 the nodes of a stable cluster.
ClusterMembershipCriteria	getClusterMembershipCriteria() Get all attributes of the server that must be used as criteria when determining whether a new node can join this cluster.
long	getClusterUptime() Gets the amount of time that the cluster has been running.
<T> com.atlassian.core.task.FifoBuffer<T>	getFifoBuffer(String name) Get a distributed FIFO buffer
Lock	getLock(String name) Get a lock -- getting the lock does *not* imply that it has been acquired.
com.atlassian.confluence.cluster.hazelcast.DualLock	getLockForName(@NonNull String key)
Map<Integer,NodeStatus>	getNodeStatuses() Deprecated.
Map<ClusterNodeInformation,NodeStatus>	getNodeStatusMap() Gets status information from all members of the cluster.
Map<ClusterNodeInformation,CompletionStage<NodeStatus>>	getNodeStatusMapAsync() Gets CompletionStage of status information from all members of the cluster.
String	getSharedSecret() Get the value of config property confluence.cluster.authentication.secret from confluence.cfg.xml
ClusterNodeInformation	getThisNodeInformation() Get the identity of this node in the cluster.
void	initOutOfmemoryhandler()
boolean	isClustered()
boolean	isClusterSupported() Check whether this Confluence distribution is capable of running in a cluster.
boolean	isConfigured()
boolean	isNodeAuthEnabled() Get the value of config property confluence.cluster.authentication.enabled from confluence.cfg.xml
void	publishEvent(ConfluenceEvent event) Publish an event as a ClusterEventWrapper to other nodes
void	publishEventImmediately(ConfluenceEvent event) Publish immediately, an event as a ClusterEventWrapper to other nodes
void	reconfigure(ClusterConfig config) Set a new cluster configuration and cycle the service
InetAddress	resolveName(String name)
void	startCluster() Start the clustering service
void	stopCluster() Stop the clustering service
<T> List<ClusterNodeExecution<T>>	submitToAllNodes(Callable<T> task, String serviceName) Submit a task to be executed on all nodes in the cluster.
<T> CompletionStage<T>	submitToKeyOwner(Callable<T> task, String serviceName, Object key) Submit a task to be executed by a service given by its name on one node of the cluster that own a given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

HazelcastClusterManager

public HazelcastClusterManager(com.atlassian.config.ApplicationConfig applicationConfig,
                               ClassLoader classLoader,
                               String configResourceName,
                               SynchronizationManager synchronizationManager,
                               com.atlassian.hazelcast.serialization.OsgiSafeStreamSerializer osgiSafeStreamSerializer,
                               com.hazelcast.core.OutOfMemoryHandler outOfMemoryHandler,
                               io.micrometer.core.instrument.MeterRegistry micrometerRegistry,
                               MBeanServer mbeanServer)

Method Detail

initOutOfmemoryhandler

@PostConstruct
public void initOutOfmemoryhandler()

resolveName

public InetAddress resolveName(String name)

Specified by:

resolveName in interface NameResolver

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

getClusterUptime

public long getClusterUptime()

Description copied from interface: ClusterManager

Gets the amount of time that the cluster has been running.

Specified by:

getClusterUptime in interface ClusterManager

Returns:

the time in milliseconds since the first node in the cluster came up, or the node uptime if not clustered.

isClustered

public boolean isClustered()

Specified by:

isClustered in interface ClusterManager

Returns:

true if this instance is configured to allow clustering with other nodes. Note, this does not mean this instance is licensed to cluster.

getClusterInformation

public ClusterInformation getClusterInformation()

Description copied from interface: ClusterManager

Get information about the running cluster.

Specified by:

getClusterInformation in interface ClusterManager

getFifoBuffer

public <T> com.atlassian.core.task.FifoBuffer<T> getFifoBuffer(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

This waits for any current transaction to be committed successfully before scheduling the event for publishing.

Specified by:

publishEvent in interface ClusterManager

publishEventImmediately

public void publishEventImmediately(ConfluenceEvent event)

Description copied from interface: ClusterManager

Publish immediately, an event as a ClusterEventWrapper to other nodes

This is done immediately regardless of the state of any current transactions.

Specified by:

publishEventImmediately in interface ClusterManager

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 Collection<ClusterNodeInformation> getAllNodesInformation()

Specified by:

getAllNodesInformation in interface ClusterManager

configure

public void configure(ClusterConfig clusterConfig)

Description copied from interface: ClusterManager

Set a new cluster configuration.

Specified by:

configure in interface ClusterManager

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)

Description copied from interface: ClusterManager

Set a new cluster configuration and cycle the service

Specified by:

reconfigure in interface ClusterManager

stopCluster

@PreDestroy
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

createHazelcastInstance

protected com.hazelcast.core.HazelcastInstance createHazelcastInstance()

getNodeStatuses

@Deprecated
public Map<Integer,NodeStatus> getNodeStatuses()

Deprecated.

Gets status information from all members of the cluster.

Specified by:

getNodeStatuses in interface ClusterManager

Returns:

a map of node IDs to node statuses

getNodeStatusMap

public Map<ClusterNodeInformation,NodeStatus> getNodeStatusMap()

Gets status information from all members of the cluster.

Specified by:

getNodeStatusMap in interface ClusterManager

getNodeStatusMapAsync

public Map<ClusterNodeInformation,CompletionStage<NodeStatus>> getNodeStatusMapAsync()

Gets CompletionStage of status information from all members of the cluster.

Specified by:

getNodeStatusMapAsync in interface ClusterManager

getClusterMembershipCriteria

public ClusterMembershipCriteria getClusterMembershipCriteria()
                                                       throws ClusterException

Description copied from interface: ClusterManager

Get all attributes of the server that must be used as criteria when determining whether a new node can join this cluster. 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:

getClusterMembershipCriteria in interface ClusterManager

Returns:

the cluster membership criteria of this server

Throws:

ClusterException - if the criteria cannot be gathered for some reason

getClusterInvariants

public ClusterInvariants getClusterInvariants()
                                       throws ClusterException

Description copied from interface: ClusterManager

Get all attributes of the server that must be consistent between the nodes of a stable cluster. 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

getLockForName

public com.atlassian.confluence.cluster.hazelcast.DualLock getLockForName(@NonNull String key)

Specified by:

getLockForName in interface com.atlassian.beehive.ClusterLockService

getClusteredLock

public ClusteredLock getClusteredLock(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

getLock

public Lock getLock(String name)

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

get

public com.hazelcast.core.HazelcastInstance get()

Specified by:

get in interface Supplier<com.hazelcast.core.HazelcastInstance>

submitToKeyOwner

public <T> CompletionStage<T> submitToKeyOwner(Callable<T> task,
                                               String serviceName,
                                               Object key)

Description copied from interface: ClusterManager

Submit a task to be executed by a service given by its name on one node of the cluster that own a given key.

Specified by:

submitToKeyOwner in interface ClusterManager

Parameters:

task - task to be executed on the node that owns the provided key, it must be Serializable

serviceName - name of service used to execute the task

key - key used to determined which node is going to execute the task, it must be Serializable

Returns:

CompletionStage

submitToAllNodes

public <T> List<ClusterNodeExecution<T>> submitToAllNodes(Callable<T> task,
                                                          String serviceName)

Description copied from interface: ClusterManager

Submit a task to be executed on all nodes in the cluster.

Specified by:

submitToAllNodes in interface ClusterManager

Parameters:

task - task to be executed on the node that owns the provided key, it must be Serializable

serviceName - name of service used to execute the task

Returns:

List of ClusterNodeExecution, one element from each node

getSharedSecret

public String getSharedSecret()

Get the value of config property confluence.cluster.authentication.secret from confluence.cfg.xml

isNodeAuthEnabled

public boolean isNodeAuthEnabled()

Get the value of config property confluence.cluster.authentication.enabled from confluence.cfg.xml