com.hivemq.extension.sdk.api.auth.SubscriptionAuthorizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-extension-sdk Show documentation

SDK for the development of HiveMQ extensions

There is a newer version: 4.35.0

/*
 * Copyright 2018-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.extension.sdk.api.auth;

import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerInput;
import com.hivemq.extension.sdk.api.auth.parameter.SubscriptionAuthorizerOutput;

/**
 * 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.
 *
 * @author Christoph Schäbel
 * @since 4.0.0, CE 2019.1
 */
public interface SubscriptionAuthorizer extends Authorizer {

    /**
     * Called for each Subscription (Topic) in a SUBSCRIBE packet, that the {@link 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.
     *
     * @param subscriptionAuthorizerInput  The {@link SubscriptionAuthorizerInput}.
     * @param subscriptionAuthorizerOutput The {@link SubscriptionAuthorizerOutput}.
     * @since 4.0.0, CE 2019.1
     */
    void authorizeSubscribe(
            @NotNull SubscriptionAuthorizerInput subscriptionAuthorizerInput,
            @NotNull SubscriptionAuthorizerOutput subscriptionAuthorizerOutput);
}