Package org.apache.activemq.artemis.api.core.client

Interface TopologyMember

public interface TopologyMember

A member of the topology. Each TopologyMember represents a single server and possibly any backup server that may take over its duties (using the nodeId of the original server).

Method Summary

Modifier and Type	Method	Description
TransportConfiguration	getBackup()	Returns the TransportConfiguration relative to the backup server if any.
String	getBackupGroupName()	Returns the backup-group-name of the primary server and backup servers associated with Topology entry.
TransportConfiguration	getLive()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getNodeId()	Returns the nodeId of the server.
TransportConfiguration	getPrimary()
String	getScaleDownGroupName()	Returns the scale-down-group-name of the server with this Topology entry.
long	getUniqueEventID()
boolean	isMember(TransportConfiguration configuration)	Returns true if this configuration is the target of this remoting connection
boolean	isMember(RemotingConnection connection)	Returns true if this TopologyMember is the target of this remoting connection
String	toURI()

Method Detail

getBackupGroupName

String getBackupGroupName()

Returns the backup-group-name of the primary server and backup servers associated with Topology entry.

This is a server configuration value. A (remote) backup will only work with primary servers that have a matching backup-group-name.

This value does not apply to "shared-storage" backup and primary pairs.

Returns:

the backup-group-name

getScaleDownGroupName

String getScaleDownGroupName()

Returns the scale-down-group-name of the server with this Topology entry.

This is a server configuration value. An active server will only send its messages to another active server with matching scale-down-group-name.

Returns:

the scale-down-group-name

getLive

@Deprecated(forRemoval=true)
TransportConfiguration getLive()

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

Returns:

configuration relative to the live server

getPrimary

TransportConfiguration getPrimary()

Returns:

configuration relative to the primary server

getBackup

TransportConfiguration getBackup()

Returns the TransportConfiguration relative to the backup server if any.

Returns:

a TransportConfiguration for the backup, or null if the primary server has no backup server.

getNodeId

String getNodeId()

Returns the nodeId of the server.

Returns:

the nodeId

getUniqueEventID

long getUniqueEventID()

Returns:

long value representing a unique event ID

isMember

boolean isMember(RemotingConnection connection)

Returns true if this TopologyMember is the target of this remoting connection

Parameters:

connection -

Returns:

isMember

boolean isMember(TransportConfiguration configuration)

Returns true if this configuration is the target of this remoting connection

Parameters:

configuration -

Returns:

toURI

String toURI()