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
-
-
-
Method Detail
-
addPublishInboundInterceptor
void addPublishInboundInterceptor(@NotNull PublishInboundInterceptor publishInboundInterceptor)
Adds anPublishInboundInterceptor
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 anPublishOutboundInterceptor
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 anPubackInboundInterceptor
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 anPubackOutboundInterceptor
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 anPubrecInboundInterceptor
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 anPubrecOutboundInterceptor
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 anPubrelInboundInterceptor
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 anPubrelOutboundInterceptor
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 anPubcompInboundInterceptor
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 anPubcompOutboundInterceptor
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 anSubscribeInboundInterceptor
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 aSubackOutboundInterceptor
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 anUnsubscribeInboundInterceptor
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 anUnsubackOutboundInterceptor
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 anDisconnectInboundInterceptor
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 anDisconnectOutboundInterceptor
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 anPingReqInboundInterceptor
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 anPingRespOutboundInterceptor
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 anPublishInboundInterceptor
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 anPublishOutboundInterceptor
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 anPubackInboundInterceptor
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 anPubackOutboundInterceptor
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 anPubrecInboundInterceptor
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 anPubrecOutboundInterceptor
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 anPubrelInboundInterceptor
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 anPubrelOutboundInterceptor
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 anPubcompInboundInterceptor
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 anPubcompOutboundInterceptor
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 anSubscribeInboundInterceptor
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 aSubackOutboundInterceptor
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 anUnsubscribeInboundInterceptor
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 anUnsubackOutboundInterceptor
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 anDisconnectInboundInterceptor
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 anDisconnectOutboundInterceptor
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 aPingReqInboundInterceptor
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 aPingRespOutboundInterceptor
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 allInterceptor
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 allPublishInboundInterceptor
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 allPublishOutboundInterceptor
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 allPubackInboundInterceptor
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 allPubackOutboundInterceptor
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 allPubrecInboundInterceptor
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 allPubrecOutboundInterceptor
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 allPubrelInboundInterceptor
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 allPubrelOutboundInterceptor
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 allPubcompInboundInterceptor
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 allPubcompOutboundInterceptor
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 allSubscribeInboundInterceptor
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 allSubackOutboundInterceptor
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 allUnsubscribeInboundInterceptor
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 allUnsubackOutboundInterceptor
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 allDisconnectInboundInterceptor
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 allDisconnectOutboundInterceptor
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 allPingReqInboundInterceptor
which are registered for this client by this extension.- Returns:
- List of
PingReqInboundInterceptor
s for this client. - Since:
- 4.3.0, CE 2020.1
-
getPingRespOutboundInterceptors
@Immutable @NotNull @Immutable @NotNull List<@NotNull PingRespOutboundInterceptor> getPingRespOutboundInterceptors()
Returns allPingRespOutboundInterceptor
which are registered for this client by this extension.- Returns:
- List of
PingRespOutboundInterceptor
s for this client. - Since:
- 4.3.0, CE 2020.1
-
getDefaultPermissions
@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
-
-