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

Interface SubscriptionAuthorizer

All Superinterfaces:

Authorizer

public interface SubscriptionAuthorizer
extends Authorizer

Interface for the subscription authorization.

An Authorizer is always called by the same Thread for all messages from the same client.

If the same instance is shared between multiple clients it can be called in different Threads and must therefore be thread-safe.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
void	authorizeSubscribe(@NotNull SubscriptionAuthorizerInput subscriptionAuthorizerInput, @NotNull SubscriptionAuthorizerOutput subscriptionAuthorizerOutput)	Called for each Subscription (Topic) in a SUBSCRIBE packet, that the SubscriptionAuthorizer is delegated to authorize.

Method Details

authorizeSubscribe

void authorizeSubscribe(@NotNull SubscriptionAuthorizerInput subscriptionAuthorizerInput, @NotNull SubscriptionAuthorizerOutput subscriptionAuthorizerOutput)

Called for each Subscription (Topic) in a SUBSCRIBE packet, that the SubscriptionAuthorizer is delegated to authorize.

When the extension is enabled after HiveMQ is already running, this method will also be called for future SUBSCRIBEs of clients that are already connected.

Parameters:

subscriptionAuthorizerInput - The SubscriptionAuthorizerInput.

subscriptionAuthorizerOutput - The SubscriptionAuthorizerOutput.

Since:

4.0.0, CE 2019.1