- addBridge(Bridge) - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- addCallback(Callback) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Makes a callback available to HiveMQ.
- addCallbacks(Callback...) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Makes one or more callbacks available to HiveMQ.
- addClientToGroup(String, ClientData) - Method in interface com.hivemq.spi.services.AsyncClientGroupService
-
Adds a client to a group.
- addClientToGroup(String, String) - Method in interface com.hivemq.spi.services.AsyncClientGroupService
-
Adds a client to a group.
- addClientToGroup(String, ClientData) - Method in interface com.hivemq.spi.services.BlockingClientGroupService
-
Adds a client to a group.
- addClientToGroup(String, String) - Method in interface com.hivemq.spi.services.BlockingClientGroupService
-
Adds a client to a group.
- addContextResolver(Class<? extends ContextResolver>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ContextResolver to all available listeners.
- addContextResolver(Class<? extends ContextResolver>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ContextResolver to all specified listeners.
- addEntry(SYSTopicEntry) - Method in interface com.hivemq.spi.services.SYSTopicService
-
Adds a new $SYS topic entry.
- addExceptionMapper(ExceptionMapper<? extends Throwable>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ExceptionMapper to all available listeners.
- addExceptionMapper(ExceptionMapper<? extends Throwable>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ExceptionMapper to all specified listeners.
- addExceptionMapper(Class<? extends ExceptionMapper<? extends Throwable>>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ExceptionMapper to all available listeners.
- addExceptionMapper(Class<? extends ExceptionMapper<? extends Throwable>>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an ExceptionMapper to all specified listeners.
- addFilter(ServletFilter<T>, String) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a specific
ServletFilter with a given path to the RESTService on all available listeners.
- addFilter(ServletFilter<T>, String, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a specific
ServletFilter with a given path to the RESTService on specific listeners.
- addJaxRsApplication(Application) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a Application to the RESTService.
- addJaxRsApplication(Application, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a Application to the RESTService.
- addJaxRsResources(Class<?>...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an arbitrary number of JAX-RS resources to all available listeners.
- addJaxRsResources(Collection<Class<?>>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds an arbitrary number of JAX-RS resources to all specified listeners.
- addJaxRsSingletons(Object...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds all given JAX-RS resources as singleton to all available listeners.
- addJaxRsSingletons(Collection<Object>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds all given JAX-RS resources as singleton to all specified listeners.
- addListener(T) - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
Adds a new Listener at runtime
- addListener(Listener) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a new listener to the REST Service programmatically.
- addMessageBodyReader(Class<? extends MessageBodyReader>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a MessageBodyReader to all listeners.
- addMessageBodyReader(Class<? extends MessageBodyReader>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a MessageBodyReader to all specified listeners.
- addMessageBodyWriter(Class<? extends MessageBodyWriter>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a MessageBodyWriter to all listeners.
- addMessageBodyWriter(Class<? extends MessageBodyWriter>, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a MessageBodyWriter to all specified listeners.
- addOrReplace(RetainedMessage) - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
This method adds or replaces a retained message
- addOrReplace(RetainedMessage) - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
This method adds or replaces a retained message
- addOrReplace(RetainedMessage) - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- Address - Class in com.hivemq.spi.bridge
-
Deprecated.
- Address(String, int) - Constructor for class com.hivemq.spi.bridge.Address
-
Deprecated.
- addServlet(HttpServlet, String) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet instance to a specific path and adds the servlet to all available listeners.
- addServlet(HttpServlet, String, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet instance to a specific path and adds the servlet to all specified listeners.
- addServlet(Class<T>, String) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet to a specific path and adds the servlet to all available listeners.
- addServlet(Class<T>, String, Collection<String>) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet to a specific path and adds the servlet to all specified listeners.
- addServletWithFilters(HttpServlet, String, ServletFilter<? extends Filter>...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet instance to a specific path and adds the servlet to all available listeners.
- addServletWithFilters(HttpServlet, String, Collection<String>, ServletFilter<? extends Filter>...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet instance to a specific path and adds the servlet to all specific listeners.
- addServletWithFilters(Class<T>, String, ServletFilter<? extends Filter>...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet to a specific path and adds the servlet to all available listeners.
- addServletWithFilters(Class<T>, String, Collection<String>, ServletFilter<? extends Filter>...) - Method in interface com.hivemq.spi.services.rest.RESTService
-
Adds a servlet to a specific path and adds the servlet to all specified listeners.
- addSharedSubscriptions(String...) - Method in interface com.hivemq.spi.services.SharedSubscriptionService
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- addSubscription(String, Topic) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method adds a subscription for a certain client to a certain topic.
- addSubscription(String, Topic) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method adds a subscription for a certain client to a certain topic.
- addSubscription(String, Topic) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- addSubscriptions(String, Set<Topic>) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method adds subscriptions for a certain client to certain topics.
- addSubscriptions(String, Set<Topic>) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method adds subscriptions for a certain client to certain topics.
- afterFailedLogin(AuthenticationException, ClientData) - Method in interface com.hivemq.spi.callback.security.AfterLoginCallback
-
Called after a client was denied authentication
The client will be disconnected after calling this method.
- AfterLoginCallback - Interface in com.hivemq.spi.callback.security
-
The methods of this callback get called when a login attempt was made.
- afterSuccessfulLogin(ClientData) - Method in interface com.hivemq.spi.callback.security.AfterLoginCallback
-
Called after a client was granted authentication
- allowExtensions(boolean) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets if websocket extensions should be allowed or not
- allowExtensions - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- allowExtensions(boolean) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Sets if websocket extensions should be allowed or not
- AsyncClientGroupService - Interface in com.hivemq.spi.services
-
Through this client group service a plugin can add clients to groups, remove clients from groups, query groups and query clients belonging to a group.
- AsyncClientService - Interface in com.hivemq.spi.services
-
Through this client service a plugin can query details about connected or disconnected clients (with a persistent session) from the HiveMQ core.
- AsynchronousCallback - Interface in com.hivemq.spi.callback
-
A callback which gets executed asynchronously.
- AsyncMetricService - Interface in com.hivemq.spi.services
-
This service allows plugins to get or add global HiveMQ metrics.
- AsyncRetainedMessageStore - Interface in com.hivemq.spi.services
-
The retained message store allows the management of retained messages from within plugins
- AsyncSessionAttributeStore - Interface in com.hivemq.spi.services
-
Through this service a plugin can manage client session attributes with the same lifetime as the MQTT client session.
- AsyncSubscriptionStore - Interface in com.hivemq.spi.services
-
The subscription store allows the management of all client subscriptions from within a plugin
- AuthenticationException - Exception in com.hivemq.spi.callback.exception
-
Indicates that the authentication of a certain client failed.
- AuthenticationException(ReturnCode) - Constructor for exception com.hivemq.spi.callback.exception.AuthenticationException
-
- AuthenticationException(String, ReturnCode) - Constructor for exception com.hivemq.spi.callback.exception.AuthenticationException
-
- AuthorizationBehaviour - Enum in com.hivemq.spi.callback.security.authorization
-
The Authorization behaviour which defines if
an authorization was granted, denied or if
another callback should be called
- AuthorizationEvaluator - Class in com.hivemq.spi.security
-
Evaluator for the results of a OnAuthorizationCallback against a PUBLISH or a subscription.
- AuthorizationEvaluator() - Constructor for class com.hivemq.spi.security.AuthorizationEvaluator
-
- AuthorizationResult - Interface in com.hivemq.spi.callback.security.authorization
-
The Result of one OnAuthorizationCallback call
- beforePublishSend(ModifiablePUBLISH, ClientData) - Method in interface com.hivemq.spi.callback.events.BeforePublishSendCallback
-
- BeforePublishSendCallback - Interface in com.hivemq.spi.callback.events
-
Gets called just before a
PUBLISH message is sent to a client.
- BeforePublishSendException - Exception in com.hivemq.spi.callback.exception
-
- BeforePublishSendException() - Constructor for exception com.hivemq.spi.callback.exception.BeforePublishSendException
-
- bindAddress(String) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets the bind address of the TLS websocket listener
- bindAddress - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- bindAddress(String) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Sets the bind address of the websocket listener
- BlockingClientGroupService - Interface in com.hivemq.spi.services
-
Through this client group service a plugin can add clients to groups, remove clients from groups, query groups and query clients belonging to a group.
- BlockingClientService - Interface in com.hivemq.spi.services
-
Through this client service a plugin can query details about connected or disconnected clients (with a persistent session) from the HiveMQ core.
- BlockingMetricService - Interface in com.hivemq.spi.services
-
This service allows plugins to get or add global HiveMQ metrics.
- BlockingRetainedMessageStore - Interface in com.hivemq.spi.services
-
The retained message store allows the management of retained messages from within plugins
- BlockingSessionAttributeStore - Interface in com.hivemq.spi.services
-
Through this service a plugin can manage client session attributes with the same lifetime as the MQTT client session.
- BlockingSubscriptionStore - Interface in com.hivemq.spi.services
-
The subscription store allows the management of all client subscriptions from within a plugin
- Bridge - Class in com.hivemq.spi.bridge
-
Deprecated.
- Bridge() - Constructor for class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- BridgeException - Exception in com.hivemq.spi.exceptions
-
An exception which indicates that a bridge error occurred or a bridge configuration
was invalid
- BridgeException(String) - Constructor for exception com.hivemq.spi.exceptions.BridgeException
-
- BridgeException(String, Throwable) - Constructor for exception com.hivemq.spi.exceptions.BridgeException
-
- BridgeException(Throwable) - Constructor for exception com.hivemq.spi.exceptions.BridgeException
-
- BridgeManagerService - Interface in com.hivemq.spi.services
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- BrokerUnableToStartException - Exception in com.hivemq.spi.callback.exception
-
Indicates that the broker is unable to start because some preconditions
for a safe startup are not satisfied.
- BrokerUnableToStartException() - Constructor for exception com.hivemq.spi.callback.exception.BrokerUnableToStartException
-
- BrokerUnableToStartException(String) - Constructor for exception com.hivemq.spi.callback.exception.BrokerUnableToStartException
-
- BrokerUnableToStartException(String, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.BrokerUnableToStartException
-
- BrokerUnableToStartException(Throwable) - Constructor for exception com.hivemq.spi.callback.exception.BrokerUnableToStartException
-
- build() - Method in class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties.Builder
-
Build the properties object.
- build() - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Creates the TLS Websocket Listener
- build() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Creates the Websocket Listener
- BYTES_READ_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current (last 5 seconds) amount of read bytes
- BYTES_READ_TOTAL - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the total amount of read bytes
- BYTES_WRITE_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current (last 5 seconds) amount of written bytes
- BYTES_WRITE_TOTAL - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds total of written bytes
- Cached - Annotation Type in com.hivemq.spi.aop.cache
-
Caches the return value of a method for a specific time.
- Callback - Interface in com.hivemq.spi.callback
-
General marker interface for callbacks.
- CALLBACK_EXECUTOR_PREFIX - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- CallbackPriority - Class in com.hivemq.spi.callback
-
Useful constants for common priorities
- CallbackPriority() - Constructor for class com.hivemq.spi.callback.CallbackPriority
-
- CallbackRegistry - Interface in com.hivemq.spi.callback.registry
-
The callback registry is used by HiveMQ to determine, which callbacks are implemented.
- certificate() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- certificateChain() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- checkCredentials(ClientCredentialsData) - Method in interface com.hivemq.spi.callback.security.OnAuthenticationCallback
-
Checks the credentials after a CONNECT message arrives.
- checkCredentials(String, String) - Method in interface com.hivemq.spi.callback.webui.WebUIAuthenticationCallback
-
Checks the credentials for a WebUI login.
- checkPublish(String, QoS, boolean, AuthorizationResult) - Static method in class com.hivemq.spi.security.AuthorizationEvaluator
-
- checkSubscription(String, QoS, AuthorizationResult) - Static method in class com.hivemq.spi.security.AuthorizationEvaluator
-
- clear() - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Removes all callbacks from the Callback Registry
- clear() - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
Removes all retained messages from the message store.
- clear(String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Clears all session attributes for a persistent client.
- clear() - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
Removes all retained messages from the message store.
- clear(String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Clears all session attributes for the connected client.
- clear() - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Clears all connection attributes for the connected client.
- clear() - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- CLIENT_SESSIONS_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which measures the current count of stored sessions
- ClientCredentialsData - Interface in com.hivemq.spi.security
-
An extended version of
ClientData which also contains
the password the client used in the
CONNECT
message
- ClientData - Interface in com.hivemq.spi.security
-
Represents information available of a connected client.
- ClientService - Interface in com.hivemq.spi.services
-
- ClientWriteBufferProperties - Class in com.hivemq.spi.services.configuration.entity
-
Allows the customization of write buffer behaviour.
- ClientWriteBufferProperties(int, int) - Constructor for class com.hivemq.spi.services.configuration.entity.ClientWriteBufferProperties
-
- clientWriteBufferProperties - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- CLUSTER_NAME_REQUEST_RETRY_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which measures the current count of retry that have been processed to request the name of other cluster nodes.
- CLUSTER_NODE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of nodes in cluster
- CLUSTER_TOPOLOGY_CHANGE_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the time spent waiting for cluster topology changes
- ClusterDiscoveryCallback - Interface in com.hivemq.spi.callback.cluster
-
This callback is meant to regularly discover the addresses of all available HiveMQ cluster nodes.
- ClusterNodeAddress - Class in com.hivemq.spi.callback.cluster
-
Represents a cluster node's address
- ClusterNodeAddress(String, int) - Constructor for class com.hivemq.spi.callback.cluster.ClusterNodeAddress
-
- com.hivemq.spi - package com.hivemq.spi
-
- com.hivemq.spi.annotations - package com.hivemq.spi.annotations
-
- com.hivemq.spi.aop.cache - package com.hivemq.spi.aop.cache
-
- com.hivemq.spi.bridge - package com.hivemq.spi.bridge
-
- com.hivemq.spi.callback - package com.hivemq.spi.callback
-
- com.hivemq.spi.callback.cluster - package com.hivemq.spi.callback.cluster
-
- com.hivemq.spi.callback.events - package com.hivemq.spi.callback.events
-
- com.hivemq.spi.callback.events.broker - package com.hivemq.spi.callback.events.broker
-
- com.hivemq.spi.callback.exception - package com.hivemq.spi.callback.exception
-
- com.hivemq.spi.callback.lowlevel - package com.hivemq.spi.callback.lowlevel
-
- com.hivemq.spi.callback.registry - package com.hivemq.spi.callback.registry
-
- com.hivemq.spi.callback.schedule - package com.hivemq.spi.callback.schedule
-
- com.hivemq.spi.callback.security - package com.hivemq.spi.callback.security
-
- com.hivemq.spi.callback.security.authorization - package com.hivemq.spi.callback.security.authorization
-
- com.hivemq.spi.callback.webui - package com.hivemq.spi.callback.webui
-
- com.hivemq.spi.config - package com.hivemq.spi.config
-
- com.hivemq.spi.exceptions - package com.hivemq.spi.exceptions
-
- com.hivemq.spi.message - package com.hivemq.spi.message
-
- com.hivemq.spi.metrics - package com.hivemq.spi.metrics
-
- com.hivemq.spi.metrics.annotations - package com.hivemq.spi.metrics.annotations
-
- com.hivemq.spi.plugin.meta - package com.hivemq.spi.plugin.meta
-
- com.hivemq.spi.security - package com.hivemq.spi.security
-
- com.hivemq.spi.services - package com.hivemq.spi.services
-
- com.hivemq.spi.services.configuration - package com.hivemq.spi.services.configuration
-
- com.hivemq.spi.services.configuration.entity - package com.hivemq.spi.services.configuration.entity
-
- com.hivemq.spi.services.configuration.exception - package com.hivemq.spi.services.configuration.exception
-
- com.hivemq.spi.services.configuration.listener - package com.hivemq.spi.services.configuration.listener
-
- com.hivemq.spi.services.configuration.validation - package com.hivemq.spi.services.configuration.validation
-
- com.hivemq.spi.services.configuration.validation.annotation - package com.hivemq.spi.services.configuration.validation.annotation
-
- com.hivemq.spi.services.configuration.validation.validators - package com.hivemq.spi.services.configuration.validation.validators
-
- com.hivemq.spi.services.exception - package com.hivemq.spi.services.exception
-
- com.hivemq.spi.services.rest - package com.hivemq.spi.services.rest
-
- com.hivemq.spi.services.rest.listener - package com.hivemq.spi.services.rest.listener
-
- com.hivemq.spi.services.rest.servlet - package com.hivemq.spi.services.rest.servlet
-
- com.hivemq.spi.topic - package com.hivemq.spi.topic
-
- com.hivemq.spi.topic.exception - package com.hivemq.spi.topic.exception
-
- com.hivemq.spi.topic.sys - package com.hivemq.spi.topic.sys
-
- com.hivemq.spi.util - package com.hivemq.spi.util
-
- commonName() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- compareTo(Topic) - Method in class com.hivemq.spi.message.Topic
-
- ConfigurationService - Interface in com.hivemq.spi.services
-
The Configuration Service interface which allows to change HiveMQ configuration
programmatically.
- ConfigurationValidationException - Exception in com.hivemq.spi.services.configuration.exception
-
This exception indicates that a configuration was no successful
- ConfigurationValidationException(List<ValidationError>) - Constructor for exception com.hivemq.spi.services.configuration.exception.ConfigurationValidationException
-
- configure() - Method in class com.hivemq.spi.HiveMQPluginModule
- configurePlugin() - Method in class com.hivemq.spi.HiveMQPluginModule
-
This method should be used to configure the Guice Bindings and Guice Configurations.
- CONNACK - Class in com.hivemq.spi.message
-
The MQTT CONNACK message
- CONNACK(ReturnCode) - Constructor for class com.hivemq.spi.message.CONNACK
-
- CONNACK(ReturnCode, boolean) - Constructor for class com.hivemq.spi.message.CONNACK
-
- CONNECT - Class in com.hivemq.spi.message
-
The MQTT CONNECT message
- CONNECT() - Constructor for class com.hivemq.spi.message.CONNECT
-
- ConnectionAttributeStore - Interface in com.hivemq.spi.services
-
Through this service a plugin can manage client connection attributes with the same lifetime as the connection.
- CONNECTIONS_CLOSED_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which is increased every time a network connection is closed
- CONNECTIONS_CLOSED_GRACEFUL_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which is increased every time a network connection is closed gracefully.
- CONNECTIONS_CLOSED_UNGRACEFUL_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which is increased every time a network connection is closed ungraceful.
- CONNECTIONS_OVERALL_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current total number of connections
- CONNECTIONS_OVERALL_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which holds the mean total number of connections
- ConnectOverloadProtectionProperties - Class in com.hivemq.spi.services.configuration.entity
-
Enables the overload protection for MQTT CONNECT messages processed by HiveMQ.
- ConnectOverloadProtectionProperties(double, long) - Constructor for class com.hivemq.spi.services.configuration.entity.ConnectOverloadProtectionProperties
-
- ConnectOverloadProtectionProperties(double) - Constructor for class com.hivemq.spi.services.configuration.entity.ConnectOverloadProtectionProperties
-
- connectOverloadProtectionProperties - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- contains(String) - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
Checks if a retained message is present in the retained message store.
- contains(String) - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
Checks if a retained message is present in the retained message store.
- contains(RetainedMessage) - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- contains(SYSTopicEntry) - Method in interface com.hivemq.spi.services.SYSTopicService
-
- containsLocally(String) - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
Checks if a retained message is present in the retained message store, on this HiveMQ instance.
- containsLocally(String) - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
Checks if a retained message is present in the retained message store, on this HiveMQ instance.
- copy() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- copy(PUBLISH) - Static method in class com.hivemq.spi.message.PUBLISH
-
Crates a deep copy of a
PUBLISH object.
- Counted - Annotation Type in com.hivemq.spi.metrics.annotations
-
Methods annotated with this annotation are added to the HiveMQ MetricRegistry
automatically as Counters.
- country() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- CRITICAL - Static variable in class com.hivemq.spi.callback.CallbackPriority
-
- cronExpression() - Method in interface com.hivemq.spi.callback.schedule.ScheduledCallback
-
This method returns the quartz-like cron expression for the callback.
- DEFAULT_NOTIFICATION_TOPIC - Static variable in class com.hivemq.spi.bridge.Notification
-
Deprecated.
The default notification topic on remote brokers:
$SYS/broker/connection/#{clientId}/state
- DefaultSslEngineUtil - Class in com.hivemq.spi.util
-
A utility class which allows to find out information about
the default SSL Engine from the JVM
- DefaultSslEngineUtil() - Constructor for class com.hivemq.spi.util.DefaultSslEngineUtil
-
- description() - Method in interface com.hivemq.spi.topic.sys.SYSTopicEntry
-
Returns a description of this $SYS topic
- destroy() - Method in interface com.hivemq.spi.callback.cluster.ClusterDiscoveryCallback
-
Gets called when the cluster is shut down.
- DIRECT_MEMORY_USED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the currently used direct memory in bytes
- DISCARD - Static variable in class com.hivemq.spi.security.QueuedMessageStrategy
-
- DISCARD_OLDEST - Static variable in class com.hivemq.spi.security.QueuedMessageStrategy
-
- DISCONNECT - Class in com.hivemq.spi.message
-
- DISCONNECT() - Constructor for class com.hivemq.spi.message.DISCONNECT
-
- disconnectClient(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Forcefully disconnect a client with the specified clientId.
- disconnectClient(String, boolean) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Forcefully disconnect a client with the specified clientId.
- disconnectClient(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Forcefully disconnect a client with the specified clientId.
- disconnectClient(String, boolean) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Forcefully disconnect a client with the specified clientId.
- DROPPED_MESSAGE_BEFORE_PUBLISH_SEND_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Counter, which counts PUBLISH messages that have been dropped, because an exception was thrown in a
BeforePublishSendCallback
- DROPPED_MESSAGE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every dropped PUBLISH messages
- DROPPED_MESSAGE_IN_FLIGHT_WINDOW_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts PUBLISH messages that have been dropped, because the in-flight message queue for the client was full
- DROPPED_MESSAGE_INTERNAL_ERROR - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts PUBLISH messages that have been dropped, because of an internal error
- DROPPED_MESSAGE_NOT_CONNECTED_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts the PUBLISH messages that have been dropped, because a clean session client disconnected before the message could be sent
- DROPPED_MESSAGE_NOT_WRITABLE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts PUBLISH messages that have been dropped, because the socket for the client was not writable (only QoS 0)
- DROPPED_MESSAGE_QUEUE_FULL_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts PUBLISH messages that have been dropped, because the message queue for a disconnected persistent session client was full
- DROPPED_MESSAGE_QUEUE_NOT_EMPTY - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts PUBLISH messages that have been dropped, because there QoS was 0 and the client session queue was not yet empty
- DROPPED_MESSAGE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of dropped PUBLISH messages
- gaugeValue(String) - Static method in class com.hivemq.spi.metrics.HiveMQMetric
-
- generalConfiguration() - Method in interface com.hivemq.spi.services.ConfigurationService
-
Returns the configuration service for general HiveMQ configuration
- GeneralConfigurationService - Interface in com.hivemq.spi.services.configuration
-
A Configuration service which allows to get information about the current General configuration
and allows to change the global General configuration of HiveMQ at runtime.
- get(String, String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- get(String, String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- get(String) - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Retrieves the value of the connection attribute with the given key for the connected client.
- getActivity() - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- getAddresses() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getAll(String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Retrieves all session attributes for a persistent client.
- getAll(String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Retrieves all session attributes for a persistent client.
- getAll() - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Retrieves all connection attributes for the connected client.
- getAllCallbacks() - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Returns a set of all available callbacks in the Callback Registry
- getAllEntries(Type...) - Method in interface com.hivemq.spi.services.SYSTopicService
-
- getAllowExtensions() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
-
- getAllRegisteredCallbackClasses() - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Returns a set of all callback interfaces for which callbacks are available.
- getAsString(String, String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- getAsString(String, String, Charset) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- getAsString(String, String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- getAsString(String, String, Charset) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Retrieves the value of the session attribute with the given key for a persistent client.
- getAsString(String) - Method in interface com.hivemq.spi.services.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.spi.services.ConnectionAttributeStore
-
Retrieves the value of the connection attribute with the given key for the connected client as string with the given charset.
- getAvailableGroups() - Method in interface com.hivemq.spi.services.AsyncClientGroupService
-
Retrieves all available groups.
- getAvailableGroups() - Method in interface com.hivemq.spi.services.BlockingClientGroupService
-
Retrieves all available groups.
- getBindAddress() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- getBindAddress() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- getBindAddress() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- getBridgeState(Bridge) - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- getCallbackRegistry() - Method in class com.hivemq.spi.PluginEntryPoint
-
Returns global Callback registry
- getCallbacks(Class<T>) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Returns a list of all available callbacks for a specific callback class.
- getCertificate() - Method in interface com.hivemq.spi.security.ClientData
-
- getCipherSuites() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getClazz() - Method in class com.hivemq.spi.metrics.HiveMQMetric
-
- getClientAuthMode() - Method in enum com.hivemq.spi.services.configuration.entity.Tls.ClientAuthMode
-
- getClientAuthMode() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getClientData(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns additional client information about a given client with a given client identifier.
- getClientData(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns additional client information about a given client with a given client identifier.
- getClientDataForClientId(String) - Method in interface com.hivemq.spi.services.ClientService
-
- getClientId() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getClientId() - Method in interface com.hivemq.spi.security.ClientData
-
- getClientId() - Method in exception com.hivemq.spi.services.exception.NoSuchClientIdException
-
Returns the unknown MQTT ClientId.
- getClientIdentifier() - Method in class com.hivemq.spi.message.CONNECT
-
- getClientsForGroup(String) - Method in interface com.hivemq.spi.services.AsyncClientGroupService
-
Retrieves the clients for a group.
- getClientsForGroup(String) - Method in interface com.hivemq.spi.services.BlockingClientGroupService
-
Retrieves the clients for a group.
- getClientWriteBufferProperties() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- getClientWriteBufferProperties() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- getClientWriteBufferProperties() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- getClusterMetric(HiveMQMetric<T>) - Method in interface com.hivemq.spi.services.AsyncMetricService
-
Returns a map which contains an entry for every node in the cluster with the given HiveMQ metric.
- getClusterMetric(HiveMQMetric<T>) - Method in interface com.hivemq.spi.services.BlockingMetricService
-
Returns a map which contains an entry for every node in the cluster with the given HiveMQ metric.
- getCode() - Method in enum com.hivemq.spi.message.ReturnCode
-
- getCode() - Method in enum com.hivemq.spi.message.SubackReturnCode
-
- getConcurrentHandshakeLimit() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getConfigFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getConnectBurstSize() - Method in class com.hivemq.spi.services.configuration.entity.ConnectOverloadProtectionProperties
-
- getConnectedClients() - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns all identifiers of connected clients of this HiveMQ instance and all other nodes in a HiveMQ cluster
Calling this method frequently in a clustered environment could have negative performance effects.
- getConnectedClients() - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns all identifiers of connected clients of this HiveMQ instance and all other nodes in a HiveMQ cluster
Calling this method frequently in a clustered environment could have negative performance effects.
- getConnectedClients() - Method in interface com.hivemq.spi.services.ClientService
-
- getConnectionAttributeStore() - Method in interface com.hivemq.spi.security.ClientData
-
- getConnectionName() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getConnectOverloadProtectionProperties() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- getConnectOverloadProtectionProperties() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- getConnectOverloadProtectionProperties() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- getConnectRate() - Method in class com.hivemq.spi.services.configuration.entity.ConnectOverloadProtectionProperties
-
- getDataFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getDefaultBehaviour() - Method in interface com.hivemq.spi.callback.security.authorization.AuthorizationResult
-
- getDefaultBehaviour() - Method in interface com.hivemq.spi.callback.security.OnAuthorizationCallback
-
Declares the default behaviour to use if none of the
MqttTopicPermissions returned by getPermissionForClient matches an activity.
- getDisconnectClient() - Method in exception com.hivemq.spi.callback.exception.OnPublishReceivedException
-
- getDisconnectedClients() - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns all disconnected clients which have a persistent MQTT session on this broker or any other cluster node.
- getDisconnectedClients() - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns all disconnected clients which have a persistent MQTT session on this broker or any other cluster node.
- getDisconnectedClients() - Method in interface com.hivemq.spi.services.ClientService
-
- getDisconnectTimestamp() - Method in interface com.hivemq.spi.security.ClientData
-
Returns optional
Long that contains the disconnect timestamp.
- getDispatcherTypes() - Method in class com.hivemq.spi.services.rest.servlet.ServletFilter
-
Returns a immutable list of all supported Dispatcher types by that filter
- getEnabledCipherSuites() - Method in class com.hivemq.spi.util.DefaultSslEngineUtil
-
Returns a list of all enabled cipher suites of the JVM
- getEnabledProtocols() - Method in class com.hivemq.spi.util.DefaultSslEngineUtil
-
Returns a list of all enabled protocols of the JVM
- getEntry(String) - Method in interface com.hivemq.spi.services.SYSTopicService
-
- getFilter() - Method in class com.hivemq.spi.services.rest.servlet.ServletFilter
-
- getFilterClass() - Method in class com.hivemq.spi.services.rest.servlet.ServletFilter
-
- getGrantedQos() - Method in class com.hivemq.spi.message.SUBACK
-
- getHandshakeTimeout() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getHighThreshold() - Method in class com.hivemq.spi.services.configuration.entity.ClientWriteBufferProperties
-
- getHiveMQConfigFolder() - Static method in class com.hivemq.spi.util.PathUtils
-
- getHiveMQHomeFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getHiveMQHomeFolder() - Static method in class com.hivemq.spi.util.PathUtils
-
- getHiveMQLogFolder() - Static method in class com.hivemq.spi.util.PathUtils
-
- getHiveMQMetric(HiveMQMetric<T>) - Method in interface com.hivemq.spi.services.AsyncMetricService
-
Returns a specific HiveMQ metric.
- getHiveMQMetric(HiveMQMetric<T>) - Method in interface com.hivemq.spi.services.BlockingMetricService
-
Returns a specific HiveMQ metric.
- getHiveMQMetric(HiveMQMetric<T>) - Method in interface com.hivemq.spi.services.MetricService
-
- getHiveMQVersion() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getHost() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getHost() - Method in class com.hivemq.spi.callback.cluster.ClusterNodeAddress
-
- getIdleTimeout() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getInetAddress() - Method in interface com.hivemq.spi.security.ClientData
-
- getInstance() - Static method in exception com.hivemq.spi.callback.exception.BeforePublishSendException
-
- getKeepAlive() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getKeepAliveTimer() - Method in class com.hivemq.spi.message.CONNECT
-
- getKeystore() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getKeystorePassword() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getKeystorePassword() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getKeystorePath() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getKeystoreType() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getLicenseFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getListener() - Method in interface com.hivemq.spi.security.ClientData
-
Returns the listener the client connected to.
- getListeners() - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
- getListeners() - Method in interface com.hivemq.spi.services.rest.RESTService
-
Returns an immutable view of all listeners.
- getLocalClientData(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns client information for clients that are connected to this broker instance.
- getLocalClientData(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns client information for clients that are connected to this broker instance.
- getLocalClientDataForClientId(String) - Method in interface com.hivemq.spi.services.ClientService
-
- getLocalConnectedClients() - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns all identifiers of connected clients of this HiveMQ Node.
- getLocalConnectedClients() - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns all identifiers of connected clients of this HiveMQ Node.
- getLocalConnectedClients() - Method in interface com.hivemq.spi.services.ClientService
-
- getLocalDisconnectedClients() - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns all disconnected clients which have a persistent MQTT session on this instance of HiveMQ (MQTT clean session=false).
- getLocalDisconnectedClients() - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns all disconnected clients which have a persistent MQTT session on this instance of HiveMQ (MQTT clean session=false).
- getLocalDisconnectedClients() - Method in interface com.hivemq.spi.services.ClientService
-
- getLocalPrefix() - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- getLocalRetainedMessages() - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
- getLocalRetainedMessages() - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
- getLocalSubscribers(String) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
Returns all MQTT client subscriber identifiers for a given topic, for this HiveMQ instance.
- getLocalSubscribers(String) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
Returns all MQTT client subscriber identifiers for a given topic, for this HiveMQ instance.
- getLocalSubscribers(String) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getLocalSubscriptions() - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method returns all subscriptions on this HiveMQ Node as a Multimap of client identifiers and topics.
- getLocalSubscriptions() - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method returns all subscriptions on this HiveMQ Node as a Multimap of client identifiers and topics.
- getLocalSubscriptions() - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getLocalTopics(String) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
Returns all topics a client is subscribed to, on this HiveMQ instance.
- getLocalTopics(String) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
Returns all topics a client is subscribed to, on this HiveMQ instance.
- getLocalTopics(String) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getLogFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getLogLevel() - Method in interface com.hivemq.spi.services.LogService
-
Returns the current log level of the internal HiveMQ logger
- getLowThreshold() - Method in class com.hivemq.spi.services.configuration.entity.ClientWriteBufferProperties
-
- getMessage() - Method in class com.hivemq.spi.message.RetainedMessage
-
- getMessage() - Method in class com.hivemq.spi.services.configuration.validation.ValidationError
-
- getMessageId() - Method in class com.hivemq.spi.message.MessageWithID
-
- getMessageId() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- getMessageId() - Method in class com.hivemq.spi.message.SUBSCRIBE
-
- getMetricRegistry() - Method in interface com.hivemq.spi.services.AsyncMetricService
-
Returns the metric registry of HiveMQ.
- getMetricRegistry() - Method in interface com.hivemq.spi.services.BlockingMetricService
-
Returns the metric registry of HiveMQ.
- getMetricRegistry() - Method in interface com.hivemq.spi.services.MetricService
-
- getMinimumNeededVersion() - Method in exception com.hivemq.spi.services.exception.IncompatibleHiveMQVersionException
-
Returns the minimum needed version of the HiveMQ broker.
- getMqttTopicPermissions() - Method in interface com.hivemq.spi.callback.security.authorization.AuthorizationResult
-
A list of all topic permissions which are granted
- getNodeAddresses() - Method in interface com.hivemq.spi.callback.cluster.ClusterDiscoveryCallback
-
Gets called every X seconds by HiveMQ to discover all available cluster nodes.
- getNotification() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getOcspCacheInterval() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getOcspOverrideUrl() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
ocspOverrideUrl = URL to OCSP responder.
- getPassword() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getPassword() - Method in class com.hivemq.spi.message.CONNECT
-
- getPassword() - Method in interface com.hivemq.spi.security.ClientCredentialsData
-
Returns an Optional of the clear text password the client used encoded
as UTF-8.
- getPasswordAsUTF8String() - Method in class com.hivemq.spi.message.CONNECT
-
- getPasswordBytes() - Method in interface com.hivemq.spi.security.ClientCredentialsData
-
Returns an Optional of the text password the client used
- getPath() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
-
- getPattern() - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- getPayload() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- getPayload() - Method in class com.hivemq.spi.message.PUBLISH
-
- getPayload() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- getPermissionsForClient(ClientData) - Method in interface com.hivemq.spi.callback.security.OnAuthorizationCallback
-
- getPluginFolder() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getPluginFolder() - Static method in class com.hivemq.spi.util.PathUtils
-
- getPort() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getPort() - Method in class com.hivemq.spi.callback.cluster.ClusterNodeAddress
-
- getPort() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- getPort() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- getPort() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- getPrivateKeyPassword() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getProtocols() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getProtocolVersion() - Method in class com.hivemq.spi.message.CONNECT
-
- getProxyInformation() - Method in interface com.hivemq.spi.security.ClientData
-
Returns optional
ProxyInformation that contains information from
the PROXY protocol.
- getPublishRetain() - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- getQoS() - Method in class com.hivemq.spi.bridge.Notification
-
Deprecated.
- getQoS() - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- getQoS() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- getQoS() - Method in class com.hivemq.spi.message.PUBLISH
-
- getQoS() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- getQoS() - Method in class com.hivemq.spi.message.RetainedMessage
-
- getQoS() - Method in class com.hivemq.spi.message.Topic
-
- getQos() - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- getQosNumber() - Method in enum com.hivemq.spi.message.QoS
-
- getReceiveBufferSize() - Method in class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties
-
Get the receive buffer size.
- getRemotePrefix() - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- getRestartTimeout() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getRestrictions(ClientData) - Method in interface com.hivemq.spi.callback.security.RestrictionsAfterLoginCallback
-
Gets called after a successful login of a client.
- getRetainedMessage(String) - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
- getRetainedMessage(String) - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
- getRetainedMessage(String) - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
Deprecated.
Use RetainedMessageStoreLocal or RetainedMessageStoreCluster instead.
- getRetainedMessages() - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
- getRetainedMessages() - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
- getRetainedMessages() - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
Deprecated.
- getReturnCode() - Method in exception com.hivemq.spi.callback.exception.AuthenticationException
-
- getReturnCode() - Method in exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- getReturnCode() - Method in class com.hivemq.spi.message.CONNACK
-
- getRunningSince() - Method in interface com.hivemq.spi.config.SystemInformation
-
- getSendBufferSize() - Method in class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties
-
Get the send buffer size.
- getSharedSubscriptions() - Method in interface com.hivemq.spi.services.SharedSubscriptionService
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- getSharedSubscriptionsSize() - Method in interface com.hivemq.spi.services.SharedSubscriptionService
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- getSocketOptionsProperties() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- getSocketOptionsProperties() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- getSocketOptionsProperties() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- getStartType() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getSubackReturnCodeForClient(Topic, SubackReturnCode, ClientData) - Method in interface com.hivemq.spi.callback.events.OnTopicSubscriptionCallback
-
- getSubprotocols() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
-
- getSubscribers(String) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
Returns all MQTT client subscriber identifiers for a given topic, this HiveMQ instance and all other nodes in a HiveMQ cluster.
- getSubscribers(String) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
Returns all MQTT client subscriber identifiers for a given topic, this HiveMQ instance and all other nodes in a HiveMQ cluster.
- getSubscribers(String) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getSubscriptions() - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method returns all subscriptions this HiveMQ instance and all other nodes in a HiveMQ cluster,
as a Multimap of client identifiers and topics.
- getSubscriptions() - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method returns all subscriptions this HiveMQ instance and all other nodes in a HiveMQ cluster,
as a Multimap of client identifiers and topics.
- getSubscriptions() - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getSupportedCipherSuites() - Method in class com.hivemq.spi.util.DefaultSslEngineUtil
-
Returns a list of all supported Cipher Suites of the JVM.
- getSupportedProtocols() - Method in class com.hivemq.spi.util.DefaultSslEngineUtil
-
Returns a list of all supported protocols by the JVM.
- getTcpListeners() - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
- getThreshold() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getTimestamp() - Method in class com.hivemq.spi.message.PUBLISH
-
- getTls() - Method in class com.hivemq.spi.services.configuration.entity.TlsTcpListener
-
- getTls() - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener
-
- getTlsTcpListeners() - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
- getTlsVersion() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getTlsVersion() - Method in enum com.hivemq.spi.bridge.TLSVersion
-
Deprecated.
- getTlsWebsocketListeners() - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
- getTopic() - Method in class com.hivemq.spi.bridge.Notification
-
Deprecated.
- getTopic() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- getTopic() - Method in class com.hivemq.spi.message.PUBLISH
-
- getTopic() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- getTopic() - Method in class com.hivemq.spi.message.RetainedMessage
-
- getTopic() - Method in class com.hivemq.spi.message.Topic
-
- getTopic() - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- getTopicPatterns() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getTopics() - Method in class com.hivemq.spi.message.SUBSCRIBE
-
- getTopics() - Method in class com.hivemq.spi.message.UNSUBSCRIBE
-
- getTopics(String) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
Returns all topics a client is subscribed to, on this HiveMQ instance and all other nodes in a HiveMQ cluster.
- getTopics(String) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
Returns all topics a client is subscribed to, on this HiveMQ instance and all other nodes in a HiveMQ cluster.
- getTopics(String) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- getTrustStore() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getTrustStorePassword() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- getTruststorePassword() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getTruststorePath() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getTruststoreType() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- getTTL() - Method in class com.hivemq.spi.message.PUBLISH
-
- getTTL(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Returns the time to live for a client session in seconds.
- getTTL(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Returns the time to live for a client session in seconds.
- getType() - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- getType() - Method in enum com.hivemq.spi.bridge.TopicPattern.Type
-
Deprecated.
- getType() - Method in enum com.hivemq.spi.message.MessageType
-
- getType() - Method in class com.hivemq.spi.security.Restriction
-
- getType() - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- getUsername() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- getUsername() - Method in class com.hivemq.spi.message.CONNECT
-
- getUsername() - Method in interface com.hivemq.spi.security.ClientData
-
- getValidationErrors() - Method in exception com.hivemq.spi.services.configuration.exception.ConfigurationValidationException
-
- getValue() - Method in class com.hivemq.spi.security.Restriction
-
- getValue() - Method in class com.hivemq.spi.services.OptionalAttribute
-
- getWebsocketListeners() - Method in interface com.hivemq.spi.services.configuration.listener.ListenerConfigurationService
-
- getWillMessage() - Method in class com.hivemq.spi.message.CONNECT
-
- getWillQos() - Method in class com.hivemq.spi.message.CONNECT
-
- getWillTopic() - Method in class com.hivemq.spi.message.CONNECT
-
- IllegalBrokerStateException - Exception in com.hivemq.spi.callback.exception
-
Indicates that the broker should stop immediately because something in its current
state prevents a safe operation.
- IllegalBrokerStateException() - Constructor for exception com.hivemq.spi.callback.exception.IllegalBrokerStateException
-
- IllegalBrokerStateException(String) - Constructor for exception com.hivemq.spi.callback.exception.IllegalBrokerStateException
-
- IllegalBrokerStateException(String, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.IllegalBrokerStateException
-
- IllegalBrokerStateException(Throwable) - Constructor for exception com.hivemq.spi.callback.exception.IllegalBrokerStateException
-
- Immutable - Annotation Type in com.hivemq.spi.annotations
-
A marker annotation interface which marks a class as immutable.
- implies(MqttTopicPermission) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given MqttTopicPermission
- implies(String, String[], QoS, MqttTopicPermission.ACTIVITY, boolean) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, QoS, MqttTopicPermission.ACTIVITY, boolean) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, String[], QoS, MqttTopicPermission.ACTIVITY, MqttTopicPermission.RETAIN) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, QoS, MqttTopicPermission.ACTIVITY, MqttTopicPermission.RETAIN) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, String[], QoS, MqttTopicPermission.ACTIVITY) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, QoS, MqttTopicPermission.ACTIVITY) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, String[], MqttTopicPermission.QOS, MqttTopicPermission.ACTIVITY) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
Checks the MqttTopicPermission implies a given topic, qos and activity combination
- implies(String, MqttTopicPermission.QOS, MqttTopicPermission.ACTIVITY) - Method in class com.hivemq.spi.topic.MqttTopicPermission
-
- INCOMING_CONNECT_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT CONNECT messages
- INCOMING_CONNECT_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT CONNECT messages
- INCOMING_DISCONNECT_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT DISCONNECT messages
- INCOMING_DISCONNECT_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT DISCONNECT messages
- INCOMING_MESSAGE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT message
- INCOMING_MESSAGE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT messages
- INCOMING_MESSAGE_SIZE_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which measures the distribution of incoming MQTT message size (payload without fixed header)
- INCOMING_PINGREQ_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PINGREQ messages
- INCOMING_PINGREQ_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PINGREQ messages
- INCOMING_PUBACK_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBACK messages
- INCOMING_PUBACK_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PUBACK messages
- INCOMING_PUBCOMP_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBCOMP messages
- INCOMING_PUBCOMP_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PUBCOMP messages
- INCOMING_PUBLISH_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBLISH messages
- INCOMING_PUBLISH_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PUBLISH messages
- INCOMING_PUBLISH_RETAINED_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBLISH messages with the retained flag set
- INCOMING_PUBLISH_SIZE_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which measures the distribution of incoming MQTT message size (payload without fixed header)
- INCOMING_PUBREC_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBREC messages
- INCOMING_PUBREC_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PUBREC messages
- INCOMING_PUBREL_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT PUBREL messages
- INCOMING_PUBREL_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT PUBREL messages
- INCOMING_SUBSCRIBE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT SUBSCRIBE messages
- INCOMING_SUBSCRIBE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT SUBSCRIBE messages
- INCOMING_UNSUBSCRIBE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every incoming MQTT UNSUBSCRIBE messages
- INCOMING_UNSUBSCRIBE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of incoming MQTT UNSUBSCRIBE messages
- incomingLimit() - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
- incomingLimitChanged(ValueChangedCallback<Long>) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Adds a callback which gets called when the incoming bandwidth limit changes at runtime
- IncompatibleHiveMQVersionException - Exception in com.hivemq.spi.services.exception
-
This exception is used to signal that a HiveMQ cluster contains an instance which is incompatible to the called method.
- IncompatibleHiveMQVersionException(String) - Constructor for exception com.hivemq.spi.services.exception.IncompatibleHiveMQVersionException
-
Creates a new IncompatibleHiveMQVersionException.
- IncompatibleHiveMQVersionException(String, boolean) - Constructor for exception com.hivemq.spi.services.exception.IncompatibleHiveMQVersionException
-
Creates a new IncompatibleHiveMQVersionException.
- Information - Annotation Type in com.hivemq.spi.plugin.meta
-
A annotation which can be used on
HiveMQPluginModules
to set metadata about the project and the author.
- init(String, ClusterNodeAddress) - Method in interface com.hivemq.spi.callback.cluster.ClusterDiscoveryCallback
-
Gets called before the HiveMQ instance starts looking for other HiveMQ instances to form a cluster with.
- invalidateSession(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Invalidates the client session for a client with the given client identifier.
- invalidateSession(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Invalidates the client session for the client with the given client identifier.
- InvalidSubscriptionException - Exception in com.hivemq.spi.callback.exception
-
An exception which can be thrown when one or more subscriptions
in the
SUBSCRIBE message was invalid
- InvalidSubscriptionException() - Constructor for exception com.hivemq.spi.callback.exception.InvalidSubscriptionException
-
- InvalidSubscriptionException(String) - Constructor for exception com.hivemq.spi.callback.exception.InvalidSubscriptionException
-
- InvalidSubscriptionException(String, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.InvalidSubscriptionException
-
- InvalidSubscriptionException(Throwable) - Constructor for exception com.hivemq.spi.callback.exception.InvalidSubscriptionException
-
- InvalidTopicException - Exception in com.hivemq.spi.topic.exception
-
Indicates that a provided topic is not compliant with the definition of a topic in the mqtt specification.
- InvalidTopicException() - Constructor for exception com.hivemq.spi.topic.exception.InvalidTopicException
-
- InvalidTopicException(String) - Constructor for exception com.hivemq.spi.topic.exception.InvalidTopicException
-
- InvalidTopicException(String, Throwable) - Constructor for exception com.hivemq.spi.topic.exception.InvalidTopicException
-
- InvalidTopicException(Throwable) - Constructor for exception com.hivemq.spi.topic.exception.InvalidTopicException
-
- InvalidTTLException - Exception in com.hivemq.spi.callback.exception
-
An exception which is thrown when the time to live was invalid (< -1).
- InvalidTTLException() - Constructor for exception com.hivemq.spi.callback.exception.InvalidTTLException
-
- InvalidTTLException(String) - Constructor for exception com.hivemq.spi.callback.exception.InvalidTTLException
-
- InvalidTTLException(String, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.InvalidTTLException
-
- InvalidTTLException(Throwable) - Constructor for exception com.hivemq.spi.callback.exception.InvalidTTLException
-
- isAccessible() - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Returns whether this connection attribute store is accessible.
- isAnonymous() - Method in interface com.hivemq.spi.security.ClientData
-
- isAuthenticated() - Method in interface com.hivemq.spi.security.ClientData
-
- isBridge() - Method in class com.hivemq.spi.message.CONNECT
-
- isBridge() - Method in interface com.hivemq.spi.security.ClientData
-
- isCallbackAvailable(Class<T>) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Returns true if a callbacks for the specific callback class is registered, false otherwise.
- isCleanSession() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- isCleanSession() - Method in class com.hivemq.spi.message.CONNECT
-
- isClientCertAuthentication() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- isClientConnected(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Check if a client with a given identifier is currently connected to this HiveMQ broker instance or any other instance in the cluster.
- isClientConnected(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Check if a client with a given identifier is currently connected to this HiveMQ broker instance or any other instance in the cluster.
- isClientConnected(String) - Method in interface com.hivemq.spi.services.ClientService
-
- isClientConnectedLocal(String) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Check if a client with a given identifier is currently connected to this HiveMQ instance.
- isClientConnectedLocal(String) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Check if a client with a given identifier is currently connected to this HiveMQ instance.
- isClientConnectedLocal(String) - Method in interface com.hivemq.spi.services.ClientService
-
- isDuplicateDelivery() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- isDuplicateDelivery() - Method in class com.hivemq.spi.message.PUBLISH
-
- isDuplicateDelivery() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- isNativeSsl() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- isNotificationsEnabled() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- isOcspStaplingEnabled() - Method in class com.hivemq.spi.services.configuration.entity.Tls
-
- isPasswordRequired() - Method in class com.hivemq.spi.message.CONNECT
-
- isProxyProtocolSupported() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- isProxyProtocolSupported() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- isProxyProtocolSupported() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- isReplaced() - Method in class com.hivemq.spi.services.OptionalAttribute
-
- isRetain() - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
- isRetain() - Method in class com.hivemq.spi.message.PUBLISH
-
- isRetain() - Method in class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- isRoundRobin() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- isSecure(Listener) - Static method in class com.hivemq.spi.util.Listeners
-
- isSessionPresent() - Method in class com.hivemq.spi.message.CONNACK
-
Returns true if there is already a session present on the
MQTT Broker for a client.
- isShowException() - Method in exception com.hivemq.spi.exceptions.UnrecoverableException
-
- isTlsEnabled() - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- isTryPrivate() - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- isUsernameRequired() - Method in class com.hivemq.spi.message.CONNECT
-
- isWebsocket(Listener) - Static method in class com.hivemq.spi.util.Listeners
-
Checks if a given
Listener is a websocket listener
- isWill() - Method in class com.hivemq.spi.message.CONNECT
-
- isWillRetain() - Method in class com.hivemq.spi.message.CONNECT
-
- offlineClientSessionTimeToLive() - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- OnAuthenticationCallback - Interface in com.hivemq.spi.callback.security
-
This callback gets called when a CONNECT message arrives and is meant to
perform the authentication of a client.
- OnAuthorizationCallback - Interface in com.hivemq.spi.callback.security
-
- OnBrokerReady - Interface in com.hivemq.spi.callback.events.broker
-
*This callback gets called once the broker is started, after network interfaces are bound
and after a possible cluster join was executed.
- onBrokerReady() - Method in interface com.hivemq.spi.callback.events.broker.OnBrokerReady
-
Called, once the broker is ready
- OnBrokerStart - Interface in com.hivemq.spi.callback.events.broker
-
This callback gets called when the broker starts but before network interfaces are bound
and before other bootstrapping actions take place.
- onBrokerStart() - Method in interface com.hivemq.spi.callback.events.broker.OnBrokerStart
-
Called when the broker starts up
- OnBrokerStop - Interface in com.hivemq.spi.callback.events.broker
-
This callback gets executed when the broker shuts down.
- onBrokerStop() - Method in interface com.hivemq.spi.callback.events.broker.OnBrokerStop
-
Called when the broker shuts down
You can use blocking actions in this callback.
- ONCE_A_MINUTE - Static variable in class com.hivemq.spi.callback.schedule.ScheduleExpressions
-
Returns the a Schedule Expression which schedules to the beginning of every minute
- OnConnackSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnConnackSend Callback gets called when the broker sent
a CONNACK message to a client
- onConnackSend(CONNACK, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnConnackSend
-
This method gets called after a CONNACK message was sent to the client.
- onConnect(CONNECT, ClientData) - Method in interface com.hivemq.spi.callback.events.OnConnectCallback
-
This method gets called when a
CONNECT message arrives.
- OnConnectCallback - Interface in com.hivemq.spi.callback.events
-
This callback is called when a CONNECT MQTT message arrives.
- onDisconnect(ClientData, boolean) - Method in interface com.hivemq.spi.callback.events.OnDisconnectCallback
-
- OnDisconnectCallback - Interface in com.hivemq.spi.callback.events
-
This callback gets called when a client disconnects gracefully with a
DISCONNECT message or when disconnects
abruptly by closing the TCP connection .
- OnInsufficientPermissionDisconnect - Interface in com.hivemq.spi.callback.security
-
This callback gets executed after a client was disconnected due to insufficient permissions.
- OnPingCallback - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPingCallback which gets called after a client sent a PINGREQ message
- onPingReceived(ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPingCallback
-
This method gets called after the broker received a PINGREQ message from a client.
- OnPubackReceived - Interface in com.hivemq.spi.callback.lowlevel
-
This callback gets called after a PUBACK message was received from a client
- onPubackReceived(PUBACK, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubackReceived
-
This method gets called every time a client sent a PUBACK message.
- OnPubackSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubackSend callback gets called after HiveMQ sent a PUBACK message to a client
- onPubackSend(PUBACK, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubackSend
-
This method gets called after HiveMQ sent a PUBACK message to a client.
- OnPubcompReceived - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubcompReceived Callback gets called after HiveMQ receives a PUBCOMP
message from a client.
- onPubcompReceived(PUBCOMP, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubcompReceived
-
This method gets called when a PUBCOMP message is received from a client.
- OnPubcompSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubcompSend callback gets executed after a PUBCOMP message was sent by HiveMQ
to a client.
- onPubcompSend(PUBCOMP, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubcompSend
-
This method gets called when HiveMQ sends a PUBCOMP message to a client.
- onPublishDisconnect(ClientData, String, QoS) - Method in interface com.hivemq.spi.callback.security.OnInsufficientPermissionDisconnect
-
Gets executed after a client was disconnected due to insufficient permissions when publishing
- onPublishReceived(PUBLISH, ClientData) - Method in interface com.hivemq.spi.callback.events.OnPublishReceivedCallback
-
Called when a
PUBLISH MQTT message arrives
The publish parameter references the publish object, that is sent to the subscribers,
after the onPublishReceived method was called.
- OnPublishReceivedCallback - Interface in com.hivemq.spi.callback.events
-
Gets called when a
PUBLISH MQTT message arrives.
- OnPublishReceivedException - Exception in com.hivemq.spi.callback.exception
-
This exception can be thrown when a PUBLISH arrives but the PUBLISH is invalid.
- OnPublishReceivedException(boolean) - Constructor for exception com.hivemq.spi.callback.exception.OnPublishReceivedException
-
- OnPublishReceivedException(String, boolean) - Constructor for exception com.hivemq.spi.callback.exception.OnPublishReceivedException
-
- OnPublishReceivedException(String, Throwable, boolean) - Constructor for exception com.hivemq.spi.callback.exception.OnPublishReceivedException
-
- OnPublishReceivedException(Throwable, boolean) - Constructor for exception com.hivemq.spi.callback.exception.OnPublishReceivedException
-
- OnPublishSend - Interface in com.hivemq.spi.callback.events
-
Gets called when an outgoing PUBLISH message event occurs.
- onPublishSend(PUBLISH, ClientData) - Method in interface com.hivemq.spi.callback.events.OnPublishSend
-
Gets called when a PUBLISH is sent by HiveMQ to a subscribing client.
- OnPubrecReceived - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubrecReceived Callback gets called after HiveMQ receives a PUBREC
message from a client.
- onPubrecReceived(PUBREC, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubrecReceived
-
This method gets called when a PUBREC message is received from a client.
- OnPubrecSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubrecSend callback gets executed after a PUBREC message was sent by HiveMQ
to a client.
- onPubrecSend(PUBREC, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubrecSend
-
This method gets called when HiveMQ sends a PUBREC message to a client.
- OnPubrelReceived - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubrelReceived Callback gets called after HiveMQ receives a PUBREL
message from a client.
- onPubrelReceived(PUBREL, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubrelReceived
-
This method gets called when a PUBREL message is received from a client.
- OnPubrelSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnPubrelSend callback gets executed after a PUBREL message was sent by HiveMQ
to a client.
- onPubrelSend(PUBREL, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnPubrelSend
-
This method gets called when HiveMQ sends a PUBREL message to a client.
- onSessionReady(ClientData) - Method in interface com.hivemq.spi.callback.events.OnSessionReadyCallback
-
This method gets called once the MQTT Session for the client is ready to be used.
- OnSessionReadyCallback - Interface in com.hivemq.spi.callback.events
-
This callback gets called once the MQTT Session is ready for a client.
- OnSubackSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnSubackSend callback gets called after HiveMQ sends a SUBACK message to a client.
- onSubackSend(SUBACK, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnSubackSend
-
This method is called after HiveMQ sends a SUBACK message to a client.
- onSubscribe(SUBSCRIBE, ClientData) - Method in interface com.hivemq.spi.callback.events.OnSubscribeCallback
-
- OnSubscribeCallback - Interface in com.hivemq.spi.callback.events
-
- onSubscribeDisconnect(ClientData, String, QoS) - Method in interface com.hivemq.spi.callback.security.OnInsufficientPermissionDisconnect
-
Gets executed after a client was disconnected due to insufficient permissions when subscribing
- OnTopicSubscriptionCallback - Interface in com.hivemq.spi.callback.events
-
- OnUnsubackSend - Interface in com.hivemq.spi.callback.lowlevel
-
The OnUnsubackSend callback gets called after HiveMQ sends a UNSUBACK message to a client.
- onUnsubackSend(UNSUBACK, ClientData) - Method in interface com.hivemq.spi.callback.lowlevel.OnUnsubackSend
-
This method is called after HiveMQ sends a UNSUBACK message to a client.
- onUnsubscribe(UNSUBSCRIBE, ClientData) - Method in interface com.hivemq.spi.callback.events.OnUnsubscribeCallback
-
Gets called when an UNSUBSCRIBE MQTT message arrives
- OnUnsubscribeCallback - Interface in com.hivemq.spi.callback.events
-
A callback which gets called when an UNSUBSCRIBE MQTT message arrives.
- OptionalAttribute - Class in com.hivemq.spi.services
-
- OptionalAttribute(byte[], boolean) - Constructor for class com.hivemq.spi.services.OptionalAttribute
-
- organization() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- organizationalUnit() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- OUTGOING_CONNACK_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT CONNACK messages
- OUTGOING_CONNACK_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT CONNACK messages
- OUTGOING_MESSAGE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT message
- OUTGOING_MESSAGE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of outgoing MQTT messages
- OUTGOING_MESSAGE_SIZE_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which measures the distribution of incoming MQTT message size (payload without fixed header)
- OUTGOING_PINGRESP_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PINGRESP messages
- OUTGOING_PINGRESP_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter,which measures the current rate of outgoing MQTT PINGRESP messages
- OUTGOING_PUBACK_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBACK messages
- OUTGOING_PUBACK_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT PUBACK messages
- OUTGOING_PUBCOMP_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBCOMP messages
- OUTGOING_PUBCOMP_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT PUBCOMP messages
- OUTGOING_PUBLISH_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBLISH messages
- OUTGOING_PUBLISH_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT PUBLISH messages
- OUTGOING_PUBLISH_RETAINED_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBLISH messages with the retained flag set
- OUTGOING_PUBLISH_SIZE_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which measures the distribution of incoming MQTT message size (payload without fixed header)
- OUTGOING_PUBREC_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBREC messages
- OUTGOING_PUBREC_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT PUBREC messages
- OUTGOING_PUBREL_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT PUBREL messages
- OUTGOING_PUBREL_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT PUBREL messages
- OUTGOING_SUBACK_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT SUBACK messages
- OUTGOING_SUBACK_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT SUBACK messages
- OUTGOING_UNSUBACK_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts every outgoing MQTT UNSUBACK messages
- OUTGOING_UNSUBACK_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the current rate of outgoing MQTT UNSUBACK messages
- outgoingLimit() - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
- outgoingLimitChanged(ValueChangedCallback<Long>) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Adds a callback which gets called when the outgoing bandwidth limit changes at runtime
- OVERLOAD_PROTECTION_CLIENTS_AVERAGE_CREDITS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the average amount of available credits between all clients.
- OVERLOAD_PROTECTION_CLIENTS_BACKPRESSURE_ACTIVE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of clients for which backpressure is applied by overload protection.
- OVERLOAD_PROTECTION_CLIENTS_USING_CREDITS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of clients having less than the full amount of credits.
- OVERLOAD_PROTECTION_CREDITS_PER_TICK - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of credits a client receives per tick.
- path(String) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets the websocket path of the TLS websocket listener
- path - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- path(String) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Sets the websocket path of the websocket listener
- PathUtils - Class in com.hivemq.spi.util
-
- PathUtils() - Constructor for class com.hivemq.spi.util.PathUtils
-
Deprecated.
- payload() - Method in interface com.hivemq.spi.topic.sys.SYSTopicEntry
-
Returns a Supplier for the payload of this $SYS topic.
- PAYLOAD_PERSISTENCE_ENTRIES - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of payloads stored in the payload persistence.
- PAYLOAD_PERSISTENCE_REMOVABLE_ENTRIES - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of payloads stored in the payload persistence, that can be removed by the cleanup.
- PermissionTopicMatcher - Class in com.hivemq.spi.topic
-
An implementation of a topic matcher which tokenizes topics to match wildcards.
- PERSISTENT_SESSIONS_ACTIVE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which measures the current count of active persistent sessions
- PINGREQ - Class in com.hivemq.spi.message
-
The MQTT PINGREQ message
- PINGREQ() - Constructor for class com.hivemq.spi.message.PINGREQ
-
- PINGRESP - Class in com.hivemq.spi.message
-
The MQTT PINGRESP message
- PINGRESP() - Constructor for class com.hivemq.spi.message.PINGRESP
-
- PLUGIN_EXECUTOR_PREFIX - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_EXECUTOR_SERVICE_COMPLETED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_EXECUTOR_SERVICE_DURATION - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the duration of time spent on submitted jobs to the
PluginExecutorService
- PLUGIN_EXECUTOR_SERVICE_RUNNING - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_EXECUTOR_SERVICE_SCHEDULED_ONCE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Meter, which measures the current rate of scheduled jobs in the
PluginExecutorService that run once
- PLUGIN_EXECUTOR_SERVICE_SCHEDULED_OVERRUN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Meter, which measures the current count of jobs to the
PluginExecutorService that are overrun which means that the job lasted so long that it interfered with the next scheduled job
- PLUGIN_EXECUTOR_SERVICE_SCHEDULED_PERCENT_OF_PERIOD - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Meter, which Measures how much percent of the scheduled period the
PluginExecutorService jobs lasted
- PLUGIN_EXECUTOR_SERVICE_SCHEDULED_REPETITIVELY - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Meter, which measures the current rate of scheduled jobs in the
PluginExecutorService that run repetitively
- PLUGIN_EXECUTOR_SERVICE_SUMBITTED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_RATE_LIMIT_EXCEEDED_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Counter, which count the amount of times that the plugin service rate limit was exceeded
PluginExecutorService
- PLUGIN_TIMER_AFTER_LOGIN_FAILED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
AfterLoginCallback
- PLUGIN_TIMER_AFTER_LOGIN_SUCCESS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
AfterLoginCallback
- PLUGIN_TIMER_AUTHENTICATION - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_AUTHORIZATION - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_CONNACK_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnConnackSend callback
- PLUGIN_TIMER_CONNECT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnConnectCallback
- PLUGIN_TIMER_DISCONNECT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnDisconnectCallback
- PLUGIN_TIMER_PERMISSIONS_DISCONNECT_PUBLISH - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_PERMISSIONS_DISCONNECT_SUBSCRIBE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_PING - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPingCallback
- PLUGIN_TIMER_PUBACK_RECEIVED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubackReceived callback
- PLUGIN_TIMER_PUBACK_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubackSend callback
- PLUGIN_TIMER_PUBCOMP_RECEIVED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubcompReceived callback
- PLUGIN_TIMER_PUBCOMP_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubcompSend callback
- PLUGIN_TIMER_PUBLISH_RECEIVED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_PUBLISH_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPublishSend
- PLUGIN_TIMER_PUBREC_RECEIVED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubrecReceived callback
- PLUGIN_TIMER_PUBREC_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubrecSend callback
- PLUGIN_TIMER_PUBREL_RECEIVED - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubrelReceived callback
- PLUGIN_TIMER_PUBREL_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnPubrelSend callback
- PLUGIN_TIMER_RESTRICTIONS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_SESSION_READY - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_SUBACK_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnSubackSend callback
- PLUGIN_TIMER_SUBSCRIBE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnSubscribeCallback
- PLUGIN_TIMER_TOPIC_SUBSCRIPTION - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_UNSUBACK_SEND - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Timer, which measures the mean execution time (in nanoseconds)
of the
OnUnsubackSend callback
- PLUGIN_TIMER_UNSUBSCRIBE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PLUGIN_TIMER_WEBUI_AUTHENTICATION - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
- PluginEntryPoint - Class in com.hivemq.spi
-
The abstract class where all HiveMQ plugin Entry Points should extend from.
- PluginEntryPoint() - Constructor for class com.hivemq.spi.PluginEntryPoint
-
- PluginExecutorService - Interface in com.hivemq.spi.services
-
A shared thread pool executor which is a ListeningScheduledExecutorService.
- pluginServiceRateLimit() - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
- pluginServiceRateLimitChanged(ValueChangedCallback<Integer>) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Adds a callback which gets called when the plugin service call rate limit changes at runtime
- port(int) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets the port of the TLS websocket listener
- port - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- port(int) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Sets the port of the websocket listener
- POSSIBLY_STALE_SUBSCRIPTIONS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which counts the current amount of clients subscriptions that may be removable by the topic tree cleanup.
- priority() - Method in interface com.hivemq.spi.callback.SynchronousCallback
-
- ProtocolVersion - Enum in com.hivemq.spi.message
-
- proxyAddress() - Method in interface com.hivemq.spi.security.ProxyInformation
-
Returns the address of the load balancer that is used to proxy the client connection.
- ProxyInformation - Interface in com.hivemq.spi.security
-
This class encapsulates all information that is forwarded by a load
balancer which uses the PROXY protocol.
- proxyPort() - Method in interface com.hivemq.spi.security.ProxyInformation
-
Returns the port of the load balancer that is used to proxy the client connection.
- proxyProtocolSupported(boolean) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Set this to true if you want this listener to support the PROXY protocol
- proxyProtocolSupported - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- proxyProtocolSupported(boolean) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Set this to true if you want this listener to support the PROXY protocol
- PUBACK - Class in com.hivemq.spi.message
-
The MQTT PUBACK message
- PUBACK(int) - Constructor for class com.hivemq.spi.message.PUBACK
-
- PUBCOMP - Class in com.hivemq.spi.message
-
The MQTT PUBCOMP message
- PUBCOMP(int) - Constructor for class com.hivemq.spi.message.PUBCOMP
-
- PUBLISH - Class in com.hivemq.spi.message
-
A MQTT PUBLISH message
Note that a PUBLISH message is considered equal if the topic Strings are equal
- PUBLISH() - Constructor for class com.hivemq.spi.message.PUBLISH
-
- PUBLISH(byte[], String, QoS) - Constructor for class com.hivemq.spi.message.PUBLISH
-
- PUBLISH(byte[], String, QoS, int) - Constructor for class com.hivemq.spi.message.PUBLISH
-
- publish(PUBLISH) - Method in interface com.hivemq.spi.services.PublishService
-
Publishes a new MQTT
PUBLISH message.
- PUBLISH_QUEUE_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the rate of messages put into the publish queue
- PUBLISH_QUEUE_SIZE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Counter, which measures the current count of messages in the publish queue
PluginExecutorService
- PUBLISH_RESENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the rate of PUBLISH messages that are resent, because the broker did not receive a PUBACK message in time.
- PublishService - Interface in com.hivemq.spi.services
-
This service allows plugins to publish new MQTT messages programmatically
- publishtoClient(PUBLISH, String) - Method in interface com.hivemq.spi.services.PublishService
-
Publishes a new MQTT
PUBLISH message.
- PUBREC - Class in com.hivemq.spi.message
-
The MQTT PUBREC message
- PUBREC(int) - Constructor for class com.hivemq.spi.message.PUBREC
-
- PUBREL - Class in com.hivemq.spi.message
-
The MQTT PUBREL message
- PUBREL(int) - Constructor for class com.hivemq.spi.message.PUBREL
-
- PUBREL_RESENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the rate of PUBREL messages that are resent, because the broker did not receive a PUBCOMP message in time.
- put(String, String, byte[]) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- put(String, String, byte[]) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- put(String, byte[]) - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Sets the given connection attribute for the connected client.
- putAsString(String, String, String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- putAsString(String, String, String, Charset) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- putAsString(String, String, String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- putAsString(String, String, String, Charset) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Sets the given session attribute for a persistent client.
- putAsString(String, String) - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Sets the given connection attribute as UTF-8 String representation for the connected client.
- putAsString(String, String, Charset) - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Sets the given connection attribute as String representation for the connected client with a given charset.
- putIfNewer(String, String, byte[], long) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than the timestamp of the already stored attribute.
- putIfNewer(String, String, byte[], long) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than the timestamp of the already stored attribute.
- putIfNewerOrEquals(String, String, byte[], long) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than or equal to the timestamp of the already stored attribute.
- putIfNewerOrEquals(String, String, byte[], long) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Sets the given session attribute for a persistent client if the timestamp of the attribute is newer than or equal to the timestamp of the already stored attribute.
- RateLimitExceededException - Exception in com.hivemq.spi.services.exception
-
This exception is used to signal that the configured plugin service rate limit has been exceeded
- RateLimitExceededException() - Constructor for exception com.hivemq.spi.services.exception.RateLimitExceededException
-
- rawTLVs() - Method in interface com.hivemq.spi.security.ProxyInformation
-
HiveMQ supports arbitrary TLVs, even TLVs that aren't specified by the PROXY protocol.
- readableName() - Method in interface com.hivemq.spi.services.configuration.entity.Listener
-
- readableName() - Method in class com.hivemq.spi.services.configuration.entity.TcpListener
- readableName() - Method in class com.hivemq.spi.services.configuration.entity.TlsTcpListener
- readableName() - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener
- readableName() - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener
- ReadOnly - Annotation Type in com.hivemq.spi.annotations
-
This is an informal annotation which indicates that the method returns
a read-only type.
- receiveBufferSize(int) - Method in class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties.Builder
-
Set the receive buffer size.
- RefusedConnectionException - Exception in com.hivemq.spi.callback.exception
-
An exception which can be used to refuse a
CONNECT
MQTT message and send (+ disconnect) the client with a
CONNACK
including a specific
ReturnCode
- RefusedConnectionException(ReturnCode) - Constructor for exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- RefusedConnectionException(String, ReturnCode) - Constructor for exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- RefusedConnectionException(String, ReturnCode, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- RefusedConnectionException(ReturnCode, Throwable) - Constructor for exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- reloadScheduledCallbackExpression(ScheduledCallback) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
- REMOTE_PUBLISH - Class in com.hivemq.spi.message
-
- REMOTE_PUBLISH(PUBLISH) - Constructor for class com.hivemq.spi.message.REMOTE_PUBLISH
-
Deprecated.
- remove(String) - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
Removes the retained message from given topic.
- remove(String, String) - Method in interface com.hivemq.spi.services.AsyncSessionAttributeStore
-
Removes the session attribute with the given key for a persistent client.
- remove(String) - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
Removes the retained message from given topic.
- remove(String, String) - Method in interface com.hivemq.spi.services.BlockingSessionAttributeStore
-
Removes the session attribute with the given key for a persistent client.
- remove(String) - Method in interface com.hivemq.spi.services.ConnectionAttributeStore
-
Removes the connection attribute with the given key for the connected client.
- remove(String) - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- remove(RetainedMessage) - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- removeAllCallbacks(Class<? extends Callback>) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Remove all callbacks for a specific callback class
- removeBridge(Bridge) - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- removeCallback(Callback) - Method in interface com.hivemq.spi.callback.registry.CallbackRegistry
-
Removes a callback from the Callback Registry
- removeClientFromGroup(String, String) - Method in interface com.hivemq.spi.services.AsyncClientGroupService
-
Removes a client from a group.
- removeClientFromGroup(String, String) - Method in interface com.hivemq.spi.services.BlockingClientGroupService
-
Removes a client from a group.
- removeEntry(SYSTopicEntry) - Method in interface com.hivemq.spi.services.SYSTopicService
-
- removeSharedSubscription(String) - Method in interface com.hivemq.spi.services.SharedSubscriptionService
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- removeSubscription(String, String) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method removes a subscription for a certain client and a certain topic.
- removeSubscription(String, String) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method removes a subscription for a certain client and a certain topic.
- removeSubscription(String, String) - Method in interface com.hivemq.spi.services.SubscriptionStore
-
- removeSubscriptions(String, Set<String>) - Method in interface com.hivemq.spi.services.AsyncSubscriptionStore
-
This method removes subscriptions for a certain client and certain topics.
- removeSubscriptions(String, Set<String>) - Method in interface com.hivemq.spi.services.BlockingSubscriptionStore
-
This method removes subscriptions for a certain client and certain topics.
- Restriction - Class in com.hivemq.spi.security
-
A restriction is essentially a permission with a numerical value.
- Restriction(RestrictionType, Long) - Constructor for class com.hivemq.spi.security.Restriction
-
- RestrictionsAfterLoginCallback - Interface in com.hivemq.spi.callback.security
-
This callback gets executed after a CONNECT message arrived and
the client was authenticated successfully.
- RestrictionType - Enum in com.hivemq.spi.security
-
The different types of restrictions which are available.
- RESTService - Interface in com.hivemq.spi.services.rest
-
This HiveMQ REST service allows to expose Java Servlets (3.0), Filters and JAX-RS (2.0) resources.
- RETAINED_MESSAGES_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of retained messages
- RETAINED_MESSAGES_MEAN - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which holds metrics about the mean payload-size of retained messages in bytes
- RETAINED_MESSAGES_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Histogram, which holds the current rate of retained messages
- RetainedMessage - Class in com.hivemq.spi.message
-
A retained message
- RetainedMessage(String, byte[], QoS) - Constructor for class com.hivemq.spi.message.RetainedMessage
-
- RetainedMessageStore - Interface in com.hivemq.spi.services
-
- retainedMessageTimeToLive() - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- retryInterval() - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- ReturnCode - Enum in com.hivemq.spi.message
-
The return code of a
CONNACK message.
- ScheduledCallback - Interface in com.hivemq.spi.callback.schedule
-
- ScheduleExpressions - Class in com.hivemq.spi.callback.schedule
-
This utility class has several methods and constants for working with quartz-style cron expressions.
- ScheduleExpressions() - Constructor for class com.hivemq.spi.callback.schedule.ScheduleExpressions
-
- sendBufferSize(int) - Method in class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties.Builder
-
Set the send buffer size.
- serial() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- ServletFilter<T extends javax.servlet.Filter> - Class in com.hivemq.spi.services.rest.servlet
-
A wrapper for encapsulating a Servlet filter with their
corresponding DispatcherTypes.
- ServletFilter(T, DispatcherType...) - Constructor for class com.hivemq.spi.services.rest.servlet.ServletFilter
-
Creates a new wrapper for a concrete Servlet Filter object and its corresponding
dispatcher types.
- ServletFilter(Class<T>, DispatcherType...) - Constructor for class com.hivemq.spi.services.rest.servlet.ServletFilter
-
Creates a new wrapper for a Servlet Filter class and its corresponding
dispatcher types.
- SESSIONS_PERSISTENT_QUEUE_MESSAGE_COUNT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current number of queued messages in persistent sessions
- setAddresses(List<Address>) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setBridge(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setCleanSession(boolean) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setCleanSession(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setClientCertAuthentication(boolean) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setClientId(String) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setClientIdentifier(String) - Method in class com.hivemq.spi.message.CONNECT
-
- setClientWriteBufferProperties(ClientWriteBufferProperties) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
- setClientWriteBufferProperties(ClientWriteBufferProperties) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- setConnectionName(String) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setConnectOverloadProtectionProperties(ConnectOverloadProtectionProperties) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
- setConnectOverloadProtectionProperties(ConnectOverloadProtectionProperties) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- setDuplicateDelivery(boolean) - Method in class com.hivemq.spi.message.PUBLISH
-
- setHost(String) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setIdleTimeout(int) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setIncomingLimit(long) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Changes the incoming bandwidth limit at runtime
- setKeepAlive(int) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setKeepAliveTimer(int) - Method in class com.hivemq.spi.message.CONNECT
-
- setKeystore(File) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setKeystorePassword(String) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setLocalPrefix(String) - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- setLogLevel(LogService.LogLevel) - Method in interface com.hivemq.spi.services.LogService
-
Changes the log level of the internal HiveMQ logger
This does not support
null parameters.
- setMaxClientIdLength(int) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setMaxConnections(long) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Changes the maximum concurrent connections at runtime.
- setMaxMessageSize(int) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Changes the maximum allowed MQTT message size at runtime
- setMaxQueuedMessages(long) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setMessage(byte[]) - Method in class com.hivemq.spi.message.RetainedMessage
-
- setMessageId(int) - Method in class com.hivemq.spi.message.MessageWithID
-
- setMessageId(int) - Method in class com.hivemq.spi.message.SUBSCRIBE
-
- setMessageTimeToLive(int) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setNoConnectIdleTimeoutMillis(long) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setNotification(Notification) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setNotificationsEnabled(boolean) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setOfflineClientSessionTimeToLive(int) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setOutgoingLimit(long) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Changes the outgoing bandwidth limit at runtime
- setPassword(String) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setPassword(byte[]) - Method in class com.hivemq.spi.message.CONNECT
-
- setPassword(String) - Method in class com.hivemq.spi.message.CONNECT
-
- setPasswordRequired(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setPattern(String) - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- setPayload(byte[]) - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
By using this setter the payload of this
PUBLISH can be modified before it is sent to a client
Changes made to the payload here are only visible to the specific client to which this
ModifiablePUBLISH is sent.
- setPayload(byte[]) - Method in class com.hivemq.spi.message.PUBLISH
-
- setPluginServiceRateLimit(int) - Method in interface com.hivemq.spi.services.configuration.ThrottlingConfigurationService
-
Changes the plugin service call rate limit per second at runtime
- setPort(int) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setProtocolVersion(ProtocolVersion) - Method in class com.hivemq.spi.message.CONNECT
-
- setQoS(QoS) - Method in class com.hivemq.spi.bridge.Notification
-
Deprecated.
- setQoS(QoS) - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- setQoS(QoS) - Method in class com.hivemq.spi.message.PUBLISH
-
- setQoS(QoS) - Method in class com.hivemq.spi.message.RetainedMessage
-
- setRemotePrefix(String) - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- setRestartTimeout(int) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setRetain(boolean) - Method in class com.hivemq.spi.message.PUBLISH
-
- setRetainedMessageTimeToLive(int) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setRetryInterval(int) - Method in interface com.hivemq.spi.services.configuration.MqttConfigurationService
-
- setRoundRobin(boolean) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setSocketOptionsProperties(SocketOptionsProperties) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
- setSocketOptionsProperties(SocketOptionsProperties) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- setStartType(StartType) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setSubprotocols(List<String>) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets a list of subprotocols the websocket listener should support.
- setSubprotocols(List<String>) - Method in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
Sets a list of subprotocols the websocket listener should support.
- setThreshold(int) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setTlsEnabled(boolean) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setTlsVersion(TLSVersion) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setTopic(String) - Method in class com.hivemq.spi.bridge.Notification
-
Deprecated.
- setTopic(String) - Method in interface com.hivemq.spi.message.ModifiablePUBLISH
-
By using this setter the topic of this
PUBLISH can be modified before it is sent to a client.
- setTopic(String) - Method in class com.hivemq.spi.message.PUBLISH
-
- setTopic(String) - Method in class com.hivemq.spi.message.RetainedMessage
-
- setTopicPatterns(List<TopicPattern>) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setTopics(List<Topic>) - Method in class com.hivemq.spi.message.SUBSCRIBE
-
- setTopics(List<String>) - Method in class com.hivemq.spi.message.UNSUBSCRIBE
-
- setTrustStore(File) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setTrustStorePassword(String) - Method in class com.hivemq.spi.bridge.Address
-
Deprecated.
- setTryPrivate(boolean) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setTTL(int) - Method in class com.hivemq.spi.message.PUBLISH
-
- setTTL(String, int) - Method in interface com.hivemq.spi.services.AsyncClientService
-
Sets the time to live for a client session in seconds.
- setTTL(String, int) - Method in interface com.hivemq.spi.services.BlockingClientService
-
Sets the time to live for the client session.
- setType(TopicPattern.Type) - Method in class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- setUpdateCheckEnabled(boolean) - Method in interface com.hivemq.spi.services.configuration.GeneralConfigurationService
-
- setUsername(String) - Method in class com.hivemq.spi.bridge.Bridge
-
Deprecated.
- setUsername(String) - Method in class com.hivemq.spi.message.CONNECT
-
- setUsernameRequired(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setWill(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setWillMessage(byte[]) - Method in class com.hivemq.spi.message.CONNECT
-
- setWillQos(QoS) - Method in class com.hivemq.spi.message.CONNECT
-
- setWillRetain(boolean) - Method in class com.hivemq.spi.message.CONNECT
-
- setWillTopic(String) - Method in class com.hivemq.spi.message.CONNECT
-
- sharedSubscriptionsAvailable() - Method in interface com.hivemq.spi.services.SharedSubscriptionService
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- SharedSubscriptionService - Interface in com.hivemq.spi.services
-
Deprecated.
Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions.
See the HiveMQ documentation about shared subscriptions for more detailed information.
- shutdown() - Method in interface com.hivemq.spi.services.PluginExecutorService
-
DO NOT CALL THIS METHOD!
- shutdownNow() - Method in interface com.hivemq.spi.services.PluginExecutorService
-
DO NOT CALL THIS METHOD!
- SINGLE_WRITER_ATTRIBUTE_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the attribute persistence.
- SINGLE_WRITER_ATTRIBUTE_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of attribute disk I/O tasks
- SINGLE_WRITER_CLIENT_GROUP_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of tasks that are enqueued by the client group persistence.
- SINGLE_WRITER_CLIENT_GROUP_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of client group tasks
- SINGLE_WRITER_CLIENT_SESSION_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the client session persistence.
- SINGLE_WRITER_CLIENT_SESSION_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of client session disk I/O tasks
- SINGLE_WRITER_NONEMPTY_QUEUES - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of single writer task queues that are not empty.
- SINGLE_WRITER_OUTGOING_MESSAGE_FLOW_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the outgoing message flow persistence.
- SINGLE_WRITER_OUTGOING_MESSAGE_FLOW_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of outgoing message flow disk I/O tasks
- SINGLE_WRITER_PREFIX - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
Deprecated.
- SINGLE_WRITER_QUEUE_MISSES - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a
Counter, which measures the current count of loops that all single writer threads have done without executing a task
PluginExecutorService
- SINGLE_WRITER_QUEUED_MESSAGES_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the queued messages persistence.
- SINGLE_WRITER_QUEUED_MESSAGES_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of queued messages disk I/O tasks
- SINGLE_WRITER_REQUEST_EVENT_BUS_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of tasks that are enqueued by the request event bus.
- SINGLE_WRITER_REQUEST_EVENT_BUS_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of request event bus tasks
- SINGLE_WRITER_RETAINED_MESSAGE_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the retained message persistence.
- SINGLE_WRITER_RETAINED_MESSAGE_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of retained message disk I/O tasks
- SINGLE_WRITER_RUNNING_THREADS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of threads that are executing disk I/O tasks.
- SINGLE_WRITER_SUBSCRIPTION_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by the subscription persistence.
- SINGLE_WRITER_SUBSCRIPTION_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the mean execution time (in nanoseconds)
of subscription disk I/O tasks
- SINGLE_WRITER_TOTAL_TASKS - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current amount of disk I/O tasks that are enqueued by all persistences.
- size() - Method in interface com.hivemq.spi.services.AsyncRetainedMessageStore
-
- size() - Method in interface com.hivemq.spi.services.BlockingRetainedMessageStore
-
- size() - Method in interface com.hivemq.spi.services.RetainedMessageStore
-
- SocketOptionsProperties - Class in com.hivemq.spi.services.configuration.entity
-
Properties for socket send and receive buffer sizes.
- socketOptionsProperties - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- SocketOptionsProperties.Builder - Class in com.hivemq.spi.services.configuration.entity
-
A builder for the SocketOptionsProperties object.
- SocketOptionsProperties.Builder() - Constructor for class com.hivemq.spi.services.configuration.entity.SocketOptionsProperties.Builder
-
Create a builder.
- sourceAddress() - Method in interface com.hivemq.spi.security.ProxyInformation
-
Returns the original source address of the MQTT client.
- sourcePort() - Method in interface com.hivemq.spi.security.ProxyInformation
-
Return the original source port of the MQTT client.
- sslCertificateCN() - Method in interface com.hivemq.spi.security.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).
- SslClientCertificate - Interface in com.hivemq.spi.security
-
Represents information of a X509 client certificate.
- SslException - Exception in com.hivemq.spi.util
-
- SslException() - Constructor for exception com.hivemq.spi.util.SslException
-
- SslException(String) - Constructor for exception com.hivemq.spi.util.SslException
-
- SslException(String, Throwable) - Constructor for exception com.hivemq.spi.util.SslException
-
- SslException(Throwable) - Constructor for exception com.hivemq.spi.util.SslException
-
- startBridge(Bridge) - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- StartType - Enum in com.hivemq.spi.bridge
-
Deprecated.
- State - Enum in com.hivemq.spi.bridge
-
Deprecated.
- state() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- stopAllBridges() - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- stopBridge(Bridge) - Method in interface com.hivemq.spi.services.BridgeManagerService
-
Deprecated.
IMPORTANT: HiveMQ 3.0 does not support Bridging, so this service only works for HiveMQ 2.x
- SUBACK - Class in com.hivemq.spi.message
-
The MQTT SUBACK message
- SUBACK(int, Byte...) - Constructor for class com.hivemq.spi.message.SUBACK
-
- SUBACK(int, List<Byte>) - Constructor for class com.hivemq.spi.message.SUBACK
-
- SubackReturnCode - Enum in com.hivemq.spi.message
-
The return code of a
SUBACK message.
- subprotocols - Variable in class com.hivemq.spi.services.configuration.entity.WebsocketListener.Builder
-
- SUBSCRIBE - Class in com.hivemq.spi.message
-
The MQTT SUBSCRIBE message
- SUBSCRIBE() - Constructor for class com.hivemq.spi.message.SUBSCRIBE
-
Creates a new MQTT SUBSCRIBE message
- SUBSCRIPTIONS_CURRENT - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Counter, which measures the current count of subscriptions
- SubscriptionStore - Interface in com.hivemq.spi.services
-
- SUPERVISION_OVERLOAD_PROTECTION_LEVEL - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Gauge, which holds the current level of supervision overload protection
- SynchronousCallback - Interface in com.hivemq.spi.callback
-
A callback which execution is synchronized.
- SystemInformation - Interface in com.hivemq.spi.config
-
Useful information about HiveMQ and the underlying system
- SYSTopicEntry - Interface in com.hivemq.spi.topic.sys
-
An implementation of this interface representa a concrete $SYS topic entry
which can be added to the
SYSTopicService.
- SYSTopicService - Interface in com.hivemq.spi.services
-
This Service allows plugin developers to
* Add custom $SYS topics at runtime
* Remove existing $SYS topics at runtime
* Query for existing $SYS topics at runtime
- TcpListener - Class in com.hivemq.spi.services.configuration.entity
-
A listener which allows to listen to MQTT traffic via TCP
- TcpListener(int, String) - Constructor for class com.hivemq.spi.services.configuration.entity.TcpListener
-
Creates a new TCP listener which listens to a specific port and bind address
- TcpListener(int, String, boolean) - Constructor for class com.hivemq.spi.services.configuration.entity.TcpListener
-
Creates a new TCP listener which listens to a specific port, bind address and proxy setting
- TcpListener(int, String, boolean, SocketOptionsProperties, ConnectOverloadProtectionProperties, ClientWriteBufferProperties) - Constructor for class com.hivemq.spi.services.configuration.entity.TcpListener
-
Creates a new TCP listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties
- ThreadSafe - Annotation Type in com.hivemq.spi.annotations
-
An annotation which is used for indicating that a class or method is thread safe.
- throttlingConfiguration() - Method in interface com.hivemq.spi.services.ConfigurationService
-
Returns the throttling configuration service for global throttling
- ThrottlingConfigurationService - Interface in com.hivemq.spi.services.configuration
-
A Configuration service which allows to get information about the current throttling configuration
and allows to change the global throttling configuration of HiveMQ at runtime.
- Timed - Annotation Type in com.hivemq.spi.metrics.annotations
-
Methods annotated with this annotation are added to the HiveMQ MetricRegistry
automatically as Timers.
- timestamp - Variable in class com.hivemq.spi.message.PUBLISH
-
- title() - Method in interface com.hivemq.spi.security.SslClientCertificate
-
- Tls - Class in com.hivemq.spi.services.configuration.entity
-
The TLS configuration
- Tls(String, String, String, String, String, String, String, int, Tls.ClientAuthMode, List<String>, List<String>, Long, boolean, boolean, String, int) - Constructor for class com.hivemq.spi.services.configuration.entity.Tls
-
Creates a new TLS configuration
- Tls(String, String, String, String, String, String, String, int, Tls.ClientAuthMode, List<String>, List<String>) - Constructor for class com.hivemq.spi.services.configuration.entity.Tls
-
Creates a new TLS configuration
- tls(Tls) - Method in class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
Sets the TLS configuration of the TLS Websocket listener
- Tls.ClientAuthMode - Enum in com.hivemq.spi.services.configuration.entity
-
The X509 client certificate authentication mode.
- TlsTcpListener - Class in com.hivemq.spi.services.configuration.entity
-
A listener which allows to listen to MQTT traffic via TLS
- TlsTcpListener(Integer, String, Tls) - Constructor for class com.hivemq.spi.services.configuration.entity.TlsTcpListener
-
Creates a new TLS Listener which listens to a specific port and bind address
- TlsTcpListener(int, String, Tls, boolean) - Constructor for class com.hivemq.spi.services.configuration.entity.TlsTcpListener
-
Creates a new TLS Listener which listens to a specific port, bind address and proxy setting
- TlsTcpListener(int, String, Tls, boolean, SocketOptionsProperties, ConnectOverloadProtectionProperties, ClientWriteBufferProperties) - Constructor for class com.hivemq.spi.services.configuration.entity.TlsTcpListener
-
Creates a new TLS Listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties
- TLSVersion - Enum in com.hivemq.spi.bridge
-
Deprecated.
- tlsVersion() - Method in interface com.hivemq.spi.security.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
- TlsWebsocketListener - Class in com.hivemq.spi.services.configuration.entity
-
A listener which allows to listen to MQTT traffic over secure websockets with TLS.
- TlsWebsocketListener.Builder - Class in com.hivemq.spi.services.configuration.entity
-
A builder which allows to conveniently build a listener object with a fluent API
- TlsWebsocketListener.Builder() - Constructor for class com.hivemq.spi.services.configuration.entity.TlsWebsocketListener.Builder
-
- TOMBSTONE_CLEAN_UP_JOB_TIMER - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Timer, which measures the execution time of the tombstone cleanup jobs
- Topic - Class in com.hivemq.spi.message
-
Represents a MQTT topic with a string for the topic name and a quality of service.
- Topic(String, QoS) - Constructor for class com.hivemq.spi.message.Topic
-
- topic() - Method in interface com.hivemq.spi.topic.sys.SYSTopicEntry
-
Returns the topic of the $SYS Topic Entry.
- topicFromString(String) - Static method in class com.hivemq.spi.message.Topic
-
- TopicMatcher - Interface in com.hivemq.spi.topic
-
A topic matcher which is useful if you want to match topics manually if they match to specific wildcard topics
- TopicPattern - Class in com.hivemq.spi.bridge
-
Deprecated.
- TopicPattern() - Constructor for class com.hivemq.spi.bridge.TopicPattern
-
Deprecated.
- TopicPattern.Type - Enum in com.hivemq.spi.bridge
-
Deprecated.
- toString() - Method in exception com.hivemq.spi.callback.exception.RefusedConnectionException
-
- toString() - Method in class com.hivemq.spi.message.Topic
-
- toString() - Method in class com.hivemq.spi.security.Restriction
-
- toString() - Method in enum com.hivemq.spi.services.configuration.entity.Tls.ClientAuthMode
-
- TOTAL_EXCEPTION_RATE - Static variable in class com.hivemq.spi.metrics.HiveMQMetrics
-
represents a Meter, which measures the rate of unhandled Exceptions
- triggerStandardSysTopicPublish() - Method in interface com.hivemq.spi.services.SYSTopicService
-
Triggers a PUBLISH of all registered SYSTopicEntries with
Type STANDARD to all clients which are subscribed to the SYSTopics
- triggerStandardSysTopicPublishToClient(String) - Method in interface com.hivemq.spi.services.SYSTopicService
-
Triggers a PUBLISH of all registered SYSTopicEntries with
Type STANDARD to a specified client.
- triggerStaticSysTopicPublishToClient(String) - Method in interface com.hivemq.spi.services.SYSTopicService
-
Triggers a PUBLISH of all registered SYSTopicEntries with
Type STATIC to a specified client.
- TtlValidator - Class in com.hivemq.spi.services.configuration.validation.validators
-
- TtlValidator() - Constructor for class com.hivemq.spi.services.configuration.validation.validators.TtlValidator
-
- type() - Method in interface com.hivemq.spi.topic.sys.SYSTopicEntry
-
Returns the Type of this $SYS topic
- Type - Enum in com.hivemq.spi.topic.sys
-
An enumeration of all available types for HiveMQ $SYS Topics
- Validate - Annotation Type in com.hivemq.spi.services.configuration.validation.annotation
-
This annotation indicates that a method must be validated
- validate(T, String) - Method in interface com.hivemq.spi.services.configuration.validation.Validator
-
- validate(Listener, String) - Method in class com.hivemq.spi.services.configuration.validation.validators.ListenerValidator
-
- validate(Integer, String) - Method in class com.hivemq.spi.services.configuration.validation.validators.MaxClientIdValidator
-
- validate(Integer, String) - Method in class com.hivemq.spi.services.configuration.validation.validators.TtlValidator
-
- validate(Number, String) - Method in class com.hivemq.spi.services.configuration.validation.validators.ZeroablePositiveNumber
-
- ValidationError - Class in com.hivemq.spi.services.configuration.validation
-
A concrete validation erro
- ValidationError(String, Object...) - Constructor for class com.hivemq.spi.services.configuration.validation.ValidationError
-
- Validator<T> - Interface in com.hivemq.spi.services.configuration.validation
-
The configuration validator
- valueChanged(T) - Method in interface com.hivemq.spi.services.configuration.ValueChangedCallback
-
This method gets executed when the valuef or a configuration changes
- ValueChangedCallback<T> - Interface in com.hivemq.spi.services.configuration
-
A callback which is executed when a value for a configuration changes
at runtime
- valueOf(String) - Static method in enum com.hivemq.spi.bridge.StartType
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.bridge.State
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.bridge.TLSVersion
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.bridge.TopicPattern.Type
-
Deprecated.
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.callback.security.authorization.AuthorizationBehaviour
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.callback.webui.WebUIAuthenticationCallback.AuthenticationState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.message.MessageType
-
Returns the enum constant of this type with the specified name.
- valueOf(int) - Static method in enum com.hivemq.spi.message.MessageType
-
- valueOf(String) - Static method in enum com.hivemq.spi.message.ProtocolVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.message.QoS
-
Returns the enum constant of this type with the specified name.
- valueOf(int) - Static method in enum com.hivemq.spi.message.QoS
-
Creates a QoS level enum from an integer
- valueOf(String) - Static method in enum com.hivemq.spi.message.ReturnCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.message.SubackReturnCode
-
Returns the enum constant of this type with the specified name.
- valueOf(byte) - Static method in enum com.hivemq.spi.message.SubackReturnCode
-
- valueOf(String, Class<T>) - Static method in class com.hivemq.spi.metrics.HiveMQMetric
-
- valueOf(String) - Static method in enum com.hivemq.spi.security.RestrictionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.services.configuration.entity.Tls.ClientAuthMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.services.LogService.LogLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.ACTIVITY
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.QOS
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.RETAIN
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.TYPE
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.hivemq.spi.topic.sys.Type
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.hivemq.spi.bridge.StartType
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.bridge.State
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.bridge.TLSVersion
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.bridge.TopicPattern.Type
-
Deprecated.
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.callback.security.authorization.AuthorizationBehaviour
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.callback.webui.WebUIAuthenticationCallback.AuthenticationState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.message.MessageType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.message.ProtocolVersion
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.message.QoS
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.message.ReturnCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.message.SubackReturnCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.security.RestrictionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.services.configuration.entity.Tls.ClientAuthMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.services.LogService.LogLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.ACTIVITY
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.QOS
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.RETAIN
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.topic.MqttTopicPermission.TYPE
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.hivemq.spi.topic.sys.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- VERY_HIGH - Static variable in class com.hivemq.spi.callback.CallbackPriority
-
- VERY_LOW - Static variable in class com.hivemq.spi.callback.CallbackPriority
-