de.hybris.platform.cluster

Class DefaultBroadcastService

java.lang.Object

de.hybris.platform.cluster.DefaultBroadcastService

All Implemented Interfaces:

BroadcastService

public class DefaultBroadcastService
extends Object
implements BroadcastService

The default broadcast service implementation of hybris platform.

Its purpose is to send messages to a hybris cluster using all configured methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultBroadcastService.MethodBroadcastListener Inner class to connect this service to all broadcast methods.
protected static class	DefaultBroadcastService.MethodWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static int	CUR_VERSION stores the current platform version encoded as integer currently: 4.1.1.0

Constructor Summary

Constructors

Constructor and Description
DefaultBroadcastService(BroadcastServiceConfiguration cfg)

Method Summary

Modifier and Type	Method and Description
boolean	accept(RawMessage message) Determines whether or not a specific message is being accepted.
void	addTransportData(RawMessage message)
protected ExecutorService	createMessageSendingExecutorService()
protected DefaultBroadcastService.MethodWrapper	createMethod(String name, Class clazz)
void	destroy()
BroadcastMethod	getBroadcastMethod(String name) TODO apidoc
Set<String>	getBroadcastMethodNames() TODO apidoc
long	getClusterIslandPK()
int	getClusterNodeID()
long	getDynamicClusterNodeID() TODO apidoc
static DefaultBroadcastService	getInstance()
protected ExecutorService	getMessageSendingExecutorService()
protected List<DefaultBroadcastService.MethodWrapper>	getMethods()
protected String	getStartupInfo()
void	initMethods()
boolean	isClusteringEnabled()
protected boolean	isDuplicateMessage(RawMessage message)
protected boolean	isLocal(RawMessage message)
protected List<DefaultBroadcastService.MethodWrapper>	loadConfiguredMethods()
protected List<DefaultBroadcastService.MethodWrapper>	loadLoopbackMethods()
protected List<DefaultBroadcastService.MethodWrapper>	loadMethods()
protected void	processMessageFromMethod(RawMessage message, String methodName)
void	registerBroadcastListener(BroadcastMessageListener listener, boolean remoteMessagesOnly) TODO apidoc
void	send(RawMessage message) TODO apidoc
protected void	sendAsnychronously(DefaultBroadcastService.MethodWrapper methodWrapper, RawMessage message, Tenant currentTenant, ExecutorService executorService) Sends a message using a executor service.
protected void	sendSynchronously(DefaultBroadcastService.MethodWrapper methodWrapper, RawMessage message) Sends a message synchronously.
protected void	startPingHandler()
void	unregisterBroadcastListener(BroadcastMessageListener listener) TODO apidoc
protected void	updateNodeIDsFromDatabase() Should be called after system initialization since node IDs may have changed!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUR_VERSION

public static final int CUR_VERSION

stores the current platform version encoded as integer currently: 4.1.1.0

See Also:

Constant Field Values

Constructor Detail

DefaultBroadcastService

public DefaultBroadcastService(BroadcastServiceConfiguration cfg)

Method Detail

getInstance

public static DefaultBroadcastService getInstance()

getStartupInfo

protected String getStartupInfo()

updateNodeIDsFromDatabase

protected void updateNodeIDsFromDatabase()

Should be called after system initialization since node IDs may have changed!

createMessageSendingExecutorService

protected ExecutorService createMessageSendingExecutorService()

getMessageSendingExecutorService

protected ExecutorService getMessageSendingExecutorService()

getDynamicClusterNodeID

public long getDynamicClusterNodeID()

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

getDynamicClusterNodeID in interface BroadcastService

Returns:

the dynamic cluster node id

getBroadcastMethodNames

public Set<String> getBroadcastMethodNames()

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

getBroadcastMethodNames in interface BroadcastService

Returns:

Set

getBroadcastMethod

public BroadcastMethod getBroadcastMethod(String name)

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

getBroadcastMethod in interface BroadcastService

Returns:

BroadcastMethod

getMethods

protected List<DefaultBroadcastService.MethodWrapper> getMethods()

initMethods

public void initMethods()

startPingHandler

protected void startPingHandler()

loadMethods

protected List<DefaultBroadcastService.MethodWrapper> loadMethods()

loadLoopbackMethods

protected List<DefaultBroadcastService.MethodWrapper> loadLoopbackMethods()

loadConfiguredMethods

protected List<DefaultBroadcastService.MethodWrapper> loadConfiguredMethods()

createMethod

protected DefaultBroadcastService.MethodWrapper createMethod(String name,
                                                             Class clazz)

registerBroadcastListener

public void registerBroadcastListener(BroadcastMessageListener listener,
                                      boolean remoteMessagesOnly)

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

registerBroadcastListener in interface BroadcastService

unregisterBroadcastListener

public void unregisterBroadcastListener(BroadcastMessageListener listener)

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

unregisterBroadcastListener in interface BroadcastService

getClusterIslandPK

public long getClusterIslandPK()

getClusterNodeID

public int getClusterNodeID()

isClusteringEnabled

public boolean isClusteringEnabled()

addTransportData

public void addTransportData(RawMessage message)

send

public void send(RawMessage message)

Description copied from interface: BroadcastService

TODO apidoc

Specified by:

send in interface BroadcastService

sendSynchronously

protected void sendSynchronously(DefaultBroadcastService.MethodWrapper methodWrapper,
                                 RawMessage message)

Sends a message synchronously.

Parameters:

methodWrapper - the method wrapper

message - the message to send

sendAsnychronously

protected void sendAsnychronously(DefaultBroadcastService.MethodWrapper methodWrapper,
                                  RawMessage message,
                                  Tenant currentTenant,
                                  ExecutorService executorService)
                           throws RejectedExecutionException

Sends a message using a executor service. In case the service is rejecting the message this method blocks and tries to send the message again until the configured wait timeout has been reached.

Parameters:

methodWrapper - the method wrapper

message - the message

currentTenant - the current tenant to be used when sending

executorService - the executor service

Throws:

RejectedExecutionException

accept

public boolean accept(RawMessage message)

Determines whether or not a specific message is being accepted.

Currently only message from other cluster nodes (determined by their dynamic node ID) and the same cluster island PK are accepted.

Specified by:

accept in interface BroadcastService

Parameters:

message - the message to check

Returns:

true if the message is being accepted

isDuplicateMessage

protected boolean isDuplicateMessage(RawMessage message)

isLocal

protected boolean isLocal(RawMessage message)

processMessageFromMethod

protected void processMessageFromMethod(RawMessage message,
                                        String methodName)

destroy

public void destroy()