com.atlassian.crowd.service.cluster

Interface ClusterMessageService

All Known Implementing Classes:

ClusterMessageServiceImpl, NoOpClusterMessageService

@ExperimentalApi
public interface ClusterMessageService

Allows sending short cross-node messages.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
void	publish(String channel, String message) Send a message to other nodes (excluding the sender), notifying all listeners on a specific channel.
void	registerListener(ClusterMessageListener listener, String channel) Register a listener on a channel.
void	unregisterListener(ClusterMessageListener listener) Unregister a listener from all channels.
void	unregisterListener(ClusterMessageListener listener, String channel) Unregister a listener from a specific channel.

Method Detail

registerListener

void registerListener(ClusterMessageListener listener,
                      String channel)

Register a listener on a channel.

unregisterListener

void unregisterListener(ClusterMessageListener listener,
                        String channel)

Unregister a listener from a specific channel.

unregisterListener

void unregisterListener(ClusterMessageListener listener)

Unregister a listener from all channels.

publish

void publish(String channel,
             String message)

Send a message to other nodes (excluding the sender), notifying all listeners on a specific channel.

Parameters:

channel - channel name, max. 64 characters.

message - message content, max. 1024 characters.

Throws:

IllegalArgumentException - if channel or message are too long.