org.springframework.extensions.surf

Interface ClusterMessageAware

All Known Implementing Classes:

ModuleDeploymentService, PathStoreObjectPersister

public interface ClusterMessageAware

Inteface to be implemented by Surf beans that need to be aware of and or post cluster messages. This is generally the case for cluster aware caching beans e.g. PathStoreObjectPersister or beans that need to perform logic when data changes in the web cluster.

Author:

Kevin Roast

Method Summary

Methods

Modifier and Type	Method and Description
String	getClusterMessageType() The unique message cluster Type ID that this bean deals with and posts using.
void	onClusterMessage(Map<String,Serializable> payload) Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().
void	setClusterService(ClusterService service) Called by a ClusterService implementation to set a ClusterService for this bean to use.

Method Detail

setClusterService

void setClusterService(ClusterService service)

Called by a ClusterService implementation to set a ClusterService for this bean to use. If this is never called (i.e. is null) then there is no ClusterService present and no messages should be posted by the implementor of this interface.

Parameters:

service - ClusterService to use to post cluster message payloads

getClusterMessageType

String getClusterMessageType()

The unique message cluster Type ID that this bean deals with and posts using. This is part of the contract of the ClusterMessageAware interface and must be implemented by the bean.

Returns:

unique cluster message Type ID for this bean.

onClusterMessage

void onClusterMessage(Map<String,Serializable> payload)

Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().

Parameters:

payload - Payload from the message