Index (HiveMQ Extension SDK 4.5.6 API)

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

abortIteration() - Method in interface com.hivemq.extension.sdk.api.services.general.IterationContext: Aborts the iteration at the current step of the iteration.
AckReasonCode - Enum in com.hivemq.extension.sdk.api.packets.publish: MQTT 5 Reason codes for PUBACK and PUBREC.
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.
addDisconnectInboundInterceptor(DisconnectInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an DisconnectInboundInterceptor for this client.
addDisconnectOutboundInterceptor(DisconnectOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an DisconnectOutboundInterceptor 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.
addPingReqInboundInterceptor(PingReqInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PingReqInboundInterceptor for this client.
addPingRespOutboundInterceptor(PingRespOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PingRespOutboundInterceptor for this client.
addPubackInboundInterceptor(PubackInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubackInboundInterceptor for this client.
addPubackOutboundInterceptor(PubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubackOutboundInterceptor for this client.
addPubcompInboundInterceptor(PubcompInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubcompInboundInterceptor for this client.
addPubcompOutboundInterceptor(PubcompOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubcompOutboundInterceptor for this client.
addPublishInboundInterceptor(PublishInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PublishInboundInterceptor for this client.
addPublishOutboundInterceptor(PublishOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PublishOutboundInterceptor for this client.
addPubrecInboundInterceptor(PubrecInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubrecInboundInterceptor for this client.
addPubrecOutboundInterceptor(PubrecOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubrecOutboundInterceptor for this client.
addPubrelInboundInterceptor(PubrelInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubrelInboundInterceptor for this client.
addPubrelOutboundInterceptor(PubrelOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an PubrelOutboundInterceptor for this client.
addSubackOutboundInterceptor(SubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds a SubackOutboundInterceptor for this client.
addSubscribeInboundInterceptor(SubscribeInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an SubscribeInboundInterceptor 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.
addUnsubackOutboundInterceptor(UnsubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an UnsubackOutboundInterceptor for this client.
addUnsubscribeInboundInterceptor(UnsubscribeInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Adds an UnsubscribeInboundInterceptor for this 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: This is an unsuccessful code.
ADMINISTRATIVE_ACTION - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
adminService() - Static method in class com.hivemq.extension.sdk.api.services.Services
AdminService - Interface in com.hivemq.extension.sdk.api.services.admin: This service provides general information about the state of this HiveMQ instance.
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.
ALL - com.hivemq.extension.sdk.api.services.subscription.SubscriptionType: Include individual 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.SimpleAsyncOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.parameter.ConnackOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.suback.parameter.SubackOutboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.subscribe.parameter.SubscribeInboundOutput: If the timeout is expired before Async.resume() is called then the outcome is handled as failed.
async(Duration) - Method in interface com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter.UnsubscribeInboundOutput: 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) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: 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) - 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) - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.parameter.ConnackOutboundOutput: 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) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishOutboundOutput: 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) - Method in interface com.hivemq.extension.sdk.api.interceptor.subscribe.parameter.SubscribeInboundOutput: 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, DisconnectedReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: 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, DisconnectedReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: 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.EnhancedAuthOutput: 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.EnhancedAuthOutput: Successfully authenticates the client.
authenticateSuccessfully() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Successfully authenticates the client.
authenticateSuccessfully(@com.hivemq.extension.sdk.api.annotations.NotNull byte[]) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Successfully authenticates the client.
authenticateSuccessfully(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Successfully authenticates the client.
AuthenticationFailedInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters: Input object for the method ClientLifecycleEventListener.onAuthenticationFailedDisconnect(AuthenticationFailedInput).
AuthenticationSuccessfulInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters: Input object for the method ClientLifecycleEventListener.onAuthenticationSuccessful(AuthenticationSuccessfulInput).
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.
AuthPacket - Interface in com.hivemq.extension.sdk.api.packets.auth: Represents an AUTH packet.
AuthReasonCode - Enum in com.hivemq.extension.sdk.api.packets.auth

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: This is an unsuccessful code.
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: Deprecated.
Use Builders.publish() instead
builder() - Static method in interface com.hivemq.extension.sdk.api.services.publish.RetainedPublish: Deprecated.
Use Builders.retainedPublish() instead
builder() - Static method in interface com.hivemq.extension.sdk.api.services.subscription.TopicSubscription: Deprecated.
Use Builders.topicSubscription() instead
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: Deprecated.
Must not be used for disconnect packets.
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: Input object for the method ClientLifecycleEventListener.onClientInitiatedDisconnect(ClientInitiatedDisconnectInput).
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: Input object for the method ClientLifecycleEventListenerProvider.getClientLifecycleEventListener(ClientLifecycleEventListenerProviderInput).
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.connack - package com.hivemq.extension.sdk.api.interceptor.connack
com.hivemq.extension.sdk.api.interceptor.connack.parameter - package com.hivemq.extension.sdk.api.interceptor.connack.parameter
com.hivemq.extension.sdk.api.interceptor.connect - package com.hivemq.extension.sdk.api.interceptor.connect
com.hivemq.extension.sdk.api.interceptor.connect.parameter - package com.hivemq.extension.sdk.api.interceptor.connect.parameter
com.hivemq.extension.sdk.api.interceptor.disconnect - package com.hivemq.extension.sdk.api.interceptor.disconnect
com.hivemq.extension.sdk.api.interceptor.disconnect.parameter - package com.hivemq.extension.sdk.api.interceptor.disconnect.parameter
com.hivemq.extension.sdk.api.interceptor.pingreq - package com.hivemq.extension.sdk.api.interceptor.pingreq
com.hivemq.extension.sdk.api.interceptor.pingreq.parameter - package com.hivemq.extension.sdk.api.interceptor.pingreq.parameter
com.hivemq.extension.sdk.api.interceptor.pingresp - package com.hivemq.extension.sdk.api.interceptor.pingresp
com.hivemq.extension.sdk.api.interceptor.pingresp.parameter - package com.hivemq.extension.sdk.api.interceptor.pingresp.parameter
com.hivemq.extension.sdk.api.interceptor.puback - package com.hivemq.extension.sdk.api.interceptor.puback
com.hivemq.extension.sdk.api.interceptor.puback.parameter - package com.hivemq.extension.sdk.api.interceptor.puback.parameter
com.hivemq.extension.sdk.api.interceptor.pubcomp - package com.hivemq.extension.sdk.api.interceptor.pubcomp
com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter - package com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter
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.interceptor.pubrec - package com.hivemq.extension.sdk.api.interceptor.pubrec
com.hivemq.extension.sdk.api.interceptor.pubrec.parameter - package com.hivemq.extension.sdk.api.interceptor.pubrec.parameter
com.hivemq.extension.sdk.api.interceptor.pubrel - package com.hivemq.extension.sdk.api.interceptor.pubrel
com.hivemq.extension.sdk.api.interceptor.pubrel.parameter - package com.hivemq.extension.sdk.api.interceptor.pubrel.parameter
com.hivemq.extension.sdk.api.interceptor.suback - package com.hivemq.extension.sdk.api.interceptor.suback
com.hivemq.extension.sdk.api.interceptor.suback.parameter - package com.hivemq.extension.sdk.api.interceptor.suback.parameter
com.hivemq.extension.sdk.api.interceptor.subscribe - package com.hivemq.extension.sdk.api.interceptor.subscribe
com.hivemq.extension.sdk.api.interceptor.subscribe.parameter - package com.hivemq.extension.sdk.api.interceptor.subscribe.parameter
com.hivemq.extension.sdk.api.interceptor.unsuback - package com.hivemq.extension.sdk.api.interceptor.unsuback
com.hivemq.extension.sdk.api.interceptor.unsuback.parameter - package com.hivemq.extension.sdk.api.interceptor.unsuback.parameter
com.hivemq.extension.sdk.api.interceptor.unsubscribe - package com.hivemq.extension.sdk.api.interceptor.unsubscribe
com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter - package com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter
com.hivemq.extension.sdk.api.packets.auth - package com.hivemq.extension.sdk.api.packets.auth
com.hivemq.extension.sdk.api.packets.connack - package com.hivemq.extension.sdk.api.packets.connack
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.puback - package com.hivemq.extension.sdk.api.packets.puback
com.hivemq.extension.sdk.api.packets.pubcomp - package com.hivemq.extension.sdk.api.packets.pubcomp
com.hivemq.extension.sdk.api.packets.publish - package com.hivemq.extension.sdk.api.packets.publish
com.hivemq.extension.sdk.api.packets.pubrec - package com.hivemq.extension.sdk.api.packets.pubrec
com.hivemq.extension.sdk.api.packets.pubrel - package com.hivemq.extension.sdk.api.packets.pubrel
com.hivemq.extension.sdk.api.packets.suback - package com.hivemq.extension.sdk.api.packets.suback
com.hivemq.extension.sdk.api.packets.subscribe - package com.hivemq.extension.sdk.api.packets.subscribe
com.hivemq.extension.sdk.api.packets.unsuback - package com.hivemq.extension.sdk.api.packets.unsuback
com.hivemq.extension.sdk.api.packets.unsubscribe - package com.hivemq.extension.sdk.api.packets.unsubscribe
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.admin - package com.hivemq.extension.sdk.api.services.admin
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.general - package com.hivemq.extension.sdk.api.services.general
com.hivemq.extension.sdk.api.services.interceptor - package com.hivemq.extension.sdk.api.services.interceptor
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
COMMUNITY - com.hivemq.extension.sdk.api.services.admin.LicenseEdition: The open source edition of HiveMQ.
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
ConnackOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.connack.parameter: This is the input parameter of any ConnackOutboundInterceptor providing CONNACK, connection and client based information.
ConnackOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.connack: Interface for the outbound CONNACK interception.
ConnackOutboundInterceptorProvider - Interface in com.hivemq.extension.sdk.api.interceptor.connack: The interceptor provider allows to implement custom logic to modify outbound CONNACK messages.
ConnackOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.connack.parameter: This is the output parameter of any ConnackOutboundInterceptor providing methods to define the outcome of CONNACK interception.
ConnackOutboundProviderInput - Interface in com.hivemq.extension.sdk.api.interceptor.connack.parameter: This is the input parameter of any ConnackOutboundInterceptorProvider providing ServerInformation and ClientBasedInput.
ConnackPacket - Interface in com.hivemq.extension.sdk.api.packets.connack: Represents a CONNACK packet.
ConnackReasonCode - Enum in com.hivemq.extension.sdk.api.packets.connect: Reason code for the MQTT CONNACK packet.
ConnectInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.connect.parameter: This is the input parameter of any ConnectInboundInterceptor providing CONNECT, connection and client based information.
ConnectInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.connect: Interface for the connect inbound interception.
ConnectInboundInterceptorProvider - Interface in com.hivemq.extension.sdk.api.interceptor.connect: The interceptor provider allows to implement custom logic to modify incoming CONNECT messages.
ConnectInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.connect.parameter: This is the output parameter of any ConnectInboundInterceptor providing methods to define the outcome of a CONNECT interception.
ConnectInboundProviderInput - Interface in com.hivemq.extension.sdk.api.interceptor.connect.parameter: This is the input parameter of any ConnectInboundInterceptorProvider providing ServerInformation and ClientBasedInput.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
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: Input object for the method ClientLifecycleEventListener.onConnectionLost(ConnectionLostInput).
ConnectionStartInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters: Input object for the method ClientLifecycleEventListener.onMqttConnectionStart(ConnectionStartInput).
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.
CONTINUE_AUTHENTICATION - com.hivemq.extension.sdk.api.packets.auth.AuthReasonCode: CONTINUE_AUTHENTICATION reason code is sent when client authentication needs further authentication.
continueAuthentication() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Continues the authentication of the client by sending an AUTH packet to the client and expecting another AUTH packet in response from the client.
continueAuthentication(@com.hivemq.extension.sdk.api.annotations.NotNull byte[]) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Continues the authentication of the client by sending an AUTH packet to the client and expecting another AUTH packet in response from the client.
continueAuthentication(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Continues the authentication of the client by sending an AUTH packet to the client and expecting another AUTH packet in response from the client.
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

DEFAULT - com.hivemq.extension.sdk.api.auth.parameter.OverloadProtectionThrottlingLevel: The amount of PUBLISH messages that each client can send is limited based on the resources of the HiveMQ cluster.
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: Can only be used for the ModifiableInboundDisconnectPacket.
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.
disconnectClient(String, boolean, DisconnectReasonCode, String) - 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 CONNACK and DISCONNECT reason codes are listed here.
DisconnectEventInput - Interface in com.hivemq.extension.sdk.api.events.client.parameters: Input object for ClientLifecycleEventListener methods for disconnect events.
DisconnectInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect.parameter: This is the input parameter of any DisconnectInboundInterceptor providing DISCONNECT, connection and client based information.
DisconnectInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect: Interface for the inbound DISCONNECT interception.
DisconnectInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect.parameter: This is the output parameter of any DisconnectInboundInterceptor providing methods to define the outcome of a DISCONNECT interception.
DisconnectOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect.parameter: This is the input parameter of any DisconnectOutboundInterceptor providing DISCONNECT, connection and client based information.
DisconnectOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect: Interface for the outbound DISCONNECT interception.
DisconnectOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.disconnect.parameter: This is the output parameter of any DisconnectOutboundInterceptor providing methods to define the outcome of DISCONNECT interception.
DisconnectPacket - Interface in com.hivemq.extension.sdk.api.packets.disconnect: Represents a DISCONNECT packet.
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.
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

EnhancedAuthConnectInput - Interface in com.hivemq.extension.sdk.api.auth.parameter: Input parameter provided to EnhancedAuthenticator.onConnect(EnhancedAuthConnectInput, EnhancedAuthOutput).
EnhancedAuthenticator - Interface in com.hivemq.extension.sdk.api.auth: Interface for the enhanced authentication of MQTT clients.
EnhancedAuthenticatorProvider - 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.
EnhancedAuthInput - Interface in com.hivemq.extension.sdk.api.auth.parameter: Input parameter provided to the methods of an EnhancedAuthenticator.
EnhancedAuthOutput - Interface in com.hivemq.extension.sdk.api.auth.parameter: Output parameter provided to the methods of an EnhancedAuthenticator.
ENTERPRISE - com.hivemq.extension.sdk.api.services.admin.LicenseEdition: Enterprise edition of HiveMQ.
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.
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.EnhancedAuthOutput: Fails the authentication of the client.
failAuthentication() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Fails the authentication of the client.
failAuthentication(ConnackReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Fails the authentication of the client.
failAuthentication(ConnackReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Fails the authentication of the client.
failAuthentication(DisconnectedReasonCode) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Fails the authentication of the client.
failAuthentication(DisconnectedReasonCode, String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Fails the authentication of the client.
failAuthentication(String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Fails the authentication of the client.
failAuthentication(String) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Fails the authentication of 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.
getAssignedClientIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The assigned client identifier of the CONNACK packet.
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.auth.AuthPacket: The optional authentication data of the AUTH packet.
getAuthenticationData() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: If this property is present, the ByteBuffer contains the data used for the extended authentication.
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.
getAuthenticationDataAsArray() - Method in interface com.hivemq.extension.sdk.api.packets.auth.AuthPacket: The optional authentication data of the AUTH packet as a byte array.
getAuthenticationMethod() - Method in interface com.hivemq.extension.sdk.api.packets.auth.AuthPacket: The authentication method of the AUTH packet.
getAuthenticationMethod() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: If this property is present, the string contains the authentication method that should be 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.
getAuthPacket() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthInput: Provides the unmodifiable AUTH packet sent by the MQTT client that has to be authenticated.
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.
getClientId() - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriberForTopicResult
getClientId() - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriberWithFilterResult
getClientId() - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionsForClientResult: Get the client identifier for this client.
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.
getClientReceiveMaximum() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings
getClientSettings() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Provides ModifiableClientSettings to configure client specific parameters and restrictions.
getClientSettings() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Provides ModifiableClientSettings to configure client specific parameters and restrictions.
getCode() - Method in enum com.hivemq.extension.sdk.api.packets.subscribe.RetainHandling: Get the retain handling as integer.
getConnackOutboundInterceptor(ConnackOutboundProviderInput) - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.ConnackOutboundInterceptorProvider: This method is called for each outbound CONNACK message by HiveMQ.
getConnackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.parameter.ConnackOutboundInput: The unmodifiable CONNACK packet that was intercepted.
getConnackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.parameter.ConnackOutboundOutput: Use this object to make any changes to the CONNACK message.
getConnectInboundInterceptor(ConnectInboundProviderInput) - Method in interface com.hivemq.extension.sdk.api.interceptor.connect.ConnectInboundInterceptorProvider: This method is called for each incoming CONNECT message by HiveMQ.
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.EnhancedAuthConnectInput: Provides the unmodifiable CONNECT packet sent by the MQTT client that has to be authenticated.
getConnectPacket() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthInput: Provides the unmodifiable CONNECT packet sent by 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.
getConnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.connect.parameter.ConnectInboundInput: The unmodifiable CONNECT packet that was intercepted.
getConnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.connect.parameter.ConnectInboundOutput: Use this object to make any changes to the CONNECT message.
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.
getCurrentStage() - Method in interface com.hivemq.extension.sdk.api.services.admin.AdminService
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.EnhancedAuthOutput: Provides ModifiableDefaultPermissions to configure client specific default permissions.
getDefaultPermissions() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Provides ModifiableDefaultPermissions to configure client specific default permissions.
getDefaultPermissions() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: The default permissions for this client.
getDisconnectInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all DisconnectInboundInterceptor which are registered for this client by this extension.
getDisconnectOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all DisconnectOutboundInterceptor which are registered for this client by this extension.
getDisconnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectInboundInput: The unmodifiable DISCONNECT packet that was intercepted.
getDisconnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectInboundOutput: Use this object to make any changes to the inbound DISCONNECT.
getDisconnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectOutboundInput: The unmodifiable DISCONNECT packet that was intercepted.
getDisconnectPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.parameter.DisconnectOutboundOutput: Use this object to make any changes to the outbound DISCONNECT.
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.
getEdition() - Method in interface com.hivemq.extension.sdk.api.services.admin.LicenseInformation
getEnabledExtensions() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartInput
getEnabledExtensions() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStopInput
getEnhancedAuthenticator(AuthenticatorProviderInput) - Method in interface com.hivemq.extension.sdk.api.services.auth.provider.EnhancedAuthenticatorProvider: This method is called for each client by HiveMQ.
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.
getLicenseInformation() - Method in interface com.hivemq.extension.sdk.api.services.admin.AdminService
getListener() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ConnectionInformation: The listener of HiveMQ the client is connected to.
getListener() - Method in interface com.hivemq.extension.sdk.api.client.parameter.ServerInformation: All configured listeners.
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.connack.ConnackPacket: The maximum packet size in bytes for an MQTT Control Packet, the server is willing to accept.
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.
getMaximumQoS() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The maximum quality of service level (QoS) the server allows for this connection.
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.
getModifiableWillPublish() - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Get a modifiable instance of the WillPublishPacket.
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.client.parameter.Listener
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.EnhancedAuthOutput: Provides ModifiableUserProperties to add or remove user properties to or from the outgoing CONNACK, AUTH or DISCONNECT packet.
getOutboundUserProperties() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.SimpleAuthOutput: Provides 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.
getOverloadProtectionThrottlingLevel() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings
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.
getPacketId() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscribePacket: The packet identifier of the SUBSCRIBE packet.
getPacketId() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.SubscribePacket: The packet identifier of the SUBSCRIBE packet.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.puback.PubackPacket: The packet identifier of the PUBACK.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.PubcompPacket: The packet identifier of the PUBCOMP.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.PubrecPacket: The packet identifier of the PUBREC.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.PubrelPacket: The packet identifier of the PUBREL.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.suback.SubackPacket: The packet identifier of this SUBACK packet.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.UnsubackPacket: The packet identifier of the UNSUBACK packet.
getPacketIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.unsubscribe.UnsubscribePacket: The packet identifier of the UNSUBSCRIBE packet.
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.
getPingReqInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PingReqInboundInterceptor which are registered for this client by this extension.
getPingRespOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PingRespOutboundInterceptor which are registered for this client by this extension.
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
getPubackInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubackInboundInterceptor which are registered for this client by this extension.
getPubackOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubackOutboundInterceptor which are registered for this client by this extension.
getPubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackInboundInput: The unmodifiable PUBACK packet that was intercepted.
getPubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackInboundOutput: Use this object to make any changes to the PUBACK message.
getPubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackOutboundInput: The unmodifiable PUBACK packet that was intercepted.
getPubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.parameter.PubackOutboundOutput: Use this object to make any changes to the PUBACK message.
getPubcompInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubcompInboundInterceptor which are registered for this client by this extension.
getPubcompOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubcompOutboundInterceptor which are registered for this client by this extension.
getPubcompPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompInboundInput: The unmodifiable PUBCOMP packet that was intercepted.
getPubcompPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompInboundOutput: Use this object to make any changes to the PUBCOMP message.
getPubcompPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompOutboundInput: The unmodifiable PUBCOMP packet that was intercepted.
getPubcompPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter.PubcompOutboundOutput: Use this object to make any changes to the PUBCOMP message.
getPublishInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PublishInboundInterceptor which are registered for this client by this extension.
getPublishOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PublishOutboundInterceptor 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.
getPublishPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishOutboundInput: The unmodifiable PUBLISH packet that was intercepted.
getPublishPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishOutboundOutput: Use this object to make any changes to the outbound 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.
getPubrecInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubrecInboundInterceptor which are registered for this client by this extension.
getPubrecOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubrecOutboundInterceptor which are registered for this client by this extension.
getPubrecPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecInboundInput: The unmodifiable PUBREC packet that was intercepted.
getPubrecPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecInboundOutput: Use this object to make any changes to the PUBREC message.
getPubrecPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecOutboundInput: The unmodifiable PUBREC packet that was intercepted.
getPubrecPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.parameter.PubrecOutboundOutput: Use this object to make any changes to the PUBREC message.
getPubrelInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubrelInboundInterceptor which are registered for this client by this extension.
getPubrelOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all PubrelOutboundInterceptor which are registered for this client by this extension.
getPubrelPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelInboundInput: The unmodifiable PUBREL packet that was intercepted.
getPubrelPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelInboundOutput: Use this object to make any changes to the PUBREL message.
getPubrelPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelOutboundInput: The unmodifiable PUBREL packet that was intercepted.
getPubrelPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.parameter.PubrelOutboundOutput: Use this object to make any changes to the PUBREL message.
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
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.auth.AuthPacket: The reason code of the AUTH packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The reason code from the CONNACK packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.DisconnectPacket: The reason code of the DISCONNECT packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.puback.PubackPacket: The reason code from the PUBACK packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.PubcompPacket: The reason code from the PUBCOMP packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.PubrecPacket: The reason code from the PUBREC packet.
getReasonCode() - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.PubrelPacket: The reason code from the PUBREL packet.
getReasonCodes() - Method in interface com.hivemq.extension.sdk.api.packets.suback.SubackPacket: The reason codes for each subscription in the corresponding SUBSCRIBE message.
getReasonCodes() - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.UnsubackPacket: Represents the return codes for the QoS levels of the different Topics contained in the corresponding UNSUBSCRIBE message as well as potential failure codes.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.events.client.parameters.DisconnectEventInput
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.auth.AuthPacket: The optional reason string of the AUTH packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The reason string of the CONNACK packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.DisconnectPacket: The optional reason string of the DISCONNECT packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.puback.PubackPacket: The reason string of the PUBACK packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.PubcompPacket: The reason string of the PUBCOMP packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.PubrecPacket: The reason string of the PUBREC packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.PubrelPacket: The reason string of the PUBREL packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.suback.SubackPacket: The reason string of the SUBACK packet.
getReasonString() - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.UnsubackPacket: The reason string of the UNSUBACK packet.
getReceiveMaximum() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The limit of QoS 1 and QoS 2 Publishes that the server is willing to process concurrently.
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).
getResponseInformation() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The response information of the CONNACK packet.
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: If true this message is a retained message, for false this is just a normal publish.
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.
getRetainAvailable() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The retain available flag from the CONNACK packet.
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.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.parameter.ConnackOutboundProviderInput: Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.interceptor.connect.parameter.ConnectInboundProviderInput: Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStartInput: Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.parameter.ExtensionStopInput: Get information about the HiveMQ instance the extension is running in.
getServerInformation() - Method in interface com.hivemq.extension.sdk.api.services.admin.AdminService
getServerKeepAlive() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: An interval in seconds in which the client has to send any MQTT control packet, so that HiveMQ doesn't end the connection.
getServerReference() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The server reference of the CONNACK packet.
getServerReference() - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.DisconnectPacket: The optional server reference of the DISCONNECT packet.
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.connack.ConnackPacket: Duration in seconds how long session for the client is stored.
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.packets.disconnect.DisconnectPacket: The optional session expiry interval in seconds (duration for which the clients session is stored) of the DISCONNECT packet.
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.
getSessionPresent() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The session present flag from the CONNACK packet.
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.
getSharedSubscriptionsAvailable() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The shared subscriptions available flag from the CONNACK packet.
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.
getSubackOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all SubackOutboundInterceptor which are registered for this client by this extension.
getSubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.suback.parameter.SubackOutboundInput: The unmodifiable SUBACK packet that was intercepted.
getSubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.suback.parameter.SubackOutboundOutput: Use this object to make any changes to the outbound SUBACK.
getSubscribeInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all SubscribeInboundInterceptor which are registered for this client by this extension.
getSubscribePacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.subscribe.parameter.SubscribeInboundInput: The unmodifiable SUBSCRIBE packet that was intercepted.
getSubscribePacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.subscribe.parameter.SubscribeInboundOutput: Use this object to make any changes to the inbound SUBSCRIBE.
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.packets.subscribe.ModifiableSubscribePacket: If this property is present, it contains the subscription identifier for the SUBSCRIBE packet.
getSubscriptionIdentifier() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.SubscribePacket: 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.
getSubscriptionIdentifiersAvailable() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The subscription identifier available flag from the CONNACK packet.
getSubscriptions() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscribePacket: Get the modifiable subscriptions of the SUBSCRIBE packet.
getSubscriptions() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.SubscribePacket: The list of unmodifiable subscriptions of the SUBSCRIBE.
getSubscriptions() - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionsForClientResult: Get a Set of TopicSubscription containing all subscriptions including the subscription options and identifier for this client.
getSubscriptions(String) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Returns all subscriptions a client is subscribed to.
getTimestamp() - Method in interface com.hivemq.extension.sdk.api.packets.connect.WillPublishPacket: The timestamp when the CONNECT packet with the Will Publish arrived at the broker.
getTimestamp() - Method in interface com.hivemq.extension.sdk.api.packets.publish.PublishPacket: The arrival timestamp of the PUBLISH.
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.connack.ConnackPacket: The maximum amount of topic aliases the server allows for this connection.
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.
getTopicFilters() - Method in interface com.hivemq.extension.sdk.api.packets.unsubscribe.UnsubscribePacket: Gets the list of topics to be unsubscribed from.
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.
getUnsubackOutboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all UnsubackOutboundInterceptor which are registered for this client by this extension.
getUnsubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.unsuback.parameter.UnsubackOutboundInput: The unmodifiable UNSUBACK packet that was intercepted.
getUnsubackPacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.unsuback.parameter.UnsubackOutboundOutput: Use this object to make any changes to the outbound UNSUBACK.
getUnsubscribeInboundInterceptors() - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Returns all UnsubscribeInboundInterceptor which are registered for this client by this extension.
getUnsubscribePacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter.UnsubscribeInboundInput: The unmodifiable UNSUBSCRIBE packet that was intercepted.
getUnsubscribePacket() - Method in interface com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter.UnsubscribeInboundOutput: Use this Object to make any changes to the inbound UNSUBSCRIBE.
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.auth.AuthPacket: The user properties of the AUTH packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The user properties from the CONNACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ModifiableConnackPacket: Get the modifiable UserProperties of the CONNACK packet.
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.disconnect.DisconnectPacket: The user properties from the DISCONNECT packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableInboundDisconnectPacket: The modifiable UserProperties of the DISCONNECT packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableOutboundDisconnectPacket: The modifiable UserProperties of the DISCONNECT packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.puback.ModifiablePubackPacket: Get the modifiable UserProperties of the PUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.puback.PubackPacket: The user properties from the PUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.ModifiablePubcompPacket: Get the modifiable UserProperties of the PUBCOMP packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.PubcompPacket: The user properties from the PUBCOMP packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Get the modifiable UserProperties of the CONNECT packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Get the modifiable UserProperties of the PUBLISH 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.packets.pubrec.ModifiablePubrecPacket: Get the modifiable UserProperties of the PUBREC packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.PubrecPacket: The user properties from the PUBREC packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.ModifiablePubrelPacket: Get the modifiable UserProperties of the PUBREL packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.PubrelPacket: The user properties from the PUBREL packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.suback.ModifiableSubackPacket: The modifiable UserProperties of the SUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.suback.SubackPacket: The UserProperties of this SUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscribePacket: Get the modifiable UserProperties of the SUBSCRIBE packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.SubscribePacket: The user properties from the SUBSCRIBE packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.ModifiableUnsubackPacket: Gets the modifiable UserProperties of the UNSUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.UnsubackPacket: The user properties from the UNSUBACK packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.unsubscribe.ModifiableUnsubscribePacket: Gets the modifiable ModifiableUserProperties of the UNSUBSCRIBE packet.
getUserProperties() - Method in interface com.hivemq.extension.sdk.api.packets.unsubscribe.UnsubscribePacket: The user properties from the UNSUBSCRIBE packet.
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
getWildCardSubscriptionAvailable() - Method in interface com.hivemq.extension.sdk.api.packets.connack.ConnackPacket: The wildcard subscription available flag from the CONNACK packet.
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.
GlobalInterceptorRegistry - Interface in com.hivemq.extension.sdk.api.services.interceptor
GRANTED_QOS_0 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is a success code.
GRANTED_QOS_1 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is a success code.
GRANTED_QOS_2 - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is a success 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: This is an unsuccessful code.
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: This is an unsuccessful code.
IMPLEMENTATION_SPECIFIC_ERROR - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The UNSUBSCRIBE is valid but the Server does not accept it.
IncompatibleHiveMQVersionException - Exception in com.hivemq.extension.sdk.api.services.exception: This exception is used to signal that a cluster node has an incompatible HiveMQ version for a specific request.
INDIVIDUAL - com.hivemq.extension.sdk.api.services.subscription.SubscriptionType: Only include individual subscriptions.
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
INSTANCE - Static variable in exception com.hivemq.extension.sdk.api.services.exception.IncompatibleHiveMQVersionException
Interceptor - Interface in com.hivemq.extension.sdk.api.interceptor: Marker interface for Interceptors.
interceptorRegistry() - Static method in class com.hivemq.extension.sdk.api.services.Services
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 to this HiveMQ broker instance or any other instance in the cluster.
isConnected() - Method in interface com.hivemq.extension.sdk.api.services.session.SessionInformation
isEmpty() - Method in interface com.hivemq.extension.sdk.api.packets.general.UserProperties
isReAuthentication() - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthInput
iterate(IterationContext, T) - Method in interface com.hivemq.extension.sdk.api.services.general.IterationCallback: This method is called for every result that is part of the iteration.
iterateAllClients(IterationCallback<SessionInformation>) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService: Iterate over all clients and their session information in the HiveMQ cluster.
iterateAllClients(IterationCallback<SessionInformation>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.session.ClientService: Iterate over all clients and their session information in the HiveMQ cluster.
iterateAllRetainedMessages(IterationCallback<RetainedPublish>) - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore: Iterate over all retained messages in the HiveMQ cluster.
iterateAllRetainedMessages(IterationCallback<RetainedPublish>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.publish.RetainedMessageStore: Iterate over all retained messages in the HiveMQ cluster.
iterateAllSubscribersForTopic(String, IterationCallback<SubscriberForTopicResult>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that matches the passed topic.
iterateAllSubscribersForTopic(String, IterationCallback<SubscriberForTopicResult>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that matches the passed topic.
iterateAllSubscribersForTopic(String, SubscriptionType, IterationCallback<SubscriberForTopicResult>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that matches the passed topic.
iterateAllSubscribersForTopic(String, SubscriptionType, IterationCallback<SubscriberForTopicResult>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that matches the passed topic.
iterateAllSubscribersWithTopicFilter(String, IterationCallback<SubscriberWithFilterResult>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that equals the passed topic filter.
iterateAllSubscribersWithTopicFilter(String, IterationCallback<SubscriberWithFilterResult>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that equals the passed topic filter.
iterateAllSubscribersWithTopicFilter(String, SubscriptionType, IterationCallback<SubscriberWithFilterResult>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that equals the passed topic filter.
iterateAllSubscribersWithTopicFilter(String, SubscriptionType, IterationCallback<SubscriberWithFilterResult>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers in the HiveMQ cluster that have a subscription that equals the passed topic filter.
iterateAllSubscriptions(IterationCallback<SubscriptionsForClientResult>) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers and their subscriptions in the HiveMQ cluster.
iterateAllSubscriptions(IterationCallback<SubscriptionsForClientResult>, Executor) - Method in interface com.hivemq.extension.sdk.api.services.subscription.SubscriptionStore: Iterate over all subscribers and their subscriptions in the HiveMQ cluster.
IterationCallback<T> - Interface in com.hivemq.extension.sdk.api.services.general: A callback that can be passed to methods in extension stores (e.g.
IterationContext - Interface in com.hivemq.extension.sdk.api.services.general
IterationFailedException - Exception in com.hivemq.extension.sdk.api.services.exception: Unchecked Exception which is thrown when an iteration fails.
IterationFailedException(String) - Constructor for exception com.hivemq.extension.sdk.api.services.exception.IterationFailedException

K

KEEP_ALIVE_TIMEOUT - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: Can only be used for the ModifiableOutboundDisconnectPacket.
KEEP_ALIVE_TIMEOUT - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode

L

LicenseEdition - Enum in com.hivemq.extension.sdk.api.services.admin: The enum represents the edition for which HiveMQ is licensed.
LicenseInformation - Interface in com.hivemq.extension.sdk.api.services.admin
LifecycleStage - Enum in com.hivemq.extension.sdk.api.services.admin
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: This is an unsuccessful code.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
MAXIMUM_CONNECT_TIME - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
MESSAGE_RATE_TOO_HIGH - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: This is an unsuccessful code.
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
ModifiableClientSettings - Interface in com.hivemq.extension.sdk.api.auth.parameter: An instance of this interface is provided by the SimpleAuthOutput and can be used to configure client specific parameters and restrictions.
ModifiableConnackPacket - Interface in com.hivemq.extension.sdk.api.packets.connack: A ConnackPacket that can be modified before it is sent to the client.
ModifiableConnectPacket - Interface in com.hivemq.extension.sdk.api.packets.publish: A modifiable version of the ConnectPacket.
ModifiableDefaultPermissions - Interface in com.hivemq.extension.sdk.api.packets.auth: Default permissions enable the authorization of PUBLISH/Subscriptions if no Authorizer is used.
ModifiableInboundDisconnectPacket - Interface in com.hivemq.extension.sdk.api.packets.disconnect: An inbound DisconnectPacket that can be modified before it is sent to the server.
ModifiableOutboundDisconnectPacket - Interface in com.hivemq.extension.sdk.api.packets.disconnect: An outbound DisconnectPacket that can be modified before it is sent to the client.
ModifiableOutboundPublish - Interface in com.hivemq.extension.sdk.api.packets.publish: A PublishPacket that can be modified for onward delivery.
ModifiablePubackPacket - Interface in com.hivemq.extension.sdk.api.packets.puback: A PubackPacket that can be modified before it is sent to the client (for PubackOutboundInterceptor) or to the server (for PubackInboundInterceptor).
ModifiablePubcompPacket - Interface in com.hivemq.extension.sdk.api.packets.pubcomp: A PubcompPacket that can be modified before it is sent to the client (for PubcompOutboundInterceptor) or to the server (for PubcompInboundInterceptor).
ModifiablePublishPacket - Interface in com.hivemq.extension.sdk.api.packets.publish: A PublishPacket that can be modified for onward delivery.
ModifiablePubrecPacket - Interface in com.hivemq.extension.sdk.api.packets.pubrec: A PubrecPacket that can be modified before it is sent to the client (for PubrecOutboundInterceptor) or to the server (for PubrecInboundInterceptor).
ModifiablePubrelPacket - Interface in com.hivemq.extension.sdk.api.packets.pubrel: A PubrelPacket that can be modified before it is sent to the client (for PubrelOutboundInterceptor) or to the server (for PubrelInboundInterceptor).
ModifiableSubackPacket - Interface in com.hivemq.extension.sdk.api.packets.suback: A SubackPacket that can be modified before it is sent to the client.
ModifiableSubscribePacket - Interface in com.hivemq.extension.sdk.api.packets.subscribe: A copy of an SubscribePacket that can be modified for onward delivery.
ModifiableSubscription - Interface in com.hivemq.extension.sdk.api.packets.subscribe: A copy of a Subscription that can be modified for onward delivery.
ModifiableUnsubackPacket - Interface in com.hivemq.extension.sdk.api.packets.unsuback: An UnsubackPacket that can be modified before it is sent to the client.
ModifiableUnsubscribePacket - Interface in com.hivemq.extension.sdk.api.packets.unsubscribe: A copy of an UnsubscribePacket that can be modified before it is processed by HiveMQ.
ModifiableUserProperties - Interface in com.hivemq.extension.sdk.api.packets.general: Interface to modify UserProperties received from any MQTT packet.
ModifiableWillPublish - Interface in com.hivemq.extension.sdk.api.packets.publish
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.EnhancedAuthOutput: The outcome of the authentication is determined by an authenticator of the next extension (with lower priority).
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 an authenticator of the next extension (with lower priority).
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
NO_SUBSCRIPTIONS_EXISTED - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: No matching Topic Filter is being used by the Client.
noLocal(boolean) - Method in interface com.hivemq.extension.sdk.api.services.builder.TopicSubscriptionBuilder: Sets the no local flag.
NONE - com.hivemq.extension.sdk.api.auth.parameter.OverloadProtectionThrottlingLevel: The amount of PUBLISH messages that each client can send is NOT limited by the overload protection.
NORMAL_DISCONNECTION - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: This is a success code.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
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: This is an unsuccessful code.
NOT_AUTHORIZED - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The Client is not authorized to unsubscribe.
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.
Nullable - Annotation Type in com.hivemq.extension.sdk.api.annotations: An annotation which is used for indicating that something can be null.

O

onAuth(EnhancedAuthInput, EnhancedAuthOutput) - Method in interface com.hivemq.extension.sdk.api.auth.EnhancedAuthenticator: This method is called when the MQTT client (that has to be authenticated) sent an AUTH packet.
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(EnhancedAuthConnectInput, EnhancedAuthOutput) - Method in interface com.hivemq.extension.sdk.api.auth.EnhancedAuthenticator: This method is called when the MQTT client (that has to be authenticated) sent the CONNECT packet.
onConnect(SimpleAuthInput, SimpleAuthOutput) - Method in interface com.hivemq.extension.sdk.api.auth.SimpleAuthenticator: This method is called when the MQTT client (that has to be authenticated) sent the CONNECT packet.
onConnect(ConnectInboundInput, ConnectInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.connect.ConnectInboundInterceptor: When a ConnectInboundInterceptor is set through any extension, this method gets called for every inbound CONNECT packet from any MQTT client.
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.
onInboundDisconnect(DisconnectInboundInput, DisconnectInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.DisconnectInboundInterceptor: When a DisconnectInboundInterceptor is set through any extension, this method gets called for every inbound DISCONNECT packet from any MQTT client.
onInboundPingReq(PingReqInboundInput, PingReqInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pingreq.PingReqInboundInterceptor: When a PingReqInboundInterceptor is set through any extension, this method gets called for every inbound PINGREQ packet from any MQTT client.
onInboundPuback(PubackInboundInput, PubackInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.PubackInboundInterceptor: When a PubackInboundInterceptor is set through any extension, this method gets called for every inbound PUBACK packet from any MQTT client.
onInboundPubcomp(PubcompInboundInput, PubcompInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.PubcompInboundInterceptor: When a PubcompInboundInterceptor is set through any extension, this method gets called for every inbound PUBCOMP packet from any MQTT client.
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.
onInboundPubrec(PubrecInboundInput, PubrecInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.PubrecInboundInterceptor: When a PubrecInboundInterceptor is set through any extension, this method gets called for every inbound PUBREC packet from any MQTT client.
onInboundPubrel(PubrelInboundInput, PubrelInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.PubrelInboundInterceptor: When a PubrelInboundInterceptor is set through any extension, this method gets called for every inbound PUBREL packet from any MQTT client.
onInboundSubscribe(SubscribeInboundInput, SubscribeInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.subscribe.SubscribeInboundInterceptor: When a SubscribeInboundInterceptor is set through any extension, this method gets called for every inbound SUBSCRIBE packet from any MQTT client.
onInboundUnsubscribe(UnsubscribeInboundInput, UnsubscribeInboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.unsubscribe.UnsubscribeInboundInterceptor: When a UnsubscribeInboundInterceptor is set through any extension, this method gets called for every inbound UNSUBSCRIBE packet from any 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.
onOutboundConnack(ConnackOutboundInput, ConnackOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.connack.ConnackOutboundInterceptor: When a ConnackOutboundInterceptor is set through any extension, this method gets called for every outbound CONNACK packet from any MQTT client.
onOutboundDisconnect(DisconnectOutboundInput, DisconnectOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.disconnect.DisconnectOutboundInterceptor: When a DisconnectOutboundInterceptor is set through any extension, this method gets called for every outbound DISCONNECT packet from any MQTT 5 client.
onOutboundPingResp(PingRespOutboundInput, PingRespOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pingresp.PingRespOutboundInterceptor: When a PingRespOutboundInterceptor is set through any extension, this method gets called for every outbound PINGRESP packet from any MQTT client.
onOutboundPuback(PubackOutboundInput, PubackOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.puback.PubackOutboundInterceptor: When a PubackOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBACK packet to any MQTT client.
onOutboundPubcomp(PubcompOutboundInput, PubcompOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubcomp.PubcompOutboundInterceptor: When a PubcompOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBCOMP packet for any MQTT client.
onOutboundPublish(PublishOutboundInput, PublishOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.PublishOutboundInterceptor: When a PublishOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBLISH packet from any MQTT client.
onOutboundPubrec(PubrecOutboundInput, PubrecOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrec.PubrecOutboundInterceptor: When a PubrecOutboundInterceptor is set through any extension, this method gets called for every outbound PUBREC packet for any MQTT client.
onOutboundPubrel(PubrelOutboundInput, PubrelOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.pubrel.PubrelOutboundInterceptor: When a PubrelOutboundInterceptor is set through any extension, this method gets called for every outgoing PUBREL packet for any MQTT client.
onOutboundSuback(SubackOutboundInput, SubackOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.suback.SubackOutboundInterceptor: When a SubackOutboundInterceptor is set through any extension, this method gets called for every outbound SUBACK packet from any MQTT client.
onOutboundUnsuback(UnsubackOutboundInput, UnsubackOutboundOutput) - Method in interface com.hivemq.extension.sdk.api.interceptor.unsuback.UnsubackOutboundInterceptor: When an UnsubackOutboundInterceptor is set through any extension, this method gets called for every outbound UNSUBACK packet from any MQTT client.
onReAuth(EnhancedAuthInput, EnhancedAuthOutput) - Method in interface com.hivemq.extension.sdk.api.auth.EnhancedAuthenticator: This method is called when the MQTT client (that has to be authenticated) sent an AUTH packet with reason code REAUTHENTICATE.
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.
OverloadProtectionThrottlingLevel - Enum in com.hivemq.extension.sdk.api.auth.parameter: The enum is used to define how a client is affected by the overload protection.

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: This is an unsuccessful code.
PACKET_IDENTIFIER_IN_USE - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The specified Packet Identifier is already in use.
PACKET_IDENTIFIER_NOT_FOUND - com.hivemq.extension.sdk.api.packets.pubcomp.PubcompReasonCode
PACKET_IDENTIFIER_NOT_FOUND - com.hivemq.extension.sdk.api.packets.pubrel.PubrelReasonCode
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: This is an unsuccessful code.
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: This is an unsuccessful code.
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.
PingReqInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pingreq.parameter: This is the input parameter of any PingReqInboundInterceptor.
PingReqInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pingreq: Interface for the ping request inbound interception.
PingReqInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pingreq.parameter: This is the output parameter of any PingReqInboundInterceptor.
PingRespOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pingresp.parameter: This is the input parameter of any PingRespOutboundInterceptor.
PingRespOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pingresp: Interface for the ping response interception.
PingRespOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pingresp.parameter: This is the output parameter of any PingRespOutboundInterceptor.
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() - Method in interface com.hivemq.extension.sdk.api.interceptor.publish.parameter.PublishOutboundOutput: Prevent the onward delivery of the PUBLISH packet.
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.
PROFESSIONAL - com.hivemq.extension.sdk.api.services.admin.LicenseEdition: Professional edition of HiveMQ.
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: This is an unsuccessful code.
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.
PubackInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.puback.parameter: This is the input parameter for any PubackInboundInterceptor providing PUBACK, connection and client based information.
PubackInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.puback: Interface for the inbound PUBACK interception.
PubackInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.puback.parameter: This is the output parameter of any PubackInboundInterceptor.
PubackOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.puback.parameter: This is the input parameter for any PubackOutboundInterceptor providing PUBACK, connection and client based information.
PubackOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.puback: Interface for the outbound PUBACK interception.
PubackOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.puback.parameter: This is the output parameter of any PubackOutboundInterceptor.
PubackPacket - Interface in com.hivemq.extension.sdk.api.packets.puback: Represents a PUBACK packet.
PubcompInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter: This is the input parameter for any PubcompInboundInterceptor providing PUBCOMP, connection and client based information.
PubcompInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp: Interface for the inbound PUBCOMP interception.
PubcompInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter: This is the output parameter of any PubcompInboundInterceptor.
PubcompOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter: This is the input parameter for any PubcompOutboundInterceptor providing PUBCOMP, connection and client based information.
PubcompOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp: Interface for the outbound PUBCOMP interception.
PubcompOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubcomp.parameter: This is the output parameter of any PubcompOutboundInterceptor.
PubcompPacket - Interface in com.hivemq.extension.sdk.api.packets.pubcomp: Represents a PUBCOMP packet.
PubcompReasonCode - Enum in com.hivemq.extension.sdk.api.packets.pubcomp: MQTT 5 Reason codes for PUBCOMP.
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.
PublishOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.publish.parameter: This is the input parameter of any PublishOutboundInterceptor providing PUBLISH, connection and client based information.
PublishOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.publish: Interface for the publish outbound interception.
PublishOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.publish.parameter: This is the output parameter of any PublishOutboundInterceptor 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.
PubrecInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec.parameter: This is the input parameter for any PubrecInboundInterceptor providing PUBREC, connection and client based information.
PubrecInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec: Interface for the inbound PUBREC interception.
PubrecInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec.parameter: This is the output parameter of any PubrecInboundInterceptor.
PubrecOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec.parameter: This is the input parameter for any PubrecOutboundInterceptor providing PUBREC, connection and client based information.
PubrecOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec: Interface for the outbound PUBREC interception.
PubrecOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrec.parameter: This is the output parameter of any PubrecOutboundInterceptor.
PubrecPacket - Interface in com.hivemq.extension.sdk.api.packets.pubrec: Represents a PUBREC packet.
PubrelInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel.parameter: This is the input parameter for any PubrelInboundInterceptor providing PUBREL, connection and client based information.
PubrelInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel: Interface for the inbound PUBREL interception.
PubrelInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel.parameter: This is the output parameter of any PubrelInboundInterceptor.
PubrelOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel.parameter: This is the input parameter for any PubrelOutboundInterceptor providing PUBREL, connection and client based information.
PubrelOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel: Interface for the outbound PUBREL interception.
PubrelOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.pubrel.parameter: This is the output parameter of any PubrelOutboundInterceptor.
PubrelPacket - Interface in com.hivemq.extension.sdk.api.packets.pubrel: Represents a PUBREL packet.
PubrelReasonCode - Enum in com.hivemq.extension.sdk.api.packets.pubrel: MQTT 5 Reason codes for PUBREL.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
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: This is an unsuccessful code.
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: This is an unsuccessful code.

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
REAUTHENTICATE - com.hivemq.extension.sdk.api.packets.auth.AuthReasonCode: REAUTHENTICATE reason code is sent when re-authentication is needed.
RECEIVE_MAXIMUM_EXCEEDED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: This is an unsuccessful code.
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.
removeDisconnectInboundInterceptor(DisconnectInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an DisconnectInboundInterceptor for this client.
removeDisconnectOutboundInterceptor(DisconnectOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an DisconnectOutboundInterceptor for this client.
removeDiscoveryCallback(ClusterDiscoveryCallback) - Method in interface com.hivemq.extension.sdk.api.services.cluster.ClusterService: Removes a ClusterDiscoveryCallback from the callbacks added by ClusterService.addDiscoveryCallback(ClusterDiscoveryCallback).
removeName(String) - Method in interface com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties: Remove every UserProperty with the specified name.
removePingReqInboundInterceptor(PingReqInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes a PingReqInboundInterceptor for this client.
removePingRespOutboundInterceptor(PingRespOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes a PingRespOutboundInterceptor for this client.
removePubackInboundInterceptor(PubackInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubackInboundInterceptor for this client.
removePubackOutboundInterceptor(PubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubackOutboundInterceptor for this client.
removePubcompInboundInterceptor(PubcompInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubcompInboundInterceptor for this client.
removePubcompOutboundInterceptor(PubcompOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubcompOutboundInterceptor for this client.
removePublishInboundInterceptor(PublishInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PublishInboundInterceptor for this client.
removePublishOutboundInterceptor(PublishOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PublishOutboundInterceptor for this client.
removePubrecInboundInterceptor(PubrecInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubrecInboundInterceptor for this client.
removePubrecOutboundInterceptor(PubrecOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubrecOutboundInterceptor for this client.
removePubrelInboundInterceptor(PubrelInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubrelInboundInterceptor for this client.
removePubrelOutboundInterceptor(PubrelOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an PubrelOutboundInterceptor for this client.
removeSubackOutboundInterceptor(SubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes a SubackOutboundInterceptor for this client.
removeSubscribeInboundInterceptor(SubscribeInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an SubscribeInboundInterceptor 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.
removeUnsubackOutboundInterceptor(UnsubackOutboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an UnsubackOutboundInterceptor for this client.
removeUnsubscribeInboundInterceptor(UnsubscribeInboundInterceptor) - Method in interface com.hivemq.extension.sdk.api.client.ClientContext: Removes an UnsubscribeInboundInterceptor for this 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: Can only be used for the ModifiableOutboundDisconnectPacket.
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 Security Registry 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: Can only be used for the ModifiableOutboundDisconnectPacket.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
SERVER_MOVED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
SERVER_SHUTTING_DOWN - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: Can only be used for the ModifiableOutboundDisconnectPacket.
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: Input object for the method ClientLifecycleEventListener.onServerInitiatedDisconnect(ServerInitiatedDisconnectInput).
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: Can only be used for the ModifiableOutboundDisconnectPacket.
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.
setAuthenticationData(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the authentication data.
setAuthenticationMethod(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the authentication method.
setAuthenticatorProvider(AuthenticatorProvider) - Method in interface com.hivemq.extension.sdk.api.services.auth.SecurityRegistry: Sets the AuthenticatorProvider of this extension.
setAuthorizerProvider(AuthorizerProvider) - Method in interface com.hivemq.extension.sdk.api.services.auth.SecurityRegistry: Sets the AuthorizerProvider of this extension.
setCleanStart(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the clean start flag.
setClientId(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the client ID.
setClientInitializer(ClientInitializer) - Method in interface com.hivemq.extension.sdk.api.services.intializer.InitializerRegistry: Each connecting and connected MQTT client will be initialized by this initializer, as soon as the extension is enabled and running.
setClientLifecycleEventListener(ClientLifecycleEventListenerProvider) - Method in interface com.hivemq.extension.sdk.api.events.EventRegistry: Sets a provider for ClientLifecycleEventListener.
setClientQueueSizeMaximum(long) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings: Set the queue size maximum of the client to the given value.
setClientReceiveMaximum(int) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings: Set the receive maximum of the client to the given value.
setConnackOutboundInterceptorProvider(ConnackOutboundInterceptorProvider) - Method in interface com.hivemq.extension.sdk.api.services.interceptor.GlobalInterceptorRegistry: The provider is called once for each outbound CONNACK message.
setConnectInboundInterceptorProvider(ConnectInboundInterceptorProvider) - Method in interface com.hivemq.extension.sdk.api.services.interceptor.GlobalInterceptorRegistry: The provider is called once for each incoming CONNECT message.
setContentType(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Sets the content type.
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.ModifiableOutboundPublish: Sets the correlation data.
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.
setEnhancedAuthenticatorProvider(EnhancedAuthenticatorProvider) - Method in interface com.hivemq.extension.sdk.api.services.auth.SecurityRegistry: Sets the EnhancedAuthenticatorProvider of this extension.
setKeepAlive(int) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the keep alive.
setMaximumPacketSize(int) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the maximum packet size.
setMessageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Sets the message expiry interval.
setMessageExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket: Sets the message expiry interval.
setNoLocal(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscription: Set the no local flag of the subscription.
setOverloadProtectionThrottlingLevel(OverloadProtectionThrottlingLevel) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings: Configure the way the client is affected by the overload protection.
setPassword(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the password.
setPayload(ByteBuffer) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Sets the payload.
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.ModifiableOutboundPublish: Sets the payload format indicator.
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.
setQos(Qos) - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscription: Set the QoS of the subscription.
setReasonCode(ConnackReasonCode) - Method in interface com.hivemq.extension.sdk.api.packets.connack.ModifiableConnackPacket: Set a ConnackReasonCode to the CONNACK packet.
setReasonCode(DisconnectReasonCode) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableInboundDisconnectPacket: Set the DisconnectReasonCode of the DISCONNECT packet.
setReasonCode(DisconnectReasonCode) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableOutboundDisconnectPacket: Set the DisconnectReasonCode of the DISCONNECT packet.
setReasonCode(AckReasonCode) - Method in interface com.hivemq.extension.sdk.api.packets.puback.ModifiablePubackPacket: Set a AckReasonCode to the PUBACK packet.
setReasonCode(AckReasonCode) - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.ModifiablePubrecPacket: Set an AckReasonCode to the PUBREC packet.
setReasonCodes(List<SubackReasonCode>) - Method in interface com.hivemq.extension.sdk.api.packets.suback.ModifiableSubackPacket: Sets the list of reason codes of the SUBACK packet.
setReasonCodes(List<UnsubackReasonCode>) - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.ModifiableUnsubackPacket: Sets a list of UnsubackReasonCodes for the UNSUBACK packet.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.connack.ModifiableConnackPacket: Set the reason string.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableInboundDisconnectPacket: Set the reason string of the DISCONNECT packet.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableOutboundDisconnectPacket: Set the reason string of the DISCONNECT packet.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.puback.ModifiablePubackPacket: Set the reason string.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.pubcomp.ModifiablePubcompPacket: Set the reason string.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.pubrec.ModifiablePubrecPacket: Set the reason string.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.pubrel.ModifiablePubrelPacket: Set the reason string.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.suback.ModifiableSubackPacket: Sets the reason string of the SUBACK packet.
setReasonString(String) - Method in interface com.hivemq.extension.sdk.api.packets.unsuback.ModifiableUnsubackPacket: Sets the reason string for the UNSUBACK packet.
setReceiveMaximum(int) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the receive maximum.
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.
setRequestProblemInformation(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the request problem information.
setRequestResponseInformation(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the request response information.
setResponseInformation(String) - Method in interface com.hivemq.extension.sdk.api.packets.connack.ModifiableConnackPacket: Set the response information.
setResponseTopic(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Sets the response topic.
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.ModifiableOutboundPublish: Sets the retain flag.
setRetain(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket: Sets the retain flag.
setRetainAsPublished(boolean) - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscription: Set the retain as published flag of the subscription.
setRetainHandling(RetainHandling) - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscription: Set the retain handling of the subscription.
setServerReference(String) - Method in interface com.hivemq.extension.sdk.api.packets.connack.ModifiableConnackPacket: Set the server reference.
setServerReference(String) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableOutboundDisconnectPacket: Set the server reference of the DISCONNECT packet.
setSessionExpiryInterval(long) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the expiry interval.
setSessionExpiryInterval(Long) - Method in interface com.hivemq.extension.sdk.api.packets.disconnect.ModifiableInboundDisconnectPacket: Sets the session expiry interval of the DISCONNECT packet.
setSubscriptionIdentifiers(List<Integer>) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Set the subscription identifier.
setTimeout(int) - Method in interface com.hivemq.extension.sdk.api.auth.parameter.EnhancedAuthOutput: Sets the time interval (in seconds) in which a response from the client is expected before the authentication times out.
setTopic(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableOutboundPublish: Sets the topic.
setTopic(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiablePublishPacket: Sets the topic.
setTopicAliasMaximum(int) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the topic alias maximum.
setTopicFilter(String) - Method in interface com.hivemq.extension.sdk.api.packets.subscribe.ModifiableSubscription: Sets the topic filter.
setTopicFilters(List<String>) - Method in interface com.hivemq.extension.sdk.api.packets.unsubscribe.ModifiableUnsubscribePacket: Sets the list of Topics to be unsubscribed from.
setUserName(String) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the username.
setWillDelay(long) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableWillPublish: Sets the will delay.
setWillPublish(WillPublishPacket) - Method in interface com.hivemq.extension.sdk.api.packets.publish.ModifiableConnectPacket: Set the will publish.
SHARED - com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.SharedSubscription: Only applied for shared subscriptions.
SHARED - com.hivemq.extension.sdk.api.services.subscription.SubscriptionType: Only include shared subscriptions.
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: Can only be used for the ModifiableOutboundDisconnectPacket.
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
SHARED_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is an unsuccessful code.
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.
SimpleAsyncOutput<T> - Interface in com.hivemq.extension.sdk.api.async: Enables an output object to be processed in a non-blocking way.
SimpleAuthenticator - Interface in com.hivemq.extension.sdk.api.auth: Interface for the simple authentication of MQTT clients.
SimpleAuthInput - Interface in com.hivemq.extension.sdk.api.auth.parameter: Input parameter provided to SimpleAuthenticator.onConnect(SimpleAuthInput, SimpleAuthOutput).
SimpleAuthOutput - Interface in com.hivemq.extension.sdk.api.auth.parameter: Output parameter provided to SimpleAuthenticator.onConnect(SimpleAuthInput, SimpleAuthOutput).
STARTED_SUCCESSFULLY - com.hivemq.extension.sdk.api.services.admin.LifecycleStage: The HiveMQ startup process is complete.
STARTING - com.hivemq.extension.sdk.api.services.admin.LifecycleStage: HiveMQ is currently in the startup process.
SubackOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.suback.parameter: This is the input parameter of any SubackOutboundInterceptor providing SUBACK, connection and client based information.
SubackOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.suback: Interface for the SUBACK outbound interception.
SubackOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.suback.parameter: This is the output parameter of any SubackOutboundInterceptor providing methods to modify a SUBACK packet before it is sent to the client.
SubackPacket - Interface in com.hivemq.extension.sdk.api.packets.suback: Represents a SUBACK packet.
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.
SubscribeInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.subscribe.parameter: This is the input parameter of any SubscribeInboundInterceptor providing SUBSCRIBE, connection and client based information.
SubscribeInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.subscribe: Interface for the subscribe inbound interception.
SubscribeInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.subscribe.parameter: This is the output parameter of any SubscribeInboundInterceptor providing methods to define the outcome of SUBSCRIBE interception.
SubscribePacket - Interface in com.hivemq.extension.sdk.api.packets.subscribe: Represents a SUBSCRIBE packet.
SubscriberForTopicResult - Interface in com.hivemq.extension.sdk.api.services.subscription
SubscriberWithFilterResult - Interface in com.hivemq.extension.sdk.api.services.subscription
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: Can only be used for the ModifiableOutboundDisconnectPacket.
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is an unsuccessful code.
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.
SubscriptionsForClientResult - Interface in com.hivemq.extension.sdk.api.services.subscription: Parameter object passed to each iteration from SubscriptionStore.iterateAllSubscriptions(IterationCallback).
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.
SubscriptionType - Enum in com.hivemq.extension.sdk.api.services.subscription: Enum to filter the subscriptions by type.
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.auth.AuthReasonCode: SUCCESS reason code is sent when client authentication completed successfully.
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: Deprecated.
since 4.3.0, because SUCCESS is never a reason code for a disconnect.
SUCCESS - com.hivemq.extension.sdk.api.packets.pubcomp.PubcompReasonCode
SUCCESS - com.hivemq.extension.sdk.api.packets.publish.AckReasonCode
SUCCESS - com.hivemq.extension.sdk.api.packets.pubrel.PubrelReasonCode
SUCCESS - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The subscription is deleted.
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: This is an unsuccessful code.
TOPIC_ALIAS_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode: Can only be used for the ModifiableOutboundDisconnectPacket.
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is an unsuccessful code.
TOPIC_FILTER_INVALID - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The Topic Filter is correctly formed but is not allowed for this Client.
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: This is an unsuccessful code.
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
TRIAL - com.hivemq.extension.sdk.api.services.admin.LicenseEdition: An otherwise commercial instance of HiveMQ that is running without a license file.
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: This is an unsuccessful code.
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: This is an unsuccessful code.
UNSPECIFIED_ERROR - com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode: The unsubscribe could not be completed and the Server does not wish to reveal the reason or none of the other Reason Codes apply.
UnsubackOutboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.unsuback.parameter: This is the input parameter of any UnsubackOutboundInterceptor providing UNSUBACK, connection and client based information.
UnsubackOutboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.unsuback: Interface for the UNSUBACK outbound interception.
UnsubackOutboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.unsuback.parameter: This is the output parameter of any UnsubackOutboundInterceptor.
UnsubackPacket - Interface in com.hivemq.extension.sdk.api.packets.unsuback: Represents an UNSUBACK packet.
UnsubackReasonCode - Enum in com.hivemq.extension.sdk.api.packets.unsuback: Reason codes that can be set/contained in an UnsubackPacket.
UnsubscribeInboundInput - Interface in com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter: This is the input parameter of any UnsubscribeInboundInterceptor providing UNSUBSCRIBE, connection and client based information.
UnsubscribeInboundInterceptor - Interface in com.hivemq.extension.sdk.api.interceptor.unsubscribe: Interface for the inbound UNSUBSCRIBE interception.
UnsubscribeInboundOutput - Interface in com.hivemq.extension.sdk.api.interceptor.unsubscribe.parameter: This is the output parameter of any UnsubscribeInboundInterceptor.
UnsubscribePacket - Interface in com.hivemq.extension.sdk.api.packets.unsubscribe: Represents an UNSUBSCRIBE packet.
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: Can only be used for the ModifiableOutboundDisconnectPacket.
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.OverloadProtectionThrottlingLevel: 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.AuthReasonCode: 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.pubcomp.PubcompReasonCode: 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.pubrel.PubrelReasonCode: 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.packets.unsuback.UnsubackReasonCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.services.admin.LicenseEdition: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.services.admin.LifecycleStage: 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.
valueOf(String) - Static method in enum com.hivemq.extension.sdk.api.services.subscription.SubscriptionType: 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.OverloadProtectionThrottlingLevel: 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.AuthReasonCode: 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.pubcomp.PubcompReasonCode: 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.pubrel.PubrelReasonCode: 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.packets.unsuback.UnsubackReasonCode: 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.admin.LicenseEdition: 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.admin.LifecycleStage: 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.
values() - Static method in enum com.hivemq.extension.sdk.api.services.subscription.SubscriptionType: 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: Can only be used for the ModifiableOutboundDisconnectPacket.
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED - com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode: This is an unsuccessful code.
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