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 and Description
@NonNull String	getAnonymizedNodeIdentifier() Generates an identifier for this cluster node that is sufficiently anonymoised, i.e.
String	getDescription() Deprecated. since 5.6 Use getAnonymizedNodeIdentifier()
com.atlassian.fugue.Maybe<String>	getHumanReadableNodeName() Deprecated. since 7.0.1. Use humanReadableNodeName()
int	getId() Deprecated. since 5.6 Use getAnonymizedNodeIdentifier()
InetSocketAddress	getLocalSocketAddress()
default @NonNull Optional<String>	humanReadableNodeName() Returns the optionally-defined, human-readable name of this cluster node.

Method Detail

getId

@Deprecated
int getId()

Deprecated. since 5.6 Use getAnonymizedNodeIdentifier()

Returns:

the id of this node within the cluster.

getDescription

@Deprecated
String getDescription()

Deprecated. since 5.6 Use getAnonymizedNodeIdentifier()

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
com.atlassian.fugue.Maybe<String> getHumanReadableNodeName()

Deprecated. 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

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