com.hivemq.spi.callback.registry

Interface CallbackRegistry

public interface CallbackRegistry

The callback registry is used by HiveMQ to determine, which callbacks are implemented.

In order to make your desired callback available to HiveMQ, implement one of the callbacks and add it to the callback registry.

The callback registry can be obtained in the implementation of the PluginEntryPoint by calling PluginEntryPoint.getCallbackRegistry().

Since:

1.4

Author:

Dominik Obermaier, Christian Goetz

Method Summary

Methods

Modifier and Type	Method and Description
void	addCallback(Callback callback) Makes a callback available to HiveMQ.
void	addCallbacks(Callback... callbacks) Makes one or more callbacks available to HiveMQ.
void	clear() Removes all callbacks from the Callback Registry
Set<Callback>	getAllCallbacks() Returns a set of all available callbacks in the Callback Registry
Set<Class<? extends Callback>>	getAllRegisteredCallbackClasses() Returns a set of all callback interfaces for which callbacks are available.
<T extends Callback> List<T>	getCallbacks(Class<T> callbackClass) Returns a list of all available callbacks for a specific callback class.
<T extends Callback> boolean	isCallbackAvailable(Class<T> callbackClass) Returns true if a callbacks for the specific callback class is registered, false otherwise.
void	reloadScheduledCallbackExpression(ScheduledCallback scheduledCallback) Manually triggers a reload of the Scheduled Expression of a ScheduledCallback.
void	removeAllCallbacks(Class<? extends Callback> callbackClass) Remove all callbacks for a specific callback class
void	removeCallback(Callback callback) Removes a callback from the Callback Registry

Method Detail

addCallback

void addCallback(Callback callback)

Makes a callback available to HiveMQ.

Parameters:

callback - which should be added

addCallbacks

void addCallbacks(Callback... callbacks)

Makes one or more callbacks available to HiveMQ.

Parameters:

callbacks - which should be added

isCallbackAvailable

<T extends Callback> boolean isCallbackAvailable(Class<T> callbackClass)

Returns true if a callbacks for the specific callback class is registered, false otherwise.

Parameters:

callbackClass - interface of the callback for which the status should be checked

Returns:

true, if callback is registered with callbackClass, false otherwise

getCallbacks

<T extends Callback> List<T> getCallbacks(Class<T> callbackClass)

Returns a list of all available callbacks for a specific callback class.

Parameters:

callbackClass - interface of the callback for which the classes should be retrieved

Returns:

all callbacks found for the callbackClass

getAllRegisteredCallbackClasses

Set<Class<? extends Callback>> getAllRegisteredCallbackClasses()

Returns a set of all callback interfaces for which callbacks are available.

Returns:

all callback interfaces for which callbacks are available

removeCallback

void removeCallback(Callback callback)

Removes a callback from the Callback Registry

Parameters:

callback - which should be removed

removeAllCallbacks

void removeAllCallbacks(Class<? extends Callback> callbackClass)

Remove all callbacks for a specific callback class

Parameters:

callbackClass - all callbacks for this class are going to be removed completely

clear

void clear()

Removes all callbacks from the Callback Registry

getAllCallbacks

Set<Callback> getAllCallbacks()

Returns a set of all available callbacks in the Callback Registry

Returns:

list of all callbacks

reloadScheduledCallbackExpression

void reloadScheduledCallbackExpression(ScheduledCallback scheduledCallback)

Manually triggers a reload of the Scheduled Expression of a ScheduledCallback.
By default, the Cron expressions of a ScheduledCallbacks don't get reloaded. This reload trigger is useful if your Cron expression can change at runtime. If the cron expression of your ScheduledCallback is static, it's not recommended to do a manual reload.