com.haulmont.cuba.core.app

Interface ClusterManagerAPI

All Known Implementing Classes:

ClusterManager, TestClusterManager

public interface ClusterManagerAPI

Interface defining methods for communication in a middleware cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.Class messageClass, ClusterListener listener) Subscribe to messages from other cluster nodes.
int	getActiveThreadsCount()
java.lang.String	getCurrentView() Return a string representation of a set of active nodes in the cluster.
int	getMessagesCount()
long	getReceivedBytes(java.lang.String className) Get received bytes for specified className
long	getReceivedMessages(java.lang.String className) Get received messages count for specified className
long	getSentBytes(java.lang.String className) Get sent bytes for specified className
long	getSentMessages(java.lang.String className) Get sent messages count for specified className
boolean	getSyncSendingForCurrentThread()
boolean	isMaster() Inform whether the current node is currently the master node in the cluster.
boolean	isStarted()
java.lang.String	printMessagesStat() Sent/received messages statistics
java.lang.String	printSharedStateStat() Shared state statistics
void	removeListener(java.lang.Class messageClass, ClusterListener listener) Unsubscribe from messages from other cluster nodes.
void	send(java.io.Serializable message) Send a message to all active cluster nodes.
void	sendSync(java.io.Serializable message) Send a message to all active cluster nodes synchronously.
void	setSyncSendingForCurrentThread(boolean sync) Forces synchronous sending for the current thread.
void	start() Join a cluster.
void	stop() Leave the cluster.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

send

void send(java.io.Serializable message)

Send a message to all active cluster nodes.

Parameters:

message - serializable message

sendSync

void sendSync(java.io.Serializable message)

Send a message to all active cluster nodes synchronously.

Parameters:

message - serializable message

getSyncSendingForCurrentThread

boolean getSyncSendingForCurrentThread()

Returns:

whether the synchronous sending is forced for the current thread

See Also:

setSyncSendingForCurrentThread(boolean)

setSyncSendingForCurrentThread

void setSyncSendingForCurrentThread(boolean sync)

Forces synchronous sending for the current thread. It means that the send(Serializable) method will send the message in the current thread and block until returning from the clustering implementation.

Parameters:

sync - true to force synchronous sending

addListener

void addListener(java.lang.Class messageClass,
                 ClusterListener listener)

Subscribe to messages from other cluster nodes.

Parameters:

messageClass - the class of messages we want to be notified

listener - listener instance

removeListener

void removeListener(java.lang.Class messageClass,
                    ClusterListener listener)

Unsubscribe from messages from other cluster nodes.

Parameters:

messageClass - the class of messages we don't want to be notified anymore

listener - listener instance

isMaster

boolean isMaster()

Inform whether the current node is currently the master node in the cluster. A middleware cluster always elects one of its members as master, ususally it is the oldest one.

Returns:

true if the current node is the master

getCurrentView

java.lang.String getCurrentView()

Return a string representation of a set of active nodes in the cluster. This string depends on clustering implementation and should not be parsed or otherwise analyzed in the application.

Returns:

string representation of a set of active nodes

start

void start()

Join a cluster.

stop

void stop()

Leave the cluster.

isStarted

boolean isStarted()

Returns:

true if clustering is started on this node

getActiveThreadsCount

int getActiveThreadsCount()

Returns:

threads count that are actively sending cluster messages

getMessagesCount

int getMessagesCount()

Returns:

cluster messages count queued to send

printSharedStateStat

java.lang.String printSharedStateStat()

Shared state statistics

Returns:

statistics

printMessagesStat

java.lang.String printMessagesStat()

Sent/received messages statistics

Returns:

statistics

getSentMessages

long getSentMessages(java.lang.String className)

Get sent messages count for specified className

Returns:

messages count

getSentBytes

long getSentBytes(java.lang.String className)

Get sent bytes for specified className

Returns:

size in bytes

getReceivedMessages

long getReceivedMessages(java.lang.String className)

Get received messages count for specified className

Returns:

messages count

getReceivedBytes

long getReceivedBytes(java.lang.String className)

Get received bytes for specified className

Returns:

size in bytes