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 oneEnhancedAuthenticatorProvider
.An extension can also only set at most one
AuthorizerProvider
. That means for authorizing PUBLISH and SUBSCRIBE packets theAuthorizerProvider
must implementPublishAuthorizer
andSubscriptionAuthorizer
.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 void
setAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)
Sets theAuthenticatorProvider
of this extension.void
setAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)
Sets theAuthorizerProvider
of this extension.void
setEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)
Sets theEnhancedAuthenticatorProvider
of this extension.
-
-
-
Method Detail
-
setAuthenticatorProvider
void setAuthenticatorProvider(@NotNull AuthenticatorProvider authenticatorProvider)
Sets theAuthenticatorProvider
of this extension.At most one
AuthenticatorProvider
OR oneEnhancedAuthenticatorProvider
can be set.A previously set
AuthenticatorProvider
orEnhancedAuthenticatorProvider
is replaced.- Parameters:
authenticatorProvider
- TheAuthenticatorProvider
to set.- Since:
- 4.0.0, CE 2019.1
-
setEnhancedAuthenticatorProvider
void setEnhancedAuthenticatorProvider(@NotNull EnhancedAuthenticatorProvider authenticatorProvider)
Sets theEnhancedAuthenticatorProvider
of this extension.At most one
AuthenticatorProvider
OR oneEnhancedAuthenticatorProvider
can be set.A previously set
AuthenticatorProvider
orEnhancedAuthenticatorProvider
is replaced.- Parameters:
authenticatorProvider
- TheEnhancedAuthenticatorProvider
to set.- Since:
- 4.3.0, CE 2020.1
-
setAuthorizerProvider
void setAuthorizerProvider(@NotNull AuthorizerProvider authorizerProvider)
Sets theAuthorizerProvider
of this extension.At most one
AuthorizerProvider
can be set.A previously set
AuthorizerProvider
is replaced.- Parameters:
authorizerProvider
- TheAuthorizerProvider
to set.- Since:
- 4.0.0, CE 2019.1
-
-