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

Interface SecurityRegistry

@DoNotImplement
public interface SecurityRegistry

The Security Registry allows extensions to define the authentication and authorization of MQTT clients.

It can be accessed by Services.securityRegistry().

An extension can only set at most one AuthenticatorProvider OR one EnhancedAuthenticatorProvider.

An extension can also only set at most one AuthorizerProvider. That means for authorizing PUBLISH and SUBSCRIBE packets the AuthorizerProvider must implement PublishAuthorizer and SubscriptionAuthorizer.

The providers are automatically removed at extension stop.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
void	setAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)	Sets the AuthenticatorProvider of this extension.
void	setAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)	Sets the AuthorizerProvider of this extension.
void	setEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)	Sets the EnhancedAuthenticatorProvider of this extension.

Method Details

setAuthenticatorProvider

void setAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)

Sets the AuthenticatorProvider of this extension.

At most one AuthenticatorProvider OR one EnhancedAuthenticatorProvider can be set.

A previously set AuthenticatorProvider or EnhancedAuthenticatorProvider is replaced.

Parameters:

authenticatorProvider - The AuthenticatorProvider to set.

Since:

4.0.0, CE 2019.1

setEnhancedAuthenticatorProvider

void setEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)

Sets the EnhancedAuthenticatorProvider of this extension.

At most one AuthenticatorProvider OR one EnhancedAuthenticatorProvider can be set.

A previously set AuthenticatorProvider or EnhancedAuthenticatorProvider is replaced.

Parameters:

authenticatorProvider - The EnhancedAuthenticatorProvider to set.

Since:

4.3.0, CE 2020.1

setAuthorizerProvider

void setAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)

Sets the AuthorizerProvider of this extension.

At most one AuthorizerProvider can be set.

A previously set AuthorizerProvider is replaced.

Parameters:

authorizerProvider - The AuthorizerProvider to set.

Since:

4.0.0, CE 2019.1