de.hybris.platform.cluster

Interface BroadcastMethod

All Known Implementing Classes:

AbstractBroadcastMethod, DummyBroadcastMethod, JGroupsBroadcastMethod, LoopBackBroadcastMethod, UDPBroadcastMethod, UnicastBroadcastMethod

public interface BroadcastMethod

Definition of messaging method.

A messaging is configured inside system configuration (e.g. local.properties) as follows:

 cluster.broadcast.method.<method name>=<class name>
 cluster.broadcast.methods=<method name&gt,<method name&gt,...
 

All messaging methods are managed by BroadcastService. Use BroadcastService.getBroadcastMethod(String) to access a specific one.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getSettings() Provides generic access to method specific settings
void	init(BroadcastService service) Called once when the messaging method has been registered
void	registerProcessor(BroadcastMessageListener listener) Registers a message processor to be notified upon message received.
void	send(RawMessage message) Sends a raw data message to all connected hybris platform nodes
void	shutdown() Called before system shutdown
void	unregisterProcessor(BroadcastMessageListener listener) Removes a registered message processor.

Method Detail

init

void init(BroadcastService service)

Called once when the messaging method has been registered

shutdown

void shutdown()

Called before system shutdown

send

void send(RawMessage message)

Sends a raw data message to all connected hybris platform nodes

registerProcessor

void registerProcessor(BroadcastMessageListener listener)

Registers a message processor to be notified upon message received.

unregisterProcessor

void unregisterProcessor(BroadcastMessageListener listener)

Removes a registered message processor.

getSettings

java.util.Map<java.lang.String,java.lang.String> getSettings()

Provides generic access to method specific settings