Package com.tccc.kos.commons.web.broker

Class BrokerClient

java.lang.Object

com.tccc.kos.commons.util.ready.ReadyBean

com.tccc.kos.commons.core.service.AbstractService

com.tccc.kos.commons.web.broker.BrokerClient

All Implemented Interfaces:

CtxEventListener, ContextHandleAware, HandleAware, Ready, ReadyListener

public final class BrokerClient
extends AbstractService

Message broker client to provide java access to broker messages.

Since:

1.0

Version:

2024-03-30

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIAS_LOCAL
static final String	ALIAS_PRIMARY

Constructor Summary

Constructors

Constructor	Description
BrokerClient(NodeId selfNode, boolean isPrimary)	Create a new client that is running on the specified node.

Method Summary

Modifier and Type	Method	Description
<T> BrokerClientSubscription<T>	aliasSubscribe(String alias, String topic, Class<T> clazz, BrokerClientCallback<T> callback)	Subscribe to message broker on the node with he specified alias.
<T> BrokerClientSubscription<T>	localSubscribe(String topic, Class<T> clazz, BrokerClientCallback<T> callback)	Subscribe to message broker on local node.
<T> BrokerClientSubscription<T>	nodeSubscribe(NodeId node, String topic, Class<T> clazz, BrokerClientCallback<T> callback)	Subscribe to message broker on specified node.
<T> BrokerClientSubscription<T>	primarySubscribe(String topic, Class<T> clazz, BrokerClientCallback<T> callback)	Subscribe to message broker on the primary node.
void	unsubscribe(BrokerClientSubscription<?> subscription)	Unsubscribe an existing subscription.

Methods inherited from class com.tccc.kos.commons.core.service.AbstractService

getHandle, getHandlePrefix

Methods inherited from class com.tccc.kos.commons.util.ready.ReadyBean

getReady, onBeanReady, onDependenciesReady

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tccc.kos.commons.core.context.CtxEventListener

onCtxAutowiringCompleted, onCtxDestroyed, onCtxPhaseCompleted

Methods inherited from interface com.tccc.kos.commons.core.service.handle.HandleAware

addHandleChild, getName, getPath

Methods inherited from interface com.tccc.kos.commons.util.ready.Ready

isReady, setReady

Methods inherited from interface com.tccc.kos.commons.util.ready.ReadyListener

onDependenciesGroupReady

Field Details

ALIAS_PRIMARY

public static final String ALIAS_PRIMARY

See Also:

• Constant Field Values

ALIAS_LOCAL

public static final String ALIAS_LOCAL

See Also:

• Constant Field Values

Constructor Details

BrokerClient

public BrokerClient(NodeId selfNode,
 boolean isPrimary)

Create a new client that is running on the specified node.

Parameters:

selfNode - the node we're running on

isPrimary - true if the node we're running on is the primary node

Method Details

localSubscribe

public <T> BrokerClientSubscription<T> localSubscribe(String topic,
 Class<T> clazz,
 BrokerClientCallback<T> callback)

Subscribe to message broker on local node.

nodeSubscribe

public <T> BrokerClientSubscription<T> nodeSubscribe(NodeId node,
 String topic,
 Class<T> clazz,
 BrokerClientCallback<T> callback)

Subscribe to message broker on specified node.

aliasSubscribe

public <T> BrokerClientSubscription<T> aliasSubscribe(String alias,
 String topic,
 Class<T> clazz,
 BrokerClientCallback<T> callback)

Subscribe to message broker on the node with he specified alias.

primarySubscribe

public <T> BrokerClientSubscription<T> primarySubscribe(String topic,
 Class<T> clazz,
 BrokerClientCallback<T> callback)

Subscribe to message broker on the primary node.

unsubscribe

public void unsubscribe(BrokerClientSubscription<?> subscription)

Unsubscribe an existing subscription.

Parameters:

subscription - the subscription returned from a subscription call.