Package com.atlassian.confluence.cluster

Interface ClusterNodeInformation

All Superinterfaces:

Serializable

All Known Implementing Classes:

HazelcastClusterNodeInformation

public interface ClusterNodeInformation
extends Serializable

Method Summary

Modifier and Type	Method	Description
@NonNull String	getAnonymizedNodeIdentifier()	Generates an identifier for this cluster node that is sufficiently anonymoised, i.e.
default @NonNull com.atlassian.fugue.Maybe<String>	getHumanReadableNodeName()	Deprecated, for removal: This API element is subject to removal in a future version. since 7.0.1.
int	getId()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.6 Use getAnonymizedNodeIdentifier()
InetSocketAddress	getLocalSocketAddress()
@NonNull Optional<String>	humanReadableNodeName()	Returns the optionally-defined, human-readable name of this cluster node.
boolean	isLocal()	Returns true if this node is the local node.

Method Detail

getId

@Deprecated(forRemoval=true)
int getId()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.6 Use getAnonymizedNodeIdentifier()

Returns:

the id of this node within the cluster.

getLocalSocketAddress

InetSocketAddress getLocalSocketAddress()

getAnonymizedNodeIdentifier

@NonNull String getAnonymizedNodeIdentifier()

Generates an identifier for this cluster node that is sufficiently anonymoised, i.e. doesn't give away any information about the internals of the node. This information is intended to be displayed safely to the end user, as a diagnostic aid to determine which node they're in communication with.

Ideally, this information will persist across restarts, i.e. the same node will generate the same identifier.

There is no requirement for process to be bidirectional.

Since:

5.6

getHumanReadableNodeName

@Deprecated(forRemoval=true)
default @NonNull com.atlassian.fugue.Maybe<String> getHumanReadableNodeName()

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.0.1. Use humanReadableNodeName()

Returns the optionally-defined, human-readable name of this cluster node. Will only be defined if so configured by the server administrator. There is no guarantee that this name will be unique between all nodes of the cluster. The value should never be used to programmatically or uniquely identify a cluster node - use getAnonymizedNodeIdentifier() for that.

Since:

5.7

humanReadableNodeName

@NonNull Optional<String> humanReadableNodeName()

Returns the optionally-defined, human-readable name of this cluster node. Will only be defined if so configured by the server administrator. There is no guarantee that this name will be unique between all nodes of the cluster. The value should never be used to programmatically or uniquely identify a cluster node - use getAnonymizedNodeIdentifier() for that.

Since:

7.0.1

isLocal

boolean isLocal()

Returns true if this node is the local node.

Returns:

true if this node is the local node, false otherwise

Since:

7.18