Package com.hivemq.extension.sdk.api.client

Interface ClientContext

@DoNotImplement
public interface ClientContext

The client context is used to set up all interceptors for a client.

The client context is only valid until the initialize methods have returned.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
void	addDisconnectInboundInterceptor(@NotNull DisconnectInboundInterceptor disconnectInboundInterceptor)	Adds an DisconnectInboundInterceptor for this client.
void	addDisconnectOutboundInterceptor(@NotNull DisconnectOutboundInterceptor disconnectOutboundInterceptor)	Adds an DisconnectOutboundInterceptor for this client.
void	addPingReqInboundInterceptor(@NotNull PingReqInboundInterceptor pingReqInboundInterceptor)	Adds an PingReqInboundInterceptor for this client.
void	addPingRespOutboundInterceptor(@NotNull PingRespOutboundInterceptor pingRespOutboundInterceptor)	Adds an PingRespOutboundInterceptor for this client.
void	addPubackInboundInterceptor(@NotNull PubackInboundInterceptor pubackInboundInterceptor)	Adds an PubackInboundInterceptor for this client.
void	addPubackOutboundInterceptor(@NotNull PubackOutboundInterceptor pubackOutboundInterceptor)	Adds an PubackOutboundInterceptor for this client.
void	addPubcompInboundInterceptor(@NotNull PubcompInboundInterceptor pubcompInboundInterceptor)	Adds an PubcompInboundInterceptor for this client.
void	addPubcompOutboundInterceptor(@NotNull PubcompOutboundInterceptor pubcompOutboundInterceptor)	Adds an PubcompOutboundInterceptor for this client.
void	addPublishInboundInterceptor(@NotNull PublishInboundInterceptor publishInboundInterceptor)	Adds an PublishInboundInterceptor for this client.
void	addPublishOutboundInterceptor(@NotNull PublishOutboundInterceptor publishOutboundInterceptor)	Adds an PublishOutboundInterceptor for this client.
void	addPubrecInboundInterceptor(@NotNull PubrecInboundInterceptor pubrecInboundInterceptor)	Adds an PubrecInboundInterceptor for this client.
void	addPubrecOutboundInterceptor(@NotNull PubrecOutboundInterceptor pubrecOutboundInterceptor)	Adds an PubrecOutboundInterceptor for this client.
void	addPubrelInboundInterceptor(@NotNull PubrelInboundInterceptor pubrelInboundInterceptor)	Adds an PubrelInboundInterceptor for this client.
void	addPubrelOutboundInterceptor(@NotNull PubrelOutboundInterceptor pubrelOutboundInterceptor)	Adds an PubrelOutboundInterceptor for this client.
void	addSubackOutboundInterceptor(@NotNull SubackOutboundInterceptor subAckOutboundInterceptor)	Adds a SubackOutboundInterceptor for this client.
void	addSubscribeInboundInterceptor(@NotNull SubscribeInboundInterceptor subscribeInboundInterceptor)	Adds an SubscribeInboundInterceptor for this client.
void	addUnsubackOutboundInterceptor(@NotNull UnsubackOutboundInterceptor unsubackOutboundInterceptor)	Adds an UnsubackOutboundInterceptor for this client.
void	addUnsubscribeInboundInterceptor(@NotNull UnsubscribeInboundInterceptor unsubscribeInboundInterceptor)	Adds an UnsubscribeInboundInterceptor for this client.
@Immutable @NotNull List<@NotNull Interceptor>	getAllInterceptors()	Returns all Interceptor which are registered for this client.
@NotNull ModifiableDefaultPermissions	getDefaultPermissions()	The default permissions for this client.
@Immutable @NotNull List<@NotNull DisconnectInboundInterceptor>	getDisconnectInboundInterceptors()	Returns all DisconnectInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull DisconnectOutboundInterceptor>	getDisconnectOutboundInterceptors()	Returns all DisconnectOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PingReqInboundInterceptor>	getPingReqInboundInterceptors()	Returns all PingReqInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PingRespOutboundInterceptor>	getPingRespOutboundInterceptors()	Returns all PingRespOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubackInboundInterceptor>	getPubackInboundInterceptors()	Returns all PubackInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubackOutboundInterceptor>	getPubackOutboundInterceptors()	Returns all PubackOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubcompInboundInterceptor>	getPubcompInboundInterceptors()	Returns all PubcompInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubcompOutboundInterceptor>	getPubcompOutboundInterceptors()	Returns all PubcompOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PublishInboundInterceptor>	getPublishInboundInterceptors()	Returns all PublishInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PublishOutboundInterceptor>	getPublishOutboundInterceptors()	Returns all PublishOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubrecInboundInterceptor>	getPubrecInboundInterceptors()	Returns all PubrecInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubrecOutboundInterceptor>	getPubrecOutboundInterceptors()	Returns all PubrecOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubrelInboundInterceptor>	getPubrelInboundInterceptors()	Returns all PubrelInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull PubrelOutboundInterceptor>	getPubrelOutboundInterceptors()	Returns all PubrelOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull SubackOutboundInterceptor>	getSubackOutboundInterceptors()	Returns all SubackOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull SubscribeInboundInterceptor>	getSubscribeInboundInterceptors()	Returns all SubscribeInboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull UnsubackOutboundInterceptor>	getUnsubackOutboundInterceptors()	Returns all UnsubackOutboundInterceptor which are registered for this client by this extension.
@Immutable @NotNull List<@NotNull UnsubscribeInboundInterceptor>	getUnsubscribeInboundInterceptors()	Returns all UnsubscribeInboundInterceptor which are registered for this client by this extension.
void	removeDisconnectInboundInterceptor(@NotNull DisconnectInboundInterceptor disconnectInboundInterceptor)	Removes an DisconnectInboundInterceptor for this client.
void	removeDisconnectOutboundInterceptor(@NotNull DisconnectOutboundInterceptor disconnectOutboundInterceptor)	Removes an DisconnectOutboundInterceptor for this client.
void	removePingReqInboundInterceptor(@NotNull PingReqInboundInterceptor pingReqInboundInterceptor)	Removes a PingReqInboundInterceptor for this client.
void	removePingRespOutboundInterceptor(@NotNull PingRespOutboundInterceptor pingRespOutboundInterceptor)	Removes a PingRespOutboundInterceptor for this client.
void	removePubackInboundInterceptor(@NotNull PubackInboundInterceptor pubackInboundInterceptor)	Removes an PubackInboundInterceptor for this client.
void	removePubackOutboundInterceptor(@NotNull PubackOutboundInterceptor pubackOutboundInterceptor)	Removes an PubackOutboundInterceptor for this client.
void	removePubcompInboundInterceptor(@NotNull PubcompInboundInterceptor pubcompInboundInterceptor)	Removes an PubcompInboundInterceptor for this client.
void	removePubcompOutboundInterceptor(@NotNull PubcompOutboundInterceptor pubcompOutboundInterceptor)	Removes an PubcompOutboundInterceptor for this client.
void	removePublishInboundInterceptor(@NotNull PublishInboundInterceptor publishInboundInterceptor)	Removes an PublishInboundInterceptor for this client.
void	removePublishOutboundInterceptor(@NotNull PublishOutboundInterceptor publishOutboundInterceptor)	Removes an PublishOutboundInterceptor for this client.
void	removePubrecInboundInterceptor(@NotNull PubrecInboundInterceptor pubrecInboundInterceptor)	Removes an PubrecInboundInterceptor for this client.
void	removePubrecOutboundInterceptor(@NotNull PubrecOutboundInterceptor pubrecOutboundInterceptor)	Removes an PubrecOutboundInterceptor for this client.
void	removePubrelInboundInterceptor(@NotNull PubrelInboundInterceptor pubrelInboundInterceptor)	Removes an PubrelInboundInterceptor for this client.
void	removePubrelOutboundInterceptor(@NotNull PubrelOutboundInterceptor pubrelOutboundInterceptor)	Removes an PubrelOutboundInterceptor for this client.
void	removeSubackOutboundInterceptor(@NotNull SubackOutboundInterceptor subackOutboundInterceptor)	Removes a SubackOutboundInterceptor for this client.
void	removeSubscribeInboundInterceptor(@NotNull SubscribeInboundInterceptor subscribeInboundInterceptor)	Removes an SubscribeInboundInterceptor for this client.
void	removeUnsubackOutboundInterceptor(@NotNull UnsubackOutboundInterceptor unsubackOutboundInterceptor)	Removes an UnsubackOutboundInterceptor for this client.
void	removeUnsubscribeInboundInterceptor(@NotNull UnsubscribeInboundInterceptor unsubscribeInboundInterceptor)	Removes an UnsubscribeInboundInterceptor for this client.

Method Details

addPublishInboundInterceptor

void addPublishInboundInterceptor(@NotNull PublishInboundInterceptor publishInboundInterceptor)

Adds an PublishInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

publishInboundInterceptor - The implementation of an PublishInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.0.0, CE 2019.1

addPublishOutboundInterceptor

void addPublishOutboundInterceptor(@NotNull PublishOutboundInterceptor publishOutboundInterceptor)

Adds an PublishOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

publishOutboundInterceptor - The implementation of an PublishOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.2.0, CE 2020.1

addPubackInboundInterceptor

void addPubackInboundInterceptor(@NotNull PubackInboundInterceptor pubackInboundInterceptor)

Adds an PubackInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubackInboundInterceptor - The implementation of an PubackInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubackOutboundInterceptor

void addPubackOutboundInterceptor(@NotNull PubackOutboundInterceptor pubackOutboundInterceptor)

Adds an PubackOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubackOutboundInterceptor - The implementation of an PubackOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubrecInboundInterceptor

void addPubrecInboundInterceptor(@NotNull PubrecInboundInterceptor pubrecInboundInterceptor)

Adds an PubrecInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubrecInboundInterceptor - The implementation of an PubrecInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubrecOutboundInterceptor

void addPubrecOutboundInterceptor(@NotNull PubrecOutboundInterceptor pubrecOutboundInterceptor)

Adds an PubrecOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubrecOutboundInterceptor - The implementation of an PubrecOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubrelInboundInterceptor

void addPubrelInboundInterceptor(@NotNull PubrelInboundInterceptor pubrelInboundInterceptor)

Adds an PubrelInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubrelInboundInterceptor - The implementation of an PubrelInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubrelOutboundInterceptor

void addPubrelOutboundInterceptor(@NotNull PubrelOutboundInterceptor pubrelOutboundInterceptor)

Adds an PubrelOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubrelOutboundInterceptor - The implementation of an PubrelOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubcompInboundInterceptor

void addPubcompInboundInterceptor(@NotNull PubcompInboundInterceptor pubcompInboundInterceptor)

Adds an PubcompInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubcompInboundInterceptor - The implementation of an PubcompInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPubcompOutboundInterceptor

void addPubcompOutboundInterceptor(@NotNull PubcompOutboundInterceptor pubcompOutboundInterceptor)

Adds an PubcompOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pubcompOutboundInterceptor - The implementation of an PubcompOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addSubscribeInboundInterceptor

void addSubscribeInboundInterceptor(@NotNull SubscribeInboundInterceptor subscribeInboundInterceptor)

Adds an SubscribeInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

subscribeInboundInterceptor - The implementation of an SubscribeInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.2.0, CE 2020.1

addSubackOutboundInterceptor

void addSubackOutboundInterceptor(@NotNull SubackOutboundInterceptor subAckOutboundInterceptor)

Adds a SubackOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

subAckOutboundInterceptor - The implementation of a SubackOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addUnsubscribeInboundInterceptor

void addUnsubscribeInboundInterceptor(@NotNull UnsubscribeInboundInterceptor unsubscribeInboundInterceptor)

Adds an UnsubscribeInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

unsubscribeInboundInterceptor - The implementation of an UnsubscribeInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addUnsubackOutboundInterceptor

void addUnsubackOutboundInterceptor(@NotNull UnsubackOutboundInterceptor unsubackOutboundInterceptor)

Adds an UnsubackOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

unsubackOutboundInterceptor - The implementation of an UnsubackOutboundInterceptors.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addDisconnectInboundInterceptor

void addDisconnectInboundInterceptor(@NotNull DisconnectInboundInterceptor disconnectInboundInterceptor)

Adds an DisconnectInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

disconnectInboundInterceptor - The implementation of a DisconnectInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addDisconnectOutboundInterceptor

void addDisconnectOutboundInterceptor(@NotNull DisconnectOutboundInterceptor disconnectOutboundInterceptor)

Adds an DisconnectOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

disconnectOutboundInterceptor - The implementation of a DisconnectOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPingReqInboundInterceptor

void addPingReqInboundInterceptor(@NotNull PingReqInboundInterceptor pingReqInboundInterceptor)

Adds an PingReqInboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pingReqInboundInterceptor - The implementation of a PingReqInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

addPingRespOutboundInterceptor

void addPingRespOutboundInterceptor(@NotNull PingRespOutboundInterceptor pingRespOutboundInterceptor)

Adds an PingRespOutboundInterceptor for this client.

Subsequent adding of the same interceptor will be ignored.

Parameters:

pingRespOutboundInterceptor - The implementation of a PingRespOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePublishInboundInterceptor

void removePublishInboundInterceptor(@NotNull PublishInboundInterceptor publishInboundInterceptor)

Removes an PublishInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

publishInboundInterceptor - The implementation of an PublishInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.0.0, CE 2019.1

removePublishOutboundInterceptor

void removePublishOutboundInterceptor(@NotNull PublishOutboundInterceptor publishOutboundInterceptor)

Removes an PublishOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

publishOutboundInterceptor - The implementation of an PublishOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.2.0, CE 2020.1

removePubackInboundInterceptor

void removePubackInboundInterceptor(@NotNull PubackInboundInterceptor pubackInboundInterceptor)

Removes an PubackInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubackInboundInterceptor - The implementation of an PubackInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubackOutboundInterceptor

void removePubackOutboundInterceptor(@NotNull PubackOutboundInterceptor pubackOutboundInterceptor)

Removes an PubackOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubackOutboundInterceptor - The implementation of an PubackOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubrecInboundInterceptor

void removePubrecInboundInterceptor(@NotNull PubrecInboundInterceptor pubrecInboundInterceptor)

Removes an PubrecInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubrecInboundInterceptor - The implementation of an PubrecInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubrecOutboundInterceptor

void removePubrecOutboundInterceptor(@NotNull PubrecOutboundInterceptor pubrecOutboundInterceptor)

Removes an PubrecOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubrecOutboundInterceptor - The implementation of an PubrecOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubrelInboundInterceptor

void removePubrelInboundInterceptor(@NotNull PubrelInboundInterceptor pubrelInboundInterceptor)

Removes an PubrelInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubrelInboundInterceptor - The implementation of an PubrelInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubrelOutboundInterceptor

void removePubrelOutboundInterceptor(@NotNull PubrelOutboundInterceptor pubrelOutboundInterceptor)

Removes an PubrelOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubrelOutboundInterceptor - The implementation of an PubrelOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubcompInboundInterceptor

void removePubcompInboundInterceptor(@NotNull PubcompInboundInterceptor pubcompInboundInterceptor)

Removes an PubcompInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubcompInboundInterceptor - The implementation of an PubcompInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePubcompOutboundInterceptor

void removePubcompOutboundInterceptor(@NotNull PubcompOutboundInterceptor pubcompOutboundInterceptor)

Removes an PubcompOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pubcompOutboundInterceptor - The implementation of an PubcompOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removeSubscribeInboundInterceptor

void removeSubscribeInboundInterceptor(@NotNull SubscribeInboundInterceptor subscribeInboundInterceptor)

Removes an SubscribeInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

subscribeInboundInterceptor - The implementation of an SubscribeInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.2.0, CE 2020.1

removeSubackOutboundInterceptor

void removeSubackOutboundInterceptor(@NotNull SubackOutboundInterceptor subackOutboundInterceptor)

Removes a SubackOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

subackOutboundInterceptor - The implementation of a SubackOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removeUnsubscribeInboundInterceptor

void removeUnsubscribeInboundInterceptor(@NotNull UnsubscribeInboundInterceptor unsubscribeInboundInterceptor)

Removes an UnsubscribeInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

unsubscribeInboundInterceptor - The implementation of an UnsubscribeInboundInterceptor.

Throws:

NullPointerException - If the interceptors is null.

Since:

4.3.0, CE 2020.1

removeUnsubackOutboundInterceptor

void removeUnsubackOutboundInterceptor(@NotNull UnsubackOutboundInterceptor unsubackOutboundInterceptor)

Removes an UnsubackOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

unsubackOutboundInterceptor - The implementation of an UnsubackOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removeDisconnectInboundInterceptor

void removeDisconnectInboundInterceptor(@NotNull DisconnectInboundInterceptor disconnectInboundInterceptor)

Removes an DisconnectInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

disconnectInboundInterceptor - The implementation of an DisconnectInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removeDisconnectOutboundInterceptor

void removeDisconnectOutboundInterceptor(@NotNull DisconnectOutboundInterceptor disconnectOutboundInterceptor)

Removes an DisconnectOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

disconnectOutboundInterceptor - The implementation of an DisconnectOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePingReqInboundInterceptor

void removePingReqInboundInterceptor(@NotNull PingReqInboundInterceptor pingReqInboundInterceptor)

Removes a PingReqInboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pingReqInboundInterceptor - The implementation of a PingReqInboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

removePingRespOutboundInterceptor

void removePingRespOutboundInterceptor(@NotNull PingRespOutboundInterceptor pingRespOutboundInterceptor)

Removes a PingRespOutboundInterceptor for this client.

Nothing happens if the interceptor that should be removed, has not been added in the first place.

Parameters:

pingRespOutboundInterceptor - The implementation of a PingRespOutboundInterceptor.

Throws:

NullPointerException - If the interceptor is null.

Since:

4.3.0, CE 2020.1

getAllInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull Interceptor> getAllInterceptors()

Returns all Interceptor which are registered for this client.

Returns:

List of Interceptors for this client.

Since:

4.0.0, CE 2019.1

getPublishInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PublishInboundInterceptor> getPublishInboundInterceptors()

Returns all PublishInboundInterceptor which are registered for this client by this extension.

Returns:

List of PublishInboundInterceptors for this client.

Since:

4.0.0, CE 2019.1

getPublishOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PublishOutboundInterceptor> getPublishOutboundInterceptors()

Returns all PublishOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PublishOutboundInterceptors for this client.

Since:

4.2.0, CE 2020.1

getPubackInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubackInboundInterceptor> getPubackInboundInterceptors()

Returns all PubackInboundInterceptor which are registered for this client by this extension.

Returns:

List of PubackInboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubackOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubackOutboundInterceptor> getPubackOutboundInterceptors()

Returns all PubackOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PubackOutboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubrecInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubrecInboundInterceptor> getPubrecInboundInterceptors()

Returns all PubrecInboundInterceptor which are registered for this client by this extension.

Returns:

List of PubrecInboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubrecOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubrecOutboundInterceptor> getPubrecOutboundInterceptors()

Returns all PubrecOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PubrecOutboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubrelInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubrelInboundInterceptor> getPubrelInboundInterceptors()

Returns all PubrelInboundInterceptor which are registered for this client by this extension.

Returns:

List of PubrelInboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubrelOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubrelOutboundInterceptor> getPubrelOutboundInterceptors()

Returns all PubrelOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PubrelOutboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubcompInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubcompInboundInterceptor> getPubcompInboundInterceptors()

Returns all PubcompInboundInterceptor which are registered for this client by this extension.

Returns:

List of PubcompInboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getPubcompOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PubcompOutboundInterceptor> getPubcompOutboundInterceptors()

Returns all PubcompOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PubcompOutboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getSubscribeInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull SubscribeInboundInterceptor> getSubscribeInboundInterceptors()

Returns all SubscribeInboundInterceptor which are registered for this client by this extension.

Returns:

List of SubscribeInboundInterceptors for this client.

Since:

4.2.0, CE 2020.1

getSubackOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull SubackOutboundInterceptor> getSubackOutboundInterceptors()

Returns all SubackOutboundInterceptor which are registered for this client by this extension.

Returns:

List of SubackOutboundInterceptor for this client.

Since:

4.3.0, CE 2020.1

getUnsubscribeInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull UnsubscribeInboundInterceptor> getUnsubscribeInboundInterceptors()

Returns all UnsubscribeInboundInterceptor which are registered for this client by this extension.

Returns:

List of UnsubscribeInboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getUnsubackOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull UnsubackOutboundInterceptor> getUnsubackOutboundInterceptors()

Returns all UnsubackOutboundInterceptor which are registered for this client by this extension.

Returns:

List of UnsubackOutboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getDisconnectInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull DisconnectInboundInterceptor> getDisconnectInboundInterceptors()

Returns all DisconnectInboundInterceptor which are registered for this client by this extension.

Returns:

List of DisconnectInboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getDisconnectOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull DisconnectOutboundInterceptor> getDisconnectOutboundInterceptors()

Returns all DisconnectOutboundInterceptor which are registered for this client by this extension.

Returns:

List of DisconnectOutboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getPingReqInboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PingReqInboundInterceptor> getPingReqInboundInterceptors()

Returns all PingReqInboundInterceptor which are registered for this client by this extension.

Returns:

List of PingReqInboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getPingRespOutboundInterceptors

@Immutable @NotNull @Immutable @NotNull List<@NotNull PingRespOutboundInterceptor> getPingRespOutboundInterceptors()

Returns all PingRespOutboundInterceptor which are registered for this client by this extension.

Returns:

List of PingRespOutboundInterceptors for this client.

Since:

4.3.0, CE 2020.1

getDefaultPermissions

@NotNull @NotNull ModifiableDefaultPermissions getDefaultPermissions()

The default permissions for this client. Default permissions are automatically applied by HiveMQ for every MQTT PUBLISH and SUBSCRIBE packet sent by this client.

Returns:

The ModifiableDefaultPermissions.

Since:

4.0.0, CE 2019.1