Package com.hivemq.extension.sdk.api.services

Class Services

java.lang.Object

com.hivemq.extension.sdk.api.services.Services

public class Services
extends Object

Services provide a convenient way for extensions to interact with the HiveMQ core.

The following services are available:

• InitializerRegistry
• GlobalInterceptorRegistry
• SecurityRegistry
• ManagedExtensionExecutorService
• SubscriptionStore
• PublishService
• ClusterService
• RetainedMessageStore
• MetricRegistry
• EventRegistry
• ClientService
• AdminService

Since:

4.0.0, CE 2019.1

Constructor Summary

Constructors

Constructor	Description
Services()

Method Summary

Modifier and Type	Method	Description
static @NotNull AdminService	adminService()
static @NotNull ClientService	clientService()
static @NotNull ClusterService	clusterService()
static @NotNull EventRegistry	eventRegistry()
static @NotNull ManagedExtensionExecutorService	extensionExecutorService()
static @NotNull InitializerRegistry	initializerRegistry()
static @NotNull GlobalInterceptorRegistry	interceptorRegistry()
static @NotNull MetricRegistry	metricRegistry()
static @NotNull PublishService	publishService()
static @NotNull RetainedMessageStore	retainedMessageStore()
static @NotNull SecurityRegistry	securityRegistry()
static @NotNull SubscriptionStore	subscriptionStore()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Services

public Services()

Method Detail

initializerRegistry

@NotNull
public static @NotNull InitializerRegistry initializerRegistry()

Returns:

A service to set a ClientInitializer.

Since:

4.0.0, CE 2019.1

interceptorRegistry

@NotNull
public static @NotNull GlobalInterceptorRegistry interceptorRegistry()

Returns:

A service to set a GlobalInterceptorRegistry.

Since:

4.2.0, CE 2020.1

securityRegistry

@NotNull
public static @NotNull SecurityRegistry securityRegistry()

Returns:

A service to register AuthenticatorProvider and AuthorizerProvider.

Since:

4.0.0, CE 2019.1

extensionExecutorService

@NotNull
public static @NotNull ManagedExtensionExecutorService extensionExecutorService()

Returns:

A service to execute tasks in a HiveMQ managed thread pool.

Since:

4.0.0, CE 2019.1

subscriptionStore

@NotNull
public static @NotNull SubscriptionStore subscriptionStore()

Returns:

A service to add, get and remove subscriptions.

Since:

4.0.0, CE 2019.1

publishService

@NotNull
public static @NotNull PublishService publishService()

Returns:

A service to publish messages to topics and clients.

Since:

4.0.0, CE 2019.1

clusterService

@NotNull
public static @NotNull ClusterService clusterService()

Returns:

A service to create a custom cluster discovery.

Since:

4.0.0, CE 2019.1

retainedMessageStore

@NotNull
public static @NotNull RetainedMessageStore retainedMessageStore()

Returns:

A service to add, get and remove retained messages.

Since:

4.0.0, CE 2019.1

metricRegistry

@NotNull
public static @NotNull MetricRegistry metricRegistry()

Returns:

A service to get HiveMQ metrics.

Since:

4.0.0, CE 2019.1

eventRegistry

@NotNull
public static @NotNull EventRegistry eventRegistry()

Returns:

A service to register a ClientLifecycleEventListenerProvider.

Since:

4.0.0, CE 2019.1

clientService

@NotNull
public static @NotNull ClientService clientService()

Returns:

A service to get client session information, disconnect clients and remove sessions.

Since:

4.0.0, CE 2019.1

adminService

@NotNull
public static @NotNull AdminService adminService()

Returns:

A service to get general information about the state of this HiveMQ instance.

Since:

4.2.0, CE 2020.1