Package com.atlassian.confluence.cluster

Interface ClusterManager

All Superinterfaces:

ClusterExecutionService

All Known Subinterfaces:

ClusterManagerInternal

All Known Implementing Classes:

HazelcastClusterManager, NonClusterManager

public interface ClusterManager
extends ClusterExecutionService

Field Summary

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

DEFAULT_EXECUTOR_SVC_NAME

Method Summary

Modifier and Type	Method	Description
Collection<ClusterNodeInformation>	getAllNodesInformation()
ClusterInformation	getClusterInformation()	Get information about the running cluster.
long	getClusterUptime()	Gets the amount of time that the cluster has been running.
Map<ClusterNodeInformation,NodeStatus>	getNodeStatusMap()	Gets status information from all members of the cluster.
@Nullable ClusterNodeInformation	getThisNodeInformation()	Get the identity of this node in the cluster.
boolean	isClustered()
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

Methods inherited from interface com.atlassian.confluence.cluster.ClusterExecutionService

submitToAllNodes, submitToKeyOwner, submitToNode

Method Details

isClustered

@EnsuresNonNullIf(expression="getThisNodesInformation()",
                  result=true)
boolean isClustered()

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

ClusterInformation getClusterInformation()

Get information about the running cluster.

publishEvent

void publishEvent(ConfluenceEvent event)

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.

publishEventImmediately

void publishEventImmediately(ConfluenceEvent event)

Publish immediately, an event as a ClusterEventWrapper to other nodes

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

getThisNodeInformation

@Nullable ClusterNodeInformation getThisNodeInformation()

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

Returns:

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

getAllNodesInformation

Collection<ClusterNodeInformation> getAllNodesInformation()

getNodeStatusMap

Map<ClusterNodeInformation,NodeStatus> getNodeStatusMap()

Gets status information from all members of the cluster.

Since:

5.6

getClusterUptime

long getClusterUptime()

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

Returns:

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

Since:

6.11