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
AuthenticatorProviderOR oneEnhancedAuthenticatorProvider.An extension can also only set at most one
AuthorizerProvider. That means for authorizing PUBLISH and SUBSCRIBE packets theAuthorizerProvidermust implementPublishAuthorizerandSubscriptionAuthorizer.The providers are automatically removed at extension stop.
- Since:
- 4.0.0, CE 2019.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidsetAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)Sets theAuthenticatorProviderof this extension.voidsetAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)Sets theAuthorizerProviderof this extension.voidsetEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)Sets theEnhancedAuthenticatorProviderof this extension.
-
-
-
Method Detail
-
setAuthenticatorProvider
void setAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)
Sets theAuthenticatorProviderof this extension.At most one
AuthenticatorProviderOR oneEnhancedAuthenticatorProvidercan be set.A previously set
AuthenticatorProviderorEnhancedAuthenticatorProvideris replaced.- Parameters:
authenticatorProvider- TheAuthenticatorProviderto set.- Since:
- 4.0.0, CE 2019.1
-
setEnhancedAuthenticatorProvider
void setEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)
Sets theEnhancedAuthenticatorProviderof this extension.At most one
AuthenticatorProviderOR oneEnhancedAuthenticatorProvidercan be set.A previously set
AuthenticatorProviderorEnhancedAuthenticatorProvideris replaced.- Parameters:
authenticatorProvider- TheEnhancedAuthenticatorProviderto set.- Since:
- 4.3.0, CE 2020.1
-
setAuthorizerProvider
void setAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)
Sets theAuthorizerProviderof this extension.At most one
AuthorizerProvidercan be set.A previously set
AuthorizerProvideris replaced.- Parameters:
authorizerProvider- TheAuthorizerProviderto set.- Since:
- 4.0.0, CE 2019.1
-
-