All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description AckReasonCode MQTT 5 Reason codes for PUBACK and PUBREC.AdminService This service provides general information about the state of this HiveMQ instance.Async<T> The interface for the async option of the extension system.Async.Status Information about the runtime status of an async option.AsyncOutput<T> Enables an output object to be processed in a non-blocking way.AuthenticationFailedInput Input object for the methodClientLifecycleEventListener.onAuthenticationFailedDisconnect(AuthenticationFailedInput)
.AuthenticationSuccessfulInput Input object for the methodClientLifecycleEventListener.onAuthenticationSuccessful(AuthenticationSuccessfulInput)
.Authenticator Marker interface for theAuthenticatorProvider
.AuthenticatorProvider The authenticator provider allows to implement custom logic for the authentication of connecting MQTT clients.AuthenticatorProviderInput This is the input parameter of anyAuthenticatorProvider
providingServerInformation
andClientBasedInput
.Authorizer Marker interface for theAuthorizerProvider
.AuthorizerProvider The authorizer provider allows to implement custom logic for the authorization for specific actions (i.e subscribing, publishing etc.) of MQTT clients.AuthorizerProviderInput This is the input parameter of anyAuthorizerProvider
providingServerInformation
andClientBasedInput
.AuthPacket Represents an AUTH packet.AuthReasonCode Builders This class can be used to create builders for the following objects:RetainedPublish
Publish
TopicPermission
TopicSubscription
WillPublishPacket
ClientBasedInput Provides information about the client and the connection of the client.ClientContext The client context is used to set up all interceptors for a client.ClientInformation The client information contains specific data for a client.ClientInitializer ClientInitiatedDisconnectInput Input object for the methodClientLifecycleEventListener.onClientInitiatedDisconnect(ClientInitiatedDisconnectInput)
.ClientLifecycleEventListener AClientLifecycleEventListener
contains methods that allow custom logic to be executed when: A client starts an MQTT connection The authentication for a client is successful A client is disconnectedClientLifecycleEventListenerProvider TheClientLifecycleEventListenerProvider
allows to provide an listener that listens to MQTT client based events.ClientLifecycleEventListenerProviderInput Input object for the methodClientLifecycleEventListenerProvider.getClientLifecycleEventListener(ClientLifecycleEventListenerProviderInput)
.ClientService Through this client service an extension can query details about connected or disconnected clients (with a persistent session) from the HiveMQ core.ClientTlsInformation The TLS information contains specific data about the TLS connection, should the client use TLS.ClusterDiscoveryCallback This callback is meant to regularly discover the addresses of all available HiveMQ cluster nodes.ClusterDiscoveryInput Input for the methods of aClusterDiscoveryCallback
.ClusterDiscoveryOutput Output for the methods of aClusterDiscoveryCallback
that provide the current addresses of all HiveMQ cluster nodes.ClusterNodeAddress Represents a cluster node's address.ClusterService Service for cluster related configuration.CompletableScheduledFuture<T> Abstract class for combining ofScheduledFuture
andCompletableFuture
.ConnackOutboundInput This is the input parameter of anyConnackOutboundInterceptor
providing CONNACK, connection and client based information.ConnackOutboundInterceptor Interface for the outbound CONNACK interception.ConnackOutboundInterceptorProvider The interceptor provider allows to implement custom logic to modify outbound CONNACK messages.ConnackOutboundOutput This is the output parameter of anyConnackOutboundInterceptor
providing methods to define the outcome of CONNACK interception.ConnackOutboundProviderInput This is the input parameter of anyConnackOutboundInterceptorProvider
providingServerInformation
andClientBasedInput
.ConnackPacket Represents a CONNACK packet.ConnackReasonCode Reason code for the MQTT CONNACK packet.ConnectInboundInput This is the input parameter of anyConnectInboundInterceptor
providing CONNECT, connection and client based information.ConnectInboundInterceptor Interface for the connect inbound interception.ConnectInboundInterceptorProvider The interceptor provider allows to implement custom logic to modify incoming CONNECT messages.ConnectInboundOutput This is the output parameter of anyConnectInboundInterceptor
providing methods to define the outcome of a CONNECT interception.ConnectInboundProviderInput This is the input parameter of anyConnectInboundInterceptorProvider
providingServerInformation
andClientBasedInput
.ConnectionAttributeStore Through this service an extension can manage client connection attributes with the same lifetime as the connection.ConnectionInformation The connection information contains specific data for the established connection of a client.ConnectionLostInput Input object for the methodClientLifecycleEventListener.onConnectionLost(ConnectionLostInput)
.ConnectionStartInput Input object for the methodClientLifecycleEventListener.onMqttConnectionStart(ConnectionStartInput)
.ConnectPacket Contains all information from a CONNECT packet.DefaultAuthorizationBehaviour Default behaviour when noAuthorizer
orTopicPermission
matched for the PUBLISH/SUBSCRIBE.DisconnectedReasonCode MQTT 5 CONNACK and DISCONNECT reason codes are listed here.DisconnectEventInput Input object forClientLifecycleEventListener
methods for disconnect events.DisconnectInboundInput This is the input parameter of anyDisconnectInboundInterceptor
providing DISCONNECT, connection and client based information.DisconnectInboundInterceptor Interface for the inbound DISCONNECT interception.DisconnectInboundOutput This is the output parameter of anyDisconnectInboundInterceptor
providing methods to define the outcome of a DISCONNECT interception.DisconnectOutboundInput This is the input parameter of anyDisconnectOutboundInterceptor
providing DISCONNECT, connection and client based information.DisconnectOutboundInterceptor Interface for the outbound DISCONNECT interception.DisconnectOutboundOutput This is the output parameter of anyDisconnectOutboundInterceptor
providing methods to define the outcome of DISCONNECT interception.DisconnectPacket Represents a DISCONNECT packet.DisconnectReasonCode MQTT 5 disconnect reason codes are listed here.DoNotImplement Documents that this interface must not be implemented by an extension.DoNotImplementException This exception is used to signal that a given interface, annotated withDoNotImplement
was falsely implemented by an extension.EnhancedAuthConnectInput Input parameter provided toEnhancedAuthenticator.onConnect(EnhancedAuthConnectInput, EnhancedAuthOutput)
.EnhancedAuthenticator Interface for the enhanced authentication of MQTT clients.EnhancedAuthenticatorProvider The authenticator provider allows to implement custom logic for the authentication of connecting MQTT clients.EnhancedAuthInput Input parameter provided to the methods of anEnhancedAuthenticator
.EnhancedAuthOutput Output parameter provided to the methods of anEnhancedAuthenticator
.EventRegistry Registry that allows the registration of different Event Listeners.Experimental Documents that this interface is experimental and might be subject to change in future HiveMQ versions.ExtensionInformation Detailed information about an extension.ExtensionMain The main starting point for each HiveMQ extension.ExtensionStartInput Input object for the start of an extension.ExtensionStartOutput Output object for the start of an extension.ExtensionStopInput Input object when an extension is stopped.ExtensionStopOutput Output object when an extension is stopped.GlobalInterceptorRegistry Immutable A marker annotation interface which marks a class as immutable.IncompatibleHiveMQVersionException This exception is used to signal that a cluster node has an incompatible HiveMQ version for a specific request.InitializerInput This interface can be used to provide additional information in an initializer.InitializerRegistry Interceptor Marker interface for Interceptors.InvalidTopicException This exception is used to signal that a given topic filter is invalid.IterationCallback<T> A callback that can be passed to methods in extension stores (e.g.IterationContext IterationFailedException Unchecked Exception which is thrown when an iteration fails.LicenseEdition The enum represents the edition for which HiveMQ is licensed.LicenseInformation LifecycleStage LimitExceededException Unchecked Exception which is thrown when a limit is exceeded by a passed parameter.Listener Holds information about the listener a client uses for a connection to HiveMQ.ListenerType The type of aListener
.ManagedExtensionExecutorService A shared thread pool executor which is aScheduledExecutorService
.ModifiableClientSettings An instance of this interface is provided by theSimpleAuthOutput
and can be used to configure client specific parameters and restrictions.ModifiableConnackPacket AConnackPacket
that can be modified before it is sent to the client.ModifiableConnectPacket A modifiable version of theConnectPacket
.ModifiableDefaultPermissions Default permissions enable the authorization of PUBLISH/Subscriptions if noAuthorizer
is used.ModifiableInboundDisconnectPacket An inboundDisconnectPacket
that can be modified before it is sent to the server.ModifiableOutboundDisconnectPacket An outboundDisconnectPacket
that can be modified before it is sent to the client.ModifiableOutboundPublish APublishPacket
that can be modified for onward delivery.ModifiablePubackPacket APubackPacket
that can be modified before it is sent to the client (forPubackOutboundInterceptor
) or to the server (forPubackInboundInterceptor
).ModifiablePubcompPacket APubcompPacket
that can be modified before it is sent to the client (forPubcompOutboundInterceptor
) or to the server (forPubcompInboundInterceptor
).ModifiablePublishPacket APublishPacket
that can be modified for onward delivery.ModifiablePubrecPacket APubrecPacket
that can be modified before it is sent to the client (forPubrecOutboundInterceptor
) or to the server (forPubrecInboundInterceptor
).ModifiablePubrelPacket APubrelPacket
that can be modified before it is sent to the client (forPubrelOutboundInterceptor
) or to the server (forPubrelInboundInterceptor
).ModifiableSubackPacket ASubackPacket
that can be modified before it is sent to the client.ModifiableSubscribePacket A copy of anSubscribePacket
that can be modified for onward delivery.ModifiableSubscription A copy of aSubscription
that can be modified for onward delivery.ModifiableUnsubackPacket AnUnsubackPacket
that can be modified before it is sent to the client.ModifiableUnsubscribePacket A copy of anUnsubscribePacket
that can be modified before it is processed by HiveMQ.ModifiableUserProperties Interface to modifyUserProperties
received from any MQTT packet.ModifiableWillPublish MqttVersion The MQTT version of a client.NoSuchClientIdException This exception is used to signal that a given MQTT ClientId is unknown to the broker in the given context.NotNull An annotation which is used for indicating that something can not benull
.Nullable An annotation which is used for indicating that something can benull
.OverloadProtectionThrottlingLevel The enum is used to define how a client is affected by the overload protection.PayloadFormatIndicator Indicator for the payload.PingReqInboundInput This is the input parameter of anyPingReqInboundInterceptor
.PingReqInboundInterceptor Interface for the ping request inbound interception.PingReqInboundOutput This is the output parameter of anyPingReqInboundInterceptor
.PingRespOutboundInput This is the input parameter of anyPingRespOutboundInterceptor
.PingRespOutboundInterceptor Interface for the ping response interception.PingRespOutboundOutput This is the output parameter of anyPingRespOutboundInterceptor
.ProxyInformation This class encapsulates all information that is forwarded by a load balancer which uses the PROXY protocol.PubackInboundInput This is the input parameter for anyPubackInboundInterceptor
providing PUBACK, connection and client based information.PubackInboundInterceptor Interface for the inbound PUBACK interception.PubackInboundOutput This is the output parameter of anyPubackInboundInterceptor
.PubackOutboundInput This is the input parameter for anyPubackOutboundInterceptor
providing PUBACK, connection and client based information.PubackOutboundInterceptor Interface for the outbound PUBACK interception.PubackOutboundOutput This is the output parameter of anyPubackOutboundInterceptor
.PubackPacket Represents a PUBACK packet.PubcompInboundInput This is the input parameter for anyPubcompInboundInterceptor
providing PUBCOMP, connection and client based information.PubcompInboundInterceptor Interface for the inbound PUBCOMP interception.PubcompInboundOutput This is the output parameter of anyPubcompInboundInterceptor
.PubcompOutboundInput This is the input parameter for anyPubcompOutboundInterceptor
providing PUBCOMP, connection and client based information.PubcompOutboundInterceptor Interface for the outbound PUBCOMP interception.PubcompOutboundOutput This is the output parameter of anyPubcompOutboundInterceptor
.PubcompPacket Represents a PUBCOMP packet.PubcompReasonCode MQTT 5 Reason codes for PUBCOMP.Publish Represents a PUBLISH.PublishAuthorizer Interface for the PUBLISH authorization.PublishAuthorizerInput This is the input parameter of anyPublishAuthorizer
providing an unmodifiable inboundPublishPacket
andClientBasedInput
.PublishAuthorizerOutput This is the output parameter of anyPublishAuthorizer
providing methods to define the outcome of the PUBLISH authorization.PublishBuilder This builder must be used to create aPublish
.PublishInboundInput This is the input parameter of anyPublishInboundInterceptor
providing PUBLISH, connection and client based information.PublishInboundInterceptor Interface for the publish inbound interception.PublishInboundOutput This is the output parameter of anyPublishInboundInterceptor
providing methods to define the outcome of PUBLISH interception.PublishOutboundInput This is the input parameter of anyPublishOutboundInterceptor
providing PUBLISH, connection and client based information.PublishOutboundInterceptor Interface for the publish outbound interception.PublishOutboundOutput This is the output parameter of anyPublishOutboundInterceptor
providing methods to define the outcome of PUBLISH interception.PublishPacket Represents a PUBLISH packet.PublishService This service allows extensions to publish new MQTT messages programmatically.PublishToClientResult Used to inform if the publish to the client had a matching subscription.PubrecInboundInput This is the input parameter for anyPubrecInboundInterceptor
providing PUBREC, connection and client based information.PubrecInboundInterceptor Interface for the inbound PUBREC interception.PubrecInboundOutput This is the output parameter of anyPubrecInboundInterceptor
.PubrecOutboundInput This is the input parameter for anyPubrecOutboundInterceptor
providing PUBREC, connection and client based information.PubrecOutboundInterceptor Interface for the outbound PUBREC interception.PubrecOutboundOutput This is the output parameter of anyPubrecOutboundInterceptor
.PubrecPacket Represents a PUBREC packet.PubrelInboundInput This is the input parameter for anyPubrelInboundInterceptor
providing PUBREL, connection and client based information.PubrelInboundInterceptor Interface for the inbound PUBREL interception.PubrelInboundOutput This is the output parameter of anyPubrelInboundInterceptor
.PubrelOutboundInput This is the input parameter for anyPubrelOutboundInterceptor
providing PUBREL, connection and client based information.PubrelOutboundInterceptor Interface for the outbound PUBREL interception.PubrelOutboundOutput This is the output parameter of anyPubrelOutboundInterceptor
.PubrelPacket Represents a PUBREL packet.PubrelReasonCode MQTT 5 Reason codes for PUBREL.Qos The quality of service level (QOS) of a PUBLISH or subscription.RateLimitExceededException This exception is used to signal that the configured extension service rate limit has been exceeded.RetainedMessageStore The retained message store allows the management of retained messages from within extensions.RetainedPublish RetainedPublishBuilder This builder must be used to create aRetainedPublish
.RetainHandling The retain handling of a subscription.SecurityRegistry The Security Registry allows extensions to define the authentication and authorization of MQTT clients.ServerInformation The server information contains specific data about HiveMQ instance the extensions runs in.ServerInitiatedDisconnectInput Input object for the methodClientLifecycleEventListener.onServerInitiatedDisconnect(ServerInitiatedDisconnectInput)
.Services Services provide a convenient way for extensions to interact with the HiveMQ core.SessionInformation Information about the session of an MQTT client.SimpleAsyncOutput<T> Enables an output object to be processed in a non-blocking way.SimpleAuthenticator Interface for the simple authentication of MQTT clients.SimpleAuthInput Input parameter provided toSimpleAuthenticator.onConnect(SimpleAuthInput, SimpleAuthOutput)
.SimpleAuthOutput Output parameter provided toSimpleAuthenticator.onConnect(SimpleAuthInput, SimpleAuthOutput)
.SubackOutboundInput This is the input parameter of anySubackOutboundInterceptor
providing SUBACK, connection and client based information.SubackOutboundInterceptor Interface for the SUBACK outbound interception.SubackOutboundOutput This is the output parameter of anySubackOutboundInterceptor
providing methods to modify a SUBACK packet before it is sent to the client.SubackPacket Represents a SUBACK packet.SubackReasonCode The SUBACK reason codes for MQTT 5.SubscribeInboundInput This is the input parameter of anySubscribeInboundInterceptor
providing SUBSCRIBE, connection and client based information.SubscribeInboundInterceptor Interface for the subscribe inbound interception.SubscribeInboundOutput This is the output parameter of anySubscribeInboundInterceptor
providing methods to define the outcome of SUBSCRIBE interception.SubscribePacket Represents a SUBSCRIBE packet.SubscriberForTopicResult SubscriberWithFilterResult Subscription Represents a subscription from a SUBSCRIBE packet.SubscriptionAuthorizer Interface for the subscription authorization.SubscriptionAuthorizerInput This is the input parameter of anySubscriptionAuthorizer
providing unmodifiable information about theSubscription
andClientBasedInput
.SubscriptionAuthorizerOutput This is the output parameter of anySubscriptionAuthorizer
providing methods to define the outcome of the subscription authorization.SubscriptionsForClientResult Parameter object passed to each iteration fromSubscriptionStore.iterateAllSubscriptions(IterationCallback)
.SubscriptionStore This service allows extensions to manage the Subscriptions for client session programmatically.SubscriptionType Enum to filter the subscriptions by type.ThreadSafe An annotation which is used for indicating that a class is thread safe.TimeoutFallback The TimeoutFallback defines the strategy that will be applied after anAsync
operation timed out.TlsInformation The TLS information contains specific data about the TLS connection, should the client use TLS.TopicPermission A topic permission represents an authorization action.TopicPermission.MqttActivity The activity the topic permission is applied to.TopicPermission.PermissionType Represents if the PUBLISH/Subscription that matches the topic permission is allowed or denied.TopicPermission.Qos Matching quality of service levels for the topic permission.TopicPermission.Retain Represents the type of PUBLISH the topic permission is applied for.TopicPermission.SharedSubscription Represents the typ of Subscription the topic permission is applied for.TopicPermissionBuilder This builder allows to createTopicPermission
s that can be used in the extension system.TopicSubscription Represents a Subscription.TopicSubscriptionBuilder This builder must be used to create aTopicSubscription
.UnsubackOutboundInput This is the input parameter of anyUnsubackOutboundInterceptor
providing UNSUBACK, connection and client based information.UnsubackOutboundInterceptor Interface for the UNSUBACK outbound interception.UnsubackOutboundOutput This is the output parameter of anyUnsubackOutboundInterceptor
.UnsubackPacket Represents an UNSUBACK packet.UnsubackReasonCode Reason codes that can be set/contained in anUnsubackPacket
.UnsubscribeInboundInput This is the input parameter of anyUnsubscribeInboundInterceptor
providing UNSUBSCRIBE, connection and client based information.UnsubscribeInboundInterceptor Interface for the inbound UNSUBSCRIBE interception.UnsubscribeInboundOutput This is the output parameter of anyUnsubscribeInboundInterceptor
.UnsubscribePacket Represents an UNSUBSCRIBE packet.UserProperties The user properties of an MQTT packet.UserProperty A representation for a user property.WillPublishBuilder This builder must be used to create aWillPublishPacket
.WillPublishPacket Contains all information for the Will Publish that is part of a CONNECT packet.