A B C D E F G H I K L M N O P Q R S T U V W Z 
All Classes All Packages

A

AckReasonCode - Enum in com.hivemq.extension.sdk.api.packets.publish
MQTT 5 Reason codes for PUBACK, PUBREC, PUBREL and PUBCOMP.
activity(TopicPermission.MqttActivity) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set an Activity for this TopicPermission.
add(TopicPermission) - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
Adds a TopicPermission to the default permissions for this client.
addAll(Collection<? extends TopicPermission>) - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
Adds all passed TopicPermissions to the default permissions for this client.
addDiscoveryCallback(ClusterDiscoveryCallback) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterService
Adds a ClusterDiscoveryCallback that will be used by HiveMQ to discover cluster nodes.
addOrReplace(RetainedPublish) - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore
This method adds or replaces a retained message.
addPublishInboundInterceptor(PublishInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext
Adds an PublishInboundInterceptor for this client.
addSubscription(String, TopicSubscription) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore
This method adds a subscription for a certain client to a certain topic.
addSubscriptions(String, Set<TopicSubscription>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore
This method adds multiple subscriptions for a certain client.
addUserProperty(UserProperty) - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties
Add a new UserProperty.
addUserProperty(String, String) - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties
Add a new UserProperty.
ADMINISTRATIVE_ACTION - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
ADMINISTRATIVE_ACTION - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
ALL - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.MqttActivity
Applied to PUBLISHes and Subscriptions.
ALL - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Applied for all QoS levels.
ALL - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Retain
Applied for normal and retained PUBLISH messages.
ALL - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription
Applied for both, normal and shared subscriptions.
ALLOW - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.PermissionType
Allows the PUBLISH/Subscription.
ALLOW - com.hivemq.extension.sdk.api.packets.auth.DefaultAuthorizationBehaviour
When ALLOW is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is allowed to PUBLISH or SUBSCRIBE.
asList() - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
All default permissions for this client.
asList() - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperties
 
async(Duration) - Method in interface com.hivemq.extension.sdk.api.async.AsyncOutput
If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration, TimeoutFallback) - Method in interface com.hivemq.extension.sdk.api.async.AsyncOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
async(Duration, TimeoutFallback, ConnackReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
async(Duration, TimeoutFallback, ConnackReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
async(Duration, TimeoutFallback, AckReasonCode) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
async(Duration, TimeoutFallback, AckReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
async(Duration, TimeoutFallback, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
If the timeout is expired before Async.resume() is called then the outcome is handled either as failed or successful, depending on the specified fallback.
Async<T> - Interface in com.hivemq.extension.sdk.api.async
The interface for the async option of the extension system.
Async.Status - Enum in com.hivemq.extension.sdk.api.async
Information about the runtime status of an async option.
AsyncOutput<T> - Interface in com.hivemq.extension.sdk.api.async
Enables an output object to be processed in a non-blocking way.
AT_LEAST_ONCE - com.hivemq.extension.sdk.api.packets.general.Qos
At least once delivery.
AT_MOST_ONCE - com.hivemq.extension.sdk.api.packets.general.Qos
At most once delivery.
authenticateSuccessfully() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
Successfully authenticates the client.
AuthenticationFailedInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
AuthenticationSuccessfulInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
Authenticator - Interface in com.hivemq.extension.sdk.api.auth
Marker interface for the AuthenticatorProvider.
AuthenticatorProvider - Interface in com.hivemq.extension.sdk.api.services.auth.provider
The authenticator provider allows to implement custom logic for the authentication of connecting MQTT clients.
AuthenticatorProviderInput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the input parameter of any AuthenticatorProvider providing ServerInformation and ClientBasedInput.
authorizePublish(PublishAuthorizerInput, PublishAuthorizerOutput) - Method in interface com.hivemq.extension.sdk.api.auth.PublishAuthorizer
This method is called for every PUBLISH packet and Will Publish, that the PublishAuthorizer is delegated to authorize.
Authorizer - Interface in com.hivemq.extension.sdk.api.auth
Marker interface for the AuthorizerProvider.
AuthorizerProvider - Interface in com.hivemq.extension.sdk.api.services.auth.provider
The authorizer provider allows to implement custom logic for the authorization for specific actions (i.e subscribing, publishing etc.) of MQTT clients.
AuthorizerProviderInput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the input parameter of any AuthorizerProvider providing ServerInformation and ClientBasedInput.
authorizeSubscribe(SubscriptionAuthorizerInput, SubscriptionAuthorizerOutput) - Method in interface com.hivemq.extension.sdk.api.auth.SubscriptionAuthorizer
Called for each Subscription (Topic) in a SUBSCRIBE packet, that the SubscriptionAuthorizer is delegated to authorize.
authorizeSuccessfully() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Successfully authorizes the PUBlISH.
authorizeSuccessfully() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Successfully authorizes the subscription.

B

BAD_AUTHENTICATION_METHOD - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_BAD_USERNAME_OR_PASSWORD.
BAD_AUTHENTICATION_METHOD - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
BAD_AUTHENTICATION_METHOD - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
BAD_USER_NAME_OR_PASSWORD - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_BAD_USERNAME_OR_PASSWORD.
BAD_USER_NAME_OR_PASSWORD - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
BANNED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
BANNED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
build() - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Builds the Publish with the provided values or default values.
build() - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Builds the RetainedPublish with the provided values or default values.
build() - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Builds the TopicPermission with the provided values or default values.
build() - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Builds the TopicSubscription with the provided values or default values.
build() - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Builds the WillPublishPacket with the provided values or default values.
builder() - Static method in interface com.hivemq.extension.sdk.api.packets.connect.WillPublishPacket
A builder that can be used to create an MQTT 5 WillPublishPacket.
builder() - Static method in interface com.hivemq.extension.sdk.api.services.publish.Publish
 
builder() - Static method in interface com.hivemq.extension.sdk.api.services.publish.RetainedPublish
 
builder() - Static method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
 
Builders - Class in com.hivemq.extension.sdk.api.services.builder
This class can be used to create builders for the following objects: RetainedPublish Publish TopicPermission TopicSubscription WillPublishPacket
Builders() - Constructor for class com.hivemq.extension.sdk.api.services.builder.Builders
 

C

CANCELED - com.hivemq.extension.sdk.api.async.Async.Status
The duration for the async operation has timed out.
clear() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Clears all connection attributes for the connected client.
clear() - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
Removes all TopicPermission for this client.
clear() - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties
Removes all user properties.
clear() - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore
Removes all retained messages from the message store.
CLIENT_IDENTIFIER_NOT_VALID - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_IDENTIFIER_REJECTED.
CLIENT_IDENTIFIER_NOT_VALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
CLIENT_IDENTIFIER_NOT_VALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
ClientBasedInput - Interface in com.hivemq.extension.sdk.api.parameter
Provides information about the client and the connection of the client.
ClientContext - Interface in com.hivemq.extension.sdk.api.client
The client context is used to set up all interceptors for a client.
ClientInformation - Interface in com.hivemq.extension.sdk.api.client.parameter
The client information contains specific data for a client.
ClientInitializer - Interface in com.hivemq.extension.sdk.api.services.intializer
 
ClientInitiatedDisconnectInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
ClientLifecycleEventListener - Interface in com.hivemq.extension.sdk.api.events.client
A ClientLifecycleEventListener 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 disconnected
ClientLifecycleEventListenerProvider - Interface in com.hivemq.extension.sdk.api.events.client
The ClientLifecycleEventListenerProvider allows to provide an listener that listens to MQTT client based events.
ClientLifecycleEventListenerProviderInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
clientService() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
ClientService - Interface in com.hivemq.extension.sdk.api.services.session
Through this client service an extension can query details about connected or disconnected clients (with a persistent session) from the HiveMQ core.
ClusterDiscoveryCallback - Interface in com.hivemq.extension.sdk.api.services.cluster
This callback is meant to regularly discover the addresses of all available HiveMQ cluster nodes.
ClusterDiscoveryInput - Interface in com.hivemq.extension.sdk.api.services.cluster.parameter
Input for the methods of a ClusterDiscoveryCallback.
ClusterDiscoveryOutput - Interface in com.hivemq.extension.sdk.api.services.cluster.parameter
Output for the methods of a ClusterDiscoveryCallback that provide the current addresses of all HiveMQ cluster nodes.
ClusterNodeAddress - Class in com.hivemq.extension.sdk.api.services.cluster.parameter
Represents a cluster node's address.
ClusterNodeAddress(String, int) - Constructor for class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
Create the nodes address for the cluster.
clusterService() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
ClusterService - Interface in com.hivemq.extension.sdk.api.services.cluster
Service for cluster related configuration.
com.hivemq.extension.sdk.api - package com.hivemq.extension.sdk.api
 
com.hivemq.extension.sdk.api.annotations - package com.hivemq.extension.sdk.api.annotations
 
com.hivemq.extension.sdk.api.async - package com.hivemq.extension.sdk.api.async
 
com.hivemq.extension.sdk.api.auth - package com.hivemq.extension.sdk.api.auth
 
com.hivemq.extension.sdk.api.auth.parameter - package com.hivemq.extension.sdk.api.auth.parameter
 
com.hivemq.extension.sdk.api.client - package com.hivemq.extension.sdk.api.client
 
com.hivemq.extension.sdk.api.client.parameter - package com.hivemq.extension.sdk.api.client.parameter
 
com.hivemq.extension.sdk.api.events - package com.hivemq.extension.sdk.api.events
 
com.hivemq.extension.sdk.api.events.client - package com.hivemq.extension.sdk.api.events.client
 
com.hivemq.extension.sdk.api.events.client.parameters - package com.hivemq.extension.sdk.api.events.client.parameters
 
com.hivemq.extension.sdk.api.interceptor - package com.hivemq.extension.sdk.api.interceptor
 
com.hivemq.extension.sdk.api.interceptor.publish - package com.hivemq.extension.sdk.api.interceptor.publish
 
com.hivemq.extension.sdk.api.interceptor.publish.parameter - package com.hivemq.extension.sdk.api.interceptor.publish.parameter
 
com.hivemq.extension.sdk.api.packets.auth - package com.hivemq.extension.sdk.api.packets.auth
 
com.hivemq.extension.sdk.api.packets.connect - package com.hivemq.extension.sdk.api.packets.connect
 
com.hivemq.extension.sdk.api.packets.disconnect - package com.hivemq.extension.sdk.api.packets.disconnect
 
com.hivemq.extension.sdk.api.packets.general - package com.hivemq.extension.sdk.api.packets.general
 
com.hivemq.extension.sdk.api.packets.publish - package com.hivemq.extension.sdk.api.packets.publish
 
com.hivemq.extension.sdk.api.packets.subscribe - package com.hivemq.extension.sdk.api.packets.subscribe
 
com.hivemq.extension.sdk.api.parameter - package com.hivemq.extension.sdk.api.parameter
 
com.hivemq.extension.sdk.api.services - package com.hivemq.extension.sdk.api.services
 
com.hivemq.extension.sdk.api.services.auth - package com.hivemq.extension.sdk.api.services.auth
 
com.hivemq.extension.sdk.api.services.auth.provider - package com.hivemq.extension.sdk.api.services.auth.provider
 
com.hivemq.extension.sdk.api.services.builder - package com.hivemq.extension.sdk.api.services.builder
 
com.hivemq.extension.sdk.api.services.cluster - package com.hivemq.extension.sdk.api.services.cluster
 
com.hivemq.extension.sdk.api.services.cluster.parameter - package com.hivemq.extension.sdk.api.services.cluster.parameter
 
com.hivemq.extension.sdk.api.services.exception - package com.hivemq.extension.sdk.api.services.exception
 
com.hivemq.extension.sdk.api.services.intializer - package com.hivemq.extension.sdk.api.services.intializer
 
com.hivemq.extension.sdk.api.services.publish - package com.hivemq.extension.sdk.api.services.publish
 
com.hivemq.extension.sdk.api.services.session - package com.hivemq.extension.sdk.api.services.session
 
com.hivemq.extension.sdk.api.services.subscription - package com.hivemq.extension.sdk.api.services.subscription
 
CompletableScheduledFuture<T> - Class in com.hivemq.extension.sdk.api.services
Abstract class for combining of ScheduledFuture and CompletableFuture.
CompletableScheduledFuture() - Constructor for class com.hivemq.extension.sdk.api.services.CompletableScheduledFuture
 
ConnackReasonCode - Enum in com.hivemq.extension.sdk.api.packets.connect
Reason code for the MQTT CONNACK packet.
CONNECTION_RATE_EXCEEDED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
CONNECTION_RATE_EXCEEDED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
CONNECTION_RATE_EXCEEDED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
ConnectionAttributeStore - Interface in com.hivemq.extension.sdk.api.client.parameter
Through this service an extension can manage client connection attributes with the same lifetime as the connection.
ConnectionInformation - Interface in com.hivemq.extension.sdk.api.client.parameter
The connection information contains specific data for the established connection of a client.
ConnectionLostInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
ConnectionStartInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
ConnectPacket - Interface in com.hivemq.extension.sdk.api.packets.connect
Contains all information from a CONNECT packet.
contentType(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the content type.
contentType(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the content type.
contentType(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the content type.
correlationData(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the correlation data.
correlationData(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the correlation data.
correlationData(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the correlation data.

D

DefaultAuthorizationBehaviour - Enum in com.hivemq.extension.sdk.api.packets.auth
Default behaviour when no Authorizer or TopicPermission matched for the PUBLISH/SUBSCRIBE.
DENY - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.PermissionType
Denies the PUBLISH/Subscription.
DENY - com.hivemq.extension.sdk.api.packets.auth.DefaultAuthorizationBehaviour
When DENY is set and none of the default permission matches to a PUBLISH topic or topic filter in a Subscription, then the client is not allowed to PUBLISH or SUBSCRIBE.
destroy(ClusterDiscoveryInput) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterDiscoveryCallback
This method is called once by HiveMQ in one of the following cases: This callback is removed via ClusterService.removeDiscoveryCallback(ClusterDiscoveryCallback) The extension which added the callback is stopped The HiveMQ instance is shut down
DISCONNECT_WITH_WILL_MESSAGE - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
DISCONNECT_WITH_WILL_MESSAGE - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
disconnectClient() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Disconnects the client that sent the PUBLISH.
disconnectClient() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Disconnects the client that sent the subscription.
disconnectClient(DisconnectReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Disconnects the client that sent the PUBLISH.
disconnectClient(DisconnectReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Disconnects the client that sent the subscription.
disconnectClient(DisconnectReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Disconnects the client that sent the PUBLISH.
disconnectClient(DisconnectReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Disconnects the client that sent the subscription.
disconnectClient(String) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService
Forcefully disconnect a client with the specified clientId.
disconnectClient(String, boolean) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService
Forcefully disconnect a client with the specified clientId.
DisconnectedReasonCode - Enum in com.hivemq.extension.sdk.api.packets.general
MQTT 5 disconnect and connack reason codes are listed here.
DisconnectEventInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
Input object for ClientLifecycleEventListener methods for disconnect events.
DisconnectReasonCode - Enum in com.hivemq.extension.sdk.api.packets.disconnect
MQTT 5 disconnect reason codes are listed here.
DO_NOT_SEND - com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Never send a retained message for the subscription.
DONE - com.hivemq.extension.sdk.api.async.Async.Status
The async operation completed before the timeout, with calling Async.resume().
DoNotImplement - Annotation Type in com.hivemq.extension.sdk.api.annotations
Documents that this interface must not be implemented by an extension.
Usually an implementation is provided by HiveMQ.
DoNotImplementException - Exception in com.hivemq.extension.sdk.api.services.exception
This exception is used to signal that a given interface, annotated with DoNotImplement was falsely implemented by an extension.
DoNotImplementException(String) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.DoNotImplementException
Creates a new DoNotImplementException that will not contain a stacktrace.
DoNotImplementException(String, boolean) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.DoNotImplementException
Creates a new DoNotImplementException.

E

equals(Object) - Method in class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
Compare the ClusterNodeAddress against another object.
eventRegistry() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
EventRegistry - Interface in com.hivemq.extension.sdk.api.events
Registry that allows the registration of different Event Listeners.
EXACTLY_ONCE - com.hivemq.extension.sdk.api.packets.general.Qos
At exactly once delivery.
Experimental - Annotation Type in com.hivemq.extension.sdk.api.annotations
Documents that this interface is experimental and might be subject to change in future HiveMQ versions.
extensionExecutorService() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
ExtensionInformation - Interface in com.hivemq.extension.sdk.api.parameter
Detailed information about an extension.
ExtensionMain - Interface in com.hivemq.extension.sdk.api
The main starting point for each HiveMQ extension.
extensionStart(ExtensionStartInput, ExtensionStartOutput) - Method in interface com.hivemq.extension.sdk.api.ExtensionMain
This method is called by HiveMQ if an extension is enabled.
It can be used to setup the extension and register client interceptors and callbacks with HiveMQ.
ExtensionStartInput - Interface in com.hivemq.extension.sdk.api.parameter
Input object for the start of an extension.
ExtensionStartOutput - Interface in com.hivemq.extension.sdk.api.parameter
Output object for the start of an extension.
extensionStop(ExtensionStopInput, ExtensionStopOutput) - Method in interface com.hivemq.extension.sdk.api.ExtensionMain
This method is called by HiveMQ if an extension is disabled.
ExtensionStopInput - Interface in com.hivemq.extension.sdk.api.parameter
Input object when an extension is stopped.
ExtensionStopOutput - Interface in com.hivemq.extension.sdk.api.parameter
Output object when an extension is stopped.

F

failAuthentication() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
Fails the authentication for the client.
failAuthentication(ConnackReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
Fails the authentication for the client.
failAuthentication(String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
Fails the authentication for the client.
failAuthorization() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Fails the authorization of the PUBLISH.
failAuthorization() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Fails the authorization of the subscription.
failAuthorization(AckReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Fails the authorization of the PUBLISH.
failAuthorization(AckReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
Fails the authorization of the PUBLISH.
failAuthorization(SubackReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Fails the authorization of the subscription.
failAuthorization(SubackReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
Fails the authorization of the subscription.
FAILURE - com.hivemq.extension.sdk.api.async.TimeoutFallback
FAILURE usually means that HiveMQ aborts any further action.
fillInStackTrace() - Method in exception com.hivemq.extension.sdk.api.services.exception.DoNotImplementException
 
fillInStackTrace() - Method in exception com.hivemq.extension.sdk.api.services.exception.InvalidTopicException
 
fillInStackTrace() - Method in exception com.hivemq.extension.sdk.api.services.exception.NoSuchClientIdException
 
fromCode(int) - Static method in enum com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Returns the Retain Handling belonging to the given byte code.
fromPublish(PublishPacket) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Create a Publish from the values of a PublishPacket.
fromPublish(PublishPacket) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Create a RetainedPublish from the values of a PublishPacket.
fromPublish(PublishPacket) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Create a WillPublishPacket from the values of a PublishPacket.
fromPublish(Publish) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Create a Publish from the values of a another Publish.
fromPublish(Publish) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Create a RetainedPublish from the values of a Publish.
fromPublish(Publish) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Create a WillPublishPacket from the values of a Publish.
fromSubscription(Subscription) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Create a TopicSubscription from the values of a Subscription.
fromWillPublish(WillPublishPacket) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Create a WillPublishPacket from the values of another WillPublishPacket.

G

get(String) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Retrieves the value of the connection attribute with the given key for the connected client.
getActivity() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
The activity is used to define for which type of the action (PUBLISH/Subscription) the topic permission is applied.
getAll() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Retrieves all connection attributes for the connected client.
getAllForName(String) - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperties
 
getAllInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext
Returns all Interceptor which are registered for this client.
getAsString(String) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Retrieves the value of the connection attribute with the given key for the connected client as UTF-8 string.
getAsString(String, Charset) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Retrieves the value of the connection attribute with the given key for the connected client as string with the given charset.
getAuthenticationData() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
If this property is present, the ByteBuffer contains the data used for the extended authentication.
getAuthenticationMethod() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
If this property is present, the string contains the authentication method that should be used for the extended authentication.
getAuthenticator(AuthenticatorProviderInput) - Method in interface com.hivemq.extension.sdk.api.services.auth.provider.AuthenticatorProvider
This method is called for each client by HiveMQ.
getAuthor() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionInformation
 
getAuthorizer(AuthorizerProviderInput) - Method in interface com.hivemq.extension.sdk.api.services.auth.provider.AuthorizerProvider
This method is called for each client by HiveMQ.
getBindAddress() - Method in interface com.hivemq.extension.sdk.api.client.parameter.Listener
The bind address of HiveMQ the client is connected to.
getCertificate() - Method in interface com.hivemq.extension.sdk.api.client.parameter.TlsInformation
 
getCertificateChain() - Method in interface com.hivemq.extension.sdk.api.client.parameter.TlsInformation
 
getCipherSuite() - Method in interface com.hivemq.extension.sdk.api.client.parameter.TlsInformation
 
getCleanStart() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
Flag that indicates if the existing session for the client should be continued (false) or the existing session should be overwritten (true).
getClientId() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ClientInformation
The client id of the MQTT client.
getClientId() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The client identifier the client wants to use.
getClientId() - Method in exception com.hivemq.extension.sdk.api.services.exception.NoSuchClientIdException
Returns the unknown MQTT ClientId.
getClientIdentifier() - Method in interface com.hivemq.extension.sdk.api.services.session.SessionInformation
 
getClientInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ClientBasedInput
 
getClientLifecycleEventListener(ClientLifecycleEventListenerProviderInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListenerProvider
This method is called by HiveMQ every time a new MQTT connection is started.
getCode() - Method in enum com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Get the retain handling as integer.
getConnectionAttributeStore() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
A store where client specific information can be stored for the duration of the connection.
getConnectionInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ClientBasedInput
 
getConnectPacket() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthInput
Get the unmodifiable CONNECT packet for the MQTT client that has to be authenticated.
getConnectPacket() - Method in interface com.hivemq.extension.sdk.api.events.client.parameters.ConnectionStartInput
Get the unmodifiable CONNECT packet for the MQTT client.
getContentType() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the content type.
getContentType() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the content type.
getCorrelationData() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the correlation data.
getCorrelationData() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the correlation data.
getDataFolder() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation
The location of the 'data' folder containing the data for the HiveMQ instance.
getDefaultBehaviour() - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
The default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.
getDefaultPermissions() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
The default permissions for the client.
getDefaultPermissions() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext
The default permissions for this client.
getDupFlag() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If false this is the first occasion the message is sent to the receiver.
getEnabledExtensions() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartInput
 
getEnabledExtensions() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStopInput
 
getExtensionHomeFolder() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionInformation
 
getExtensionInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartInput
 
getExtensionInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStopInput
 
getExtensionsFolder() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation
The location of the 'extensions' folder that contains all extension.
getFirst(String) - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperties
 
getHomeFolder() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation
The location of the 'home' folder where HiveMQ is installed.
getHost() - Method in class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
 
getId() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionInformation
 
getImplementedClass() - Method in exception com.hivemq.extension.sdk.api.services.exception.DoNotImplementException
Returns the name of the implemented class.
getInetAddress() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
The client's IP address.
getKeepAlive() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
An interval in seconds in which the client has to send any MQTT control packet, so that HiveMQ doesn't end the connection.
getListener() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
The listener of HiveMQ the client is connected to.
getListenerType() - Method in interface com.hivemq.extension.sdk.api.client.parameter.Listener
The type of the listener the client uses for the connection to HiveMQ.
getLogFolder() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation
The location of the 'log' folder containing everything related to logs.
getMaximumPacketSize() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The maximum packet size in bytes for an MQTT Control Packet, the client is willing to accept.
getMessageExpiryInterval() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the message expiry interval.
getMessageExpiryInterval() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the message expiry interval.
getMqttVersion() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
The MQTT version of the client.
getMqttVersion() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The MqttVersion the clients wants to use for the connection.
getName() - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperty
 
getName() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionInformation
 
getNoLocal() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.Subscription
The no local flag indicates if the client wants to receive messages published by itself to the topic filter of the subscription.
getNoLocal() - Method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
The no local flag indicates if the client wants to receive messages published by itself to the topic filter of the subscription.
getOutboundUserProperties() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
A ModifiableUserProperties to add or remove user properties to or from the outgoing CONNACK packet.
getOutput() - Method in interface com.hivemq.extension.sdk.api.async.Async
Return the original output object.
getOwnAddress() - Method in interface com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterDiscoveryInput
Provides the address of the HiveMQ instance the extension is executed on.
getOwnClusterId() - Method in interface com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterDiscoveryInput
Provides the cluster id of the HiveMQ instance the extension is executed on.
getPacketId() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
The packet identifier of the publish.
getPassword() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
If this property is present, this is the password for the client.
getPayload() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the payload.
getPayload() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the payload.
getPayloadFormatIndicator() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the payload format indicator.
getPayloadFormatIndicator() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the payload format indicator.
getPort() - Method in interface com.hivemq.extension.sdk.api.client.parameter.Listener
The port of HiveMQ the client is connected to.
getPort() - Method in class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
 
getPreviousVersion() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartInput
 
getProtocol() - Method in interface com.hivemq.extension.sdk.api.client.parameter.TlsInformation
 
getProxyAddress() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
 
getProxyInformation() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
The proxy protocol information for this connection.
getProxyPort() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
 
getPublishInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext
Returns all PublishInboundInterceptor which are registered for this client by this extension.
getPublishPacket() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerInput
Get the unmodifiable publish packet that has to be authorized.
getPublishPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundInput
The unmodifiable PUBLISH packet that was intercepted.
getPublishPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
Use this object to make any changes to the inbound PUBLISH.
getPublishRetain() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
Retain is used to check for what type of PUBLISH message (normal/retained message) the topic permission is applied.
getQos() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
The quality of service (Qos) levels are used to define for which QoS levels the topic permission is applied.
getQos() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
The quality of service level of the publish.
getQos() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.Subscription
The quality of service level of the subscription.
getQos() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
The quality of service level of the publish.
getQos() - Method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
The quality of service level of the subscription.
getQosNumber() - Method in enum com.hivemq.extension.sdk.api.packets.general.Qos
Get the quality service level as integer.
getRawTLVs() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
HiveMQ supports arbitrary TLVs, even TLVs that aren't specified by the PROXY protocol.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.events.client.parameters.DisconnectEventInput
 
getReasonString() - Method in interface com.hivemq.extension.sdk.api.events.client.parameters.DisconnectEventInput
 
getReceiveMaximum() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The limit of QoS 1 and QoS 2 Publishes that the client is willing to process concurrently.
getReloadInterval() - Method in interface com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterDiscoveryInput
Provides the current reload interval for updating the addresses of all HiveMQ cluster nodes.
getRequestProblemInformation() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
This flag indicates if the server may sent Reason String or User Properties in the case of failures.
getRequestResponseInformation() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
This flag indicates if the client wants to receive Response Information in the CONNACK packet (true) or not (false).
getResponseTopic() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If this property is present, this is the response topic.
getResponseTopic() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If this property is present, this is the response topic.
getRetain() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
If true this message is a retained message, for false this is just a normal publish.
getRetain() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
If true this message is a retained message, for false this is just a normal publish.
getRetain() - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedPublish
 
getRetainAsPublished() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.Subscription
The retain as published flag indicates if the client wants the retain flag preserved for received messages to the topic filter of the subscription.
getRetainAsPublished() - Method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
The retain as published flag indicates if the client wants the retain flag preserved for received messages to the topic filter of the subscription.
getRetainedMessage(String) - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore
Get the retained message for a topic, if it exist.
getRetainHandling() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.Subscription
The retain handling states how a retained message should be send for a subscription.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.AuthenticatorProviderInput
Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.AuthorizerProviderInput
Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.client.parameter.InitializerInput
Get information about the HiveMQ instance the extension is running in.
getSession(String) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService
Returns additional client information about a given client with a given client identifier.
getSessionExpiryInterval() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
Duration in seconds how long session for the client is stored.
getSessionExpiryInterval() - Method in interface com.hivemq.extension.sdk.api.services.session.SessionInformation
The session expiry interval, when the session information of the client will be deleted after the client disconnected.
getSharedGroup() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
The shared group is used to check for what shared group the topic permission is applied.
getSharedSubscription() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
The shared subscription is used to check for what type of Subscription (normal/shared subscription) the topic permission is applied.
getSourceAddress() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
 
getSourcePort() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
 
getSslCertificateCN() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection with a X509 client certificate that is sent by the MQTT client, this method returns the forwarded common name of the X509 client certificate (if the client used one to authenticate the SSL connection).
getStatus() - Method in interface com.hivemq.extension.sdk.api.async.Async
Return the current status of the async option.
getSubscription() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerInput
Get the unmodifiable subscription that has to be authorized.
getSubscriptionIdentifier() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerInput
If this property is present, it contains the subscription identifier for the SUBSCRIBE packet.
getSubscriptionIdentifier() - Method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
The current subscription identifier that is associated with the subscription.
getSubscriptionIdentifiers() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
The list of subscription identifiers for PUBLISH.
getSubscriptions(String) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore
Returns all subscriptions a client is subscribed to.
getTlsInformation() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation
Information about TLS, should the client be connected to HiveMQ via an TLS listener.
getTlsVersion() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ProxyInformation
If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection, this method returns the TLS version of the original SSL connection.
getTopic() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
The topic filter the message is published to.
getTopic() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
The topic filter the message is published to.
getTopicAliasMaximum() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The maximum amount of topic alias the client allows for this connection.
getTopicFilter() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
The topic filter is used to define for what topic filter the topic permission is applied.
getTopicFilter() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.Subscription
The topic filter the client wants to subscribe to.
getTopicFilter() - Method in exception com.hivemq.extension.sdk.api.services.exception.InvalidTopicException
Returns the invalid topic filter.
getTopicFilter() - Method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription
The topic filter of the subscription.
getType() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.TopicPermission
If the PUBLISH/Subscription matches all criteria defined in the topic permission, the permission type decides if the PUBLISH/Subscription is authorized or not.
getUserName() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
If this property is present, this is the username for the client.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerInput
The user properties from the SUBSCRIBE packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.events.client.parameters.DisconnectEventInput
 
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
The user properties from the CONNECT packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Get the modifiable UserProperties of the PUBLISH packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket
The UserProperties of the PUBLISH.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.services.publish.Publish
The UserProperties of the PUBLISH.
getValue() - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperty
 
getVersion() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation
 
getVersion() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionInformation
 
getWillDelay() - Method in interface com.hivemq.extension.sdk.api.packets.connect.WillPublishPacket
Delay in seconds before the Will Publish is sent.
getWillPublish() - Method in interface com.hivemq.extension.sdk.api.packets.connect.ConnectPacket
Contains the WillPublishPacket if it was sent in the CONNECT packet.
GRANTED_QOS_0 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
This is not an error code.
GRANTED_QOS_1 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
This is not an error code.
GRANTED_QOS_2 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
This is not an error code

H

hashCode() - Method in class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
 

I

Immutable - Annotation Type in com.hivemq.extension.sdk.api.annotations
A marker annotation interface which marks a class as immutable.
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
init(ClusterDiscoveryInput, ClusterDiscoveryOutput) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterDiscoveryCallback
This method is called once by HiveMQ when this callback is added via ClusterService.addDiscoveryCallback(ClusterDiscoveryCallback).
initialize(InitializerInput, ClientContext) - Method in interface com.hivemq.extension.sdk.api.services.intializer.ClientInitializer
This method is called for every client when the client is connected and a session is either created or exists.
InitializerInput - Interface in com.hivemq.extension.sdk.api.client.parameter
This interface can be used to provide additional information in an initializer.
initializerRegistry() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
InitializerRegistry - Interface in com.hivemq.extension.sdk.api.services.intializer
 
Interceptor - Interface in com.hivemq.extension.sdk.api.interceptor
Marker interface for Interceptors.
invalidateSession(String) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService
Invalidates the client session for a client with the given client identifier.
InvalidTopicException - Exception in com.hivemq.extension.sdk.api.services.exception
This exception is used to signal that a given topic filter is invalid.
InvalidTopicException(String) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.InvalidTopicException
Creates a new InvalidTopicException that will not contain a stacktrace.
InvalidTopicException(String, boolean) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.InvalidTopicException
Creates a new InvalidTopicException.
isClientConnected(String) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService
Check if a client with a given identifier is currently connected
isConnected() - Method in interface com.hivemq.extension.sdk.api.services.session.SessionInformation
 
isEmpty() - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperties
 

K

KEEP_ALIVE_TIMEOUT - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
KEEP_ALIVE_TIMEOUT - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 

L

LimitExceededException - Exception in com.hivemq.extension.sdk.api.services.exception
Unchecked Exception which is thrown when a limit is exceeded by a passed parameter.
LimitExceededException(String) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.LimitExceededException
 
Listener - Interface in com.hivemq.extension.sdk.api.client.parameter
Holds information about the listener a client uses for a connection to HiveMQ.
ListenerType - Enum in com.hivemq.extension.sdk.api.client.parameter
The type of a Listener.

M

MALFORMED_PACKET - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
MALFORMED_PACKET - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
MALFORMED_PACKET - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
ManagedExtensionExecutorService - Interface in com.hivemq.extension.sdk.api.services
A shared thread pool executor which is a ScheduledExecutorService.
MAXIMUM_CONNECT_TIME - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
MAXIMUM_CONNECT_TIME - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
MESSAGE_RATE_TOO_HIGH - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
MESSAGE_RATE_TOO_HIGH - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
messageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the message expiry interval in seconds.
messageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the message expiry interval in seconds.
messageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the message expiry interval in seconds.
metricRegistry() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
ModifiableDefaultPermissions - Interface in com.hivemq.extension.sdk.api.packets.auth
Default permissions enable the authorization of PUBLISH/Subscriptions if no Authorizer is used.
ModifiablePublishPacket - Interface in com.hivemq.extension.sdk.api.packets.publish
A copy of an PublishPacket that can be modified for onward delivery.
ModifiableUserProperties - Interface in com.hivemq.extension.sdk.api.packets.general
Interface to modify UserProperties received from any MQTT packet.
MqttVersion - Enum in com.hivemq.extension.sdk.api.packets.general
The MQTT version of a client.

N

nextExtensionOrDefault() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput
The outcome of the authorization is determined by the next extension with a PublishAuthorizer.
nextExtensionOrDefault() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput
The outcome of the authentication is determined by the next extension with an Authenticator.
nextExtensionOrDefault() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput
The outcome of the authorization is determined by the next extension with a SubscriptionAuthorizer.
NO_MATCHING_SUBSCRIBERS - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
noLocal(boolean) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Sets the no local flag.
NORMAL_DISCONNECTION - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
NORMAL_DISCONNECTION - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
NoSuchClientIdException - Exception in com.hivemq.extension.sdk.api.services.exception
This exception is used to signal that a given MQTT ClientId is unknown to the broker in the given context.
NoSuchClientIdException(String) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.NoSuchClientIdException
Creates a new NoSuchClientException that will not contain a stacktrace.
NoSuchClientIdException(String, boolean) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.NoSuchClientIdException
Creates a new NoSuchClientException.
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
NOT_RETAINED - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Retain
Only applied for normal PUBLISH messages.
NOT_SHARED - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription
Only applied for normal subscriptions.
NOT_SUBSCRIBED - com.hivemq.extension.sdk.api.services.publish.PublishToClientResult
The client had no matching subscription.
NotNull - Annotation Type in com.hivemq.extension.sdk.api.annotations
An annotation which is used for indicating that something can not be null.
This is very useful for static code analysis to prevent bugs.
Nullable - Annotation Type in com.hivemq.extension.sdk.api.annotations
An annotation which is used for indicating that something can be null.
This is very useful for static code analysis to prevent bugs.

O

onAuthenticationFailedDisconnect(AuthenticationFailedInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called when a client is disconnected by the server when the authentication for this MQTT connection failed.
onAuthenticationSuccessful(AuthenticationSuccessfulInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called by HiveMQ after an MQTT connection is successfully authenticated.
onClientInitiatedDisconnect(ClientInitiatedDisconnectInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called when a client disconnects by sending a MQTT DISCONNECT packet to the server.
onConnect(SimpleAuthInput, SimpleAuthOutput) - Method in interface com.hivemq.extension.sdk.api.auth.SimpleAuthenticator
This method is called for CONNECT packet, that the SimpleAuthenticator is delegated to authenticate.
onConnectionLost(ConnectionLostInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called when a client is disconnected because the connection is lost.
onDisconnect(DisconnectEventInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is the default method called by HiveMQ for all cases where a client disconnects.
ONE - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Only applied for QoS 1.
ONE_TWO - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Applied for QoS 1 and 2.
onInboundPublish(PublishInboundInput, PublishInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.PublishInboundInterceptor
When a PublishInboundInterceptor is set through any extension, this method gets called for every inbound PUBLISH packet from any MQTT client.
onMqttConnectionStart(ConnectionStartInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called by HiveMQ when an MQTT connection is started by the client.
onServerInitiatedDisconnect(ServerInitiatedDisconnectInput) - Method in interface com.hivemq.extension.sdk.api.events.client.ClientLifecycleEventListener
This method is called when a client is disconnected by the server with an MQTT DISCONNECT or CONNACK packet for any other reason than a failed authentication.

P

PACKET_IDENTIFIER_IN_USE - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
PACKET_IDENTIFIER_IN_USE - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
PACKET_TOO_LARGE - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
PACKET_TOO_LARGE - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
PACKET_TOO_LARGE - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
payload(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the payload.
payload(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the payload.
payload(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the payload.
PAYLOAD_FORMAT_INVALID - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
PAYLOAD_FORMAT_INVALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
PAYLOAD_FORMAT_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
PAYLOAD_FORMAT_INVALID - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
payloadFormatIndicator(PayloadFormatIndicator) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the payload format indicator.
payloadFormatIndicator(PayloadFormatIndicator) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the payload format indicator.
payloadFormatIndicator(PayloadFormatIndicator) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the payload format indicator.
PayloadFormatIndicator - Enum in com.hivemq.extension.sdk.api.packets.publish
Indicator for the payload.
preventExtensionStartup(String) - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartOutput
Prevents the further startup of this extension.
preventPublishDelivery() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
Prevent the onward delivery of the PUBLISH packet with reason code AckReasonCode.SUCCESS for the PUBACK/PUBREC.
preventPublishDelivery(AckReasonCode) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
Prevent the onward delivery of the PUBLISH packet with reasonCode set as reason code in the PUBACK/PUBREC.
preventPublishDelivery(AckReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishInboundOutput
Prevent the onward delivery of the PUBLISH packet with reasonCode and reasonString set as reason code and reason string in the PUBACK/PUBREC respectively.
PROTOCOL_ERROR - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
PROTOCOL_ERROR - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
PROTOCOL_ERROR - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
provideCurrentNodes(List<ClusterNodeAddress>) - Method in interface com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterDiscoveryOutput
Provides the current addresses of all HiveMQ cluster nodes.
ProxyInformation - Interface in com.hivemq.extension.sdk.api.client.parameter
This class encapsulates all information that is forwarded by a load balancer which uses the PROXY protocol.
publish() - Static method in class com.hivemq.extension.sdk.api.services.builder.Builders
 
publish(Publish) - Method in interface com.hivemq.extension.sdk.api.services.publish.PublishService
Publishes a new MQTT Publish message.
Publish - Interface in com.hivemq.extension.sdk.api.services.publish
Represents a PUBLISH.
PUBLISH - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.MqttActivity
Only applied for PUBLISHes.
PublishAuthorizer - Interface in com.hivemq.extension.sdk.api.auth
Interface for the PUBLISH authorization.
PublishAuthorizerInput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the input parameter of any PublishAuthorizer providing an unmodifiable inbound PublishPacket and ClientBasedInput.
PublishAuthorizerOutput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the output parameter of any PublishAuthorizer providing methods to define the outcome of the PUBLISH authorization.
PublishBuilder - Interface in com.hivemq.extension.sdk.api.services.builder
This builder must be used to create a Publish.
PublishInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.publish.parameter
This is the input parameter of any PublishInboundInterceptor providing PUBLISH, connection and client based information.
PublishInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.publish
Interface for the publish inbound interception.
PublishInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.publish.parameter
This is the output parameter of any PublishInboundInterceptor providing methods to define the outcome of PUBLISH interception.
PublishPacket - Interface in com.hivemq.extension.sdk.api.packets.publish
Represents a PUBLISH packet.
publishService() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
PublishService - Interface in com.hivemq.extension.sdk.api.services.publish
This service allows extensions to publish new MQTT messages programmatically.
publishToClient(Publish, String) - Method in interface com.hivemq.extension.sdk.api.services.publish.PublishService
Publishes a new MQTT Publish message to a single client.
PublishToClientResult - Enum in com.hivemq.extension.sdk.api.services.publish
Used to inform if the publish to the client had a matching subscription.
put(String, ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Sets the given connection attribute for the connected client.
putAsString(String, String) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Sets the given connection attribute as UTF-8 String representation for the connected client.
putAsString(String, String, Charset) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Sets the given connection attribute as String representation for the connected client with a given charset.

Q

qos(Qos) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the quality of service.
qos(Qos) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the quality of service.
qos(Qos) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Sets the quality of service level.
qos(Qos) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the quality of service level.
qos(TopicPermission.Qos) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a QoS for this TopicPermission.
Qos - Enum in com.hivemq.extension.sdk.api.packets.general
The quality of service level (QOS) of a PUBLISH or subscription.
QOS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
QOS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
QOS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
QUOTA_EXCEEDED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
QUOTA_EXCEEDED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
QUOTA_EXCEEDED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
QUOTA_EXCEEDED - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
QUOTA_EXCEEDED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.

R

RateLimitExceededException - Exception in com.hivemq.extension.sdk.api.services.exception
This exception is used to signal that the configured extension service rate limit has been exceeded.
RateLimitExceededException() - Constructor for exception com.hivemq.extension.sdk.api.services.exception.RateLimitExceededException
 
RECEIVE_MAXIMUM_EXCEEDED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
RECEIVE_MAXIMUM_EXCEEDED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
reload(ClusterDiscoveryInput, ClusterDiscoveryOutput) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterDiscoveryCallback
This method is called regularly by HiveMQ to discover all current available cluster nodes.
remove(TopicPermission) - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
Removes a specific TopicPermission from the default permission for this client.
remove(String) - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionAttributeStore
Removes the connection attribute with the given key for the connected client.
remove(String) - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore
Removes the retained message for the given topic.
removeDiscoveryCallback(ClusterDiscoveryCallback) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterService
removeName(String) - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties
Remove every UserProperty with the specified name.
removePublishInboundInterceptor(PublishInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext
Removes an PublishInboundInterceptor for this client.
removeSubscription(String, String) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore
This method removes a subscription for a certain client and a certain topic.
removeSubscriptions(String, Set<String>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore
This method removes multiple subscriptions for a certain client.
removeUserProperty(String, String) - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties
Remove a UserProperty.
responseTopic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the response topic.
responseTopic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the response topic.
responseTopic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the response topic.
resume() - Method in interface com.hivemq.extension.sdk.api.async.Async
Signal HiveMQ that the async action is done and normal extension operations can resume.
retain(boolean) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the retain flag.
retain(boolean) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the retain flag.
retain(TopicPermission.Retain) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a Retain for this TopicPermission.
RETAIN_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
RETAIN_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
RETAIN_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
retainAsPublished(boolean) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Sets the retain as published flag.
RETAINED - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Retain
Only applied for retained PUBLISH messages.
retainedMessageStore() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
RetainedMessageStore - Interface in com.hivemq.extension.sdk.api.services.publish
The retained message store allows the management of retained messages from within extensions.
retainedPublish() - Static method in class com.hivemq.extension.sdk.api.services.builder.Builders
 
RetainedPublish - Interface in com.hivemq.extension.sdk.api.services.publish
 
RetainedPublishBuilder - Interface in com.hivemq.extension.sdk.api.services.builder
This builder must be used to create a RetainedPublish.
RetainHandling - Enum in com.hivemq.extension.sdk.api.packets.subscribe
The retain handling of a subscription.
RUNNING - com.hivemq.extension.sdk.api.async.Async.Status
The async operation is still ongoing.

S

schedule(Runnable, long, TimeUnit) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
schedule(Callable<V>, long, TimeUnit) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
securityRegistry() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
SecurityRegistry - Interface in com.hivemq.extension.sdk.api.services.auth
The SecurityRegistry allows extensions to define the authentication and authorization of MQTT clients.
SEND - com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Send every retained message for any subscription.
SEND_IF_NEW_SUBSCRIPTION - com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Send every retained message for new subscriptions only.
SERVER_BUSY - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_SERVER_UNAVAILABLE.
SERVER_BUSY - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SERVER_BUSY - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SERVER_MOVED - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_SERVER_UNAVAILABLE.
SERVER_MOVED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SERVER_MOVED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SERVER_SHUTTING_DOWN - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SERVER_SHUTTING_DOWN - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SERVER_UNAVAILABLE - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_SERVER_UNAVAILABLE.
SERVER_UNAVAILABLE - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
ServerInformation - Interface in com.hivemq.extension.sdk.api.client.parameter
The server information contains specific data about HiveMQ instance the extensions runs in.
ServerInitiatedDisconnectInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters
Services - Class in com.hivemq.extension.sdk.api.services
Services provide a convenient way for extensions to interact with the HiveMQ core.
Services() - Constructor for class com.hivemq.extension.sdk.api.services.Services
 
SESSION_TAKEN_OVER - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SESSION_TAKEN_OVER - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SessionInformation - Interface in com.hivemq.extension.sdk.api.services.session
Information about the session of an MQTT client.
setAuthenticatorProvider(AuthenticatorProvider) - Method in interface com.hivemq.extension.sdk.api.services.auth.SecurityRegistry
 
setAuthorizerProvider(AuthorizerProvider) - Method in interface com.hivemq.extension.sdk.api.services.auth.SecurityRegistry
 
setClientInitializer(ClientInitializer) - Method in interface com.hivemq.extension.sdk.api.services.intializer.InitializerRegistry
Every extension can call this method once.
setClientLifecycleEventListener(ClientLifecycleEventListenerProvider) - Method in interface com.hivemq.extension.sdk.api.events.EventRegistry
Sets a provider for ClientLifecycleEventListener.
setContentType(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the content type.
setCorrelationData(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the correlation data.
setDefaultBehaviour(DefaultAuthorizationBehaviour) - Method in interface com.hivemq.extension.sdk.api.packets.auth.ModifiableDefaultPermissions
Overrides the default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.
setMessageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the message expiry interval.
setPayload(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the payload.
setPayloadFormatIndicator(PayloadFormatIndicator) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the payload format indicator.
setQos(Qos) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
This does not change the QoS to the publisher.
setReloadInterval(int) - Method in interface com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterDiscoveryOutput
Overwrites the current reload interval for updating the addresses of all HiveMQ cluster nodes.
setResponseTopic(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the response topic.
setRetain(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the retain flag.
setTopic(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket
Sets the topic.
SHARED - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription
Only applied for shared subscriptions.
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
sharedGroup(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a shared group for this TopicPermission.
sharedSubscription(TopicPermission.SharedSubscription) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a SharedSubscription for this TopicPermission.
shutdown() - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
Deprecated.
shutdownNow() - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
Deprecated.
SimpleAuthenticator - Interface in com.hivemq.extension.sdk.api.auth
Interface for the simple authentication without AUTH packets.
SimpleAuthInput - Interface in com.hivemq.extension.sdk.api.auth.parameter
The input object of any SimpleAuthenticator providing an unmodifiable ConnectPacket and ClientBasedInput.
SimpleAuthOutput - Interface in com.hivemq.extension.sdk.api.auth.parameter
Output object provided to the methods of a SimpleAuthenticator.
SubackReasonCode - Enum in com.hivemq.extension.sdk.api.packets.subscribe
The SUBACK reason codes for MQTT 5.
submit(Runnable) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
submit(Runnable, T) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
submit(Callable<T>) - Method in interface com.hivemq.extension.sdk.api.services.ManagedExtensionExecutorService
 
SUBSCRIBE - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.MqttActivity
Only applied for Subscriptions.
Subscription - Interface in com.hivemq.extension.sdk.api.packets.subscribe
Represents a subscription from a SUBSCRIBE packet.
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
SubscriptionAuthorizer - Interface in com.hivemq.extension.sdk.api.auth
Interface for the subscription authorization.
SubscriptionAuthorizerInput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the input parameter of any SubscriptionAuthorizer providing unmodifiable information about the Subscription and ClientBasedInput.
SubscriptionAuthorizerOutput - Interface in com.hivemq.extension.sdk.api.auth.parameter
This is the output parameter of any SubscriptionAuthorizer providing methods to define the outcome of the subscription authorization.
subscriptionIdentifier(int) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Sets the subscription identifier.
subscriptionStore() - Static method in class com.hivemq.extension.sdk.api.services.Services
 
SubscriptionStore - Interface in com.hivemq.extension.sdk.api.services.subscription
This service allows extensions to manage the Subscriptions for client session programmatically.
SUCCESS - com.hivemq.extension.sdk.api.async.TimeoutFallback
SUCCESS usually means that HiveMQ either sees the outcome as successful or asks the next extension, that also implemented the specific service.
SUCCESS - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code ACCEPTED.
SUCCESS - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
SUCCESS - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
SUCCESSFUL - com.hivemq.extension.sdk.api.services.publish.PublishToClientResult
The client had a matching subscription.

T

TCP_LISTENER - com.hivemq.extension.sdk.api.client.parameter.ListenerType
A TCP Listener is used.
ThreadSafe - Annotation Type in com.hivemq.extension.sdk.api.annotations
An annotation which is used for indicating that a class is thread safe.
TimeoutFallback - Enum in com.hivemq.extension.sdk.api.async
The TimeoutFallback defines the strategy that will be applied after an Async operation timed out.
TLS_TCP_LISTENER - com.hivemq.extension.sdk.api.client.parameter.ListenerType
A TCP Listener with TLS is used.
TLS_WEBSOCKET_LISTENER - com.hivemq.extension.sdk.api.client.parameter.ListenerType
A Websocket Listener with TLS is used.
TlsInformation - Interface in com.hivemq.extension.sdk.api.client.parameter
The TLS information contains specific data about the TLS connection, should the client use TLS.
topic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Sets the topic.
topic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Sets the topic.
topic(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the topic.
TOPIC_ALIAS_INVALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
TOPIC_ALIAS_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
TOPIC_NAME_INVALID - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
TOPIC_NAME_INVALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
TOPIC_NAME_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
TOPIC_NAME_INVALID - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
topicFilter(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a topic filter for this TopicPermission.
topicFilter(String) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder
Sets the topic filter.
topicPermission() - Static method in class com.hivemq.extension.sdk.api.services.builder.Builders
 
TopicPermission - Interface in com.hivemq.extension.sdk.api.auth.parameter
A topic permission represents an authorization action.
TopicPermission.MqttActivity - Enum in com.hivemq.extension.sdk.api.auth.parameter
The activity the topic permission is applied to.
TopicPermission.PermissionType - Enum in com.hivemq.extension.sdk.api.auth.parameter
Represents if the PUBLISH/Subscription that matches the topic permission is allowed or denied.
TopicPermission.Qos - Enum in com.hivemq.extension.sdk.api.auth.parameter
Matching quality of service levels for the topic permission.
TopicPermission.Retain - Enum in com.hivemq.extension.sdk.api.auth.parameter
Represents the type of PUBLISH the topic permission is applied for.
TopicPermission.SharedSubscription - Enum in com.hivemq.extension.sdk.api.auth.parameter
Represents the typ of Subscription the topic permission is applied for.
TopicPermissionBuilder - Interface in com.hivemq.extension.sdk.api.services.builder
This builder allows to create TopicPermissions that can be used in the extension system.
topicSubscription() - Static method in class com.hivemq.extension.sdk.api.services.builder.Builders
 
TopicSubscription - Interface in com.hivemq.extension.sdk.api.services.subscription
Represents a Subscription.
TopicSubscriptionBuilder - Interface in com.hivemq.extension.sdk.api.services.builder
This builder must be used to create a TopicSubscription.
toString() - Method in class com.hivemq.extension.sdk.api.services.cluster.parameter.ClusterNodeAddress
 
TWO - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Only applied for QoS 2.
type(TopicPermission.PermissionType) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicPermissionBuilder
Set a type for this TopicPermission.

U

UNSPECIFIED - com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator
The format of the bytes of the payload is not known.
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_NOT_AUTHORIZED.
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
 
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
UNSUPPORTED_PROTOCOL_VERSION - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_UNACCEPTABLE_PROTOCOL_VERSION.
UNSUPPORTED_PROTOCOL_VERSION - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
USE_ANOTHER_SERVER - com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
For an MQTT 3 client this will be translated to the return code REFUSED_SERVER_UNAVAILABLE.
USE_ANOTHER_SERVER - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
USE_ANOTHER_SERVER - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
UserProperties - Interface in com.hivemq.extension.sdk.api.packets.general
The user properties of an MQTT packet.
userProperty(String, String) - Method in interface com.hivemq.extension.sdk.api.services.builder.PublishBuilder
Adds a user property.
userProperty(String, String) - Method in interface com.hivemq.extension.sdk.api.services.builder.RetainedPublishBuilder
Adds a user property.
userProperty(String, String) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Adds a user property.
UserProperty - Interface in com.hivemq.extension.sdk.api.packets.general
A representation for a user property.
UTF_8 - com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator
The format of the bytes of the payload is UTF-8.

V

V_3_1 - com.hivemq.extension.sdk.api.packets.general.MqttVersion
MQTT 3.1 version.
V_3_1_1 - com.hivemq.extension.sdk.api.packets.general.MqttVersion
MQTT 3.1.1 version.
V_5 - com.hivemq.extension.sdk.api.packets.general.MqttVersion
MQTT 5 version.
value() - Method in annotation type com.hivemq.extension.sdk.api.annotations.NotNull
 
value() - Method in annotation type com.hivemq.extension.sdk.api.annotations.Nullable
 
value() - Method in annotation type com.hivemq.extension.sdk.api.annotations.ThreadSafe
 
valueOf(int) - Static method in enum com.hivemq.extension.sdk.api.packets.general.Qos
Creates a Qos level enum from an integer.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.async.Async.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.async.TimeoutFallback
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.MqttActivity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.PermissionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Retain
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.client.parameter.ListenerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.auth.DefaultAuthorizationBehaviour
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.general.MqttVersion
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.general.Qos
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.services.publish.PublishToClientResult
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.hivemq.extension.sdk.api.async.Async.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.async.TimeoutFallback
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.MqttActivity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.PermissionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Retain
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.client.parameter.ListenerType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.auth.DefaultAuthorizationBehaviour
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.connect.ConnackReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.general.MqttVersion
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.general.Qos
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.hivemq.extension.sdk.api.services.publish.PublishToClientResult
Returns an array containing the constants of this enum type, in the order they are declared.

W

WEBSOCKET_LISTENER - com.hivemq.extension.sdk.api.client.parameter.ListenerType
A Websocket Listener is used.
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode
 
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
 
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode
For an MQTT 3 SUBACK this translates to the return code FAILURE.
willDelay(long) - Method in interface com.hivemq.extension.sdk.api.services.builder.WillPublishBuilder
Sets the will delay.
willPublish() - Static method in class com.hivemq.extension.sdk.api.services.builder.Builders
 
WillPublishBuilder - Interface in com.hivemq.extension.sdk.api.services.builder
This builder must be used to create a WillPublishPacket.
WillPublishPacket - Interface in com.hivemq.extension.sdk.api.packets.connect
Contains all information for the Will Publish that is part of a CONNECT packet.

Z

ZERO - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Only applied for QoS 0.
ZERO_ONE - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Applied for QoS 0 and 1.
ZERO_TWO - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos
Applied for QoS 0 and 2.
A B C D E F G H I K L M N O P Q R S T U V W Z 
All Classes All Packages