Uses of Interface
com.hivemq.spi.security.ClientData

Packages that use ClientData

Package	Description
com.hivemq.spi.callback.events
com.hivemq.spi.callback.lowlevel
com.hivemq.spi.callback.security
com.hivemq.spi.security
com.hivemq.spi.services

Uses of ClientData in com.hivemq.spi.callback.events

Methods in com.hivemq.spi.callback.events with parameters of type ClientData

Modifier and Type	Method and Description
void	BeforePublishSendCallback.beforePublishSend(ModifiablePUBLISH publish, ClientData clientData)
SubackReturnCode	OnTopicSubscriptionCallback.getSubackReturnCodeForClient(Topic topic, SubackReturnCode authorizationResult, ClientData clientData) Returns a SubackReturnCode for a Topic, a previous SubackReturnCode and a ClientData.
void	OnConnectCallback.onConnect(CONNECT connect, ClientData clientData) This method gets called when a CONNECT message arrives.
void	OnDisconnectCallback.onDisconnect(ClientData clientData, boolean abruptAbort)
void	OnPublishReceivedCallback.onPublishReceived(PUBLISH publish, ClientData clientData) Called when a PUBLISH MQTT message arrives The publish parameter references the publish object, that is sent to the subscribers, after the onPublishReceived method was called.
void	OnPublishSend.onPublishSend(PUBLISH publish, ClientData clientData) Gets called when a PUBLISH is sent by HiveMQ to a subscribing client.
void	OnSessionReadyCallback.onSessionReady(ClientData clientData) This method gets called once the MQTT Session for the client is ready to be used.
void	OnSubscribeCallback.onSubscribe(SUBSCRIBE message, ClientData clientData) Called when a SUBSCRIBE message arrives.
void	OnUnsubscribeCallback.onUnsubscribe(UNSUBSCRIBE message, ClientData clientData) Gets called when an UNSUBSCRIBE MQTT message arrives

Uses of ClientData in com.hivemq.spi.callback.lowlevel

Methods in com.hivemq.spi.callback.lowlevel with parameters of type ClientData

Modifier and Type	Method and Description
void	OnConnackSend.onConnackSend(CONNACK connack, ClientData clientData) This method gets called after a CONNACK message was sent to the client.
void	OnPingCallback.onPingReceived(ClientData clientData) This method gets called after the broker received a PINGREQ message from a client.
void	OnPubackReceived.onPubackReceived(PUBACK puback, ClientData clientData) This method gets called every time a client sent a PUBACK message.
void	OnPubackSend.onPubackSend(PUBACK puback, ClientData clientData) This method gets called after HiveMQ sent a PUBACK message to a client.
void	OnPubcompReceived.onPubcompReceived(PUBCOMP pubcomp, ClientData clientData) This method gets called when a PUBCOMP message is received from a client.
void	OnPubcompSend.onPubcompSend(PUBCOMP pubcomp, ClientData clientData) This method gets called when HiveMQ sends a PUBCOMP message to a client.
void	OnPubrecReceived.onPubrecReceived(PUBREC pubrec, ClientData clientData) This method gets called when a PUBREC message is received from a client.
void	OnPubrecSend.onPubrecSend(PUBREC pubrec, ClientData clientData) This method gets called when HiveMQ sends a PUBREC message to a client.
void	OnPubrelReceived.onPubrelReceived(PUBREL pubrel, ClientData clientData) This method gets called when a PUBREL message is received from a client.
void	OnPubrelSend.onPubrelSend(PUBREL pubrel, ClientData clientData) This method gets called when HiveMQ sends a PUBREL message to a client.
void	OnSubackSend.onSubackSend(SUBACK suback, ClientData clientData) This method is called after HiveMQ sends a SUBACK message to a client.
void	OnUnsubackSend.onUnsubackSend(UNSUBACK unsuback, ClientData clientData) This method is called after HiveMQ sends a UNSUBACK message to a client.

Uses of ClientData in com.hivemq.spi.callback.security

Methods in com.hivemq.spi.callback.security with parameters of type ClientData

Modifier and Type	Method and Description
void	AfterLoginCallback.afterFailedLogin(AuthenticationException exception, ClientData clientData) Called after a client was denied authentication The client will be disconnected after calling this method.
void	AfterLoginCallback.afterSuccessfulLogin(ClientData clientData) Called after a client was granted authentication
List<MqttTopicPermission>	OnAuthorizationCallback.getPermissionsForClient(ClientData clientData) Returns a list of MqttTopicPermissions for this client.
Set<Restriction>	RestrictionsAfterLoginCallback.getRestrictions(ClientData clientData) Gets called after a successful login of a client.
void	OnInsufficientPermissionDisconnect.onPublishDisconnect(ClientData clientData, String topic, QoS qoS) Gets executed after a client was disconnected due to insufficient permissions when publishing
void	OnInsufficientPermissionDisconnect.onSubscribeDisconnect(ClientData clientData, String topic, QoS qoS) Gets executed after a client was disconnected due to insufficient permissions when subscribing

Uses of ClientData in com.hivemq.spi.security

Subinterfaces of ClientData in com.hivemq.spi.security

Modifier and Type	Interface and Description
interface	ClientCredentialsData An extended version of ClientData which also contains the password the client used in the CONNECT message

Uses of ClientData in com.hivemq.spi.services

Methods in com.hivemq.spi.services that return ClientData

Modifier and Type	Method and Description
ClientData	BlockingClientService.getClientData(String clientId) Returns additional client information about a given client with a given client identifier.
ClientData	BlockingClientService.getLocalClientData(String clientId) Returns client information for clients that are connected to this broker instance.

Methods in com.hivemq.spi.services that return types with arguments of type ClientData

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<ClientData>	AsyncClientService.getClientData(String clientId) Returns additional client information about a given client with a given client identifier.
com.google.common.util.concurrent.ListenableFuture<com.google.common.base.Optional<ClientData>>	ClientService.getClientDataForClientId(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.
com.google.common.util.concurrent.ListenableFuture<ClientData>	AsyncClientService.getLocalClientData(String clientId) Returns client information for clients that are connected to this broker instance.
com.google.common.base.Optional<ClientData>	ClientService.getLocalClientDataForClientId(String clientId) Deprecated. Use BlockingClientService or AsyncClientService instead.

Methods in com.hivemq.spi.services with parameters of type ClientData

Modifier and Type	Method and Description
void	BlockingClientGroupService.addClientToGroup(String group, ClientData clientData) Adds a client to a group.
com.google.common.util.concurrent.ListenableFuture<Void>	AsyncClientGroupService.addClientToGroup(String group, ClientData clientData) Adds a client to a group.