com.hivemq.extensions.auth.parameter.PublishAuthorizerOutputImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation
HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5
The newest version!
/*
 * Copyright 2019-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.extensions.auth.parameter;

import com.google.common.base.Preconditions;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.auth.parameter.PublishAuthorizerOutput;
import com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode;
import com.hivemq.extension.sdk.api.packets.publish.AckReasonCode;
import com.hivemq.extensions.executor.PluginOutPutAsyncer;
import com.hivemq.extensions.executor.task.AbstractAsyncOutput;
import com.hivemq.extensions.executor.task.PluginTaskOutput;

import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Supplier;

/**
 * @author Christoph Schäbel
 */
public class PublishAuthorizerOutputImpl extends AbstractAsyncOutput
        implements PublishAuthorizerOutput, PluginTaskOutput, Supplier {

    private @Nullable AckReasonCode ackReasonCode;
    private @Nullable String reasonString;
    private @NotNull DisconnectReasonCode disconnectReasonCode = DisconnectReasonCode.NOT_AUTHORIZED;

    private @NotNull AuthorizationState authorizationState = AuthorizationState.UNDECIDED;

    private final @NotNull AtomicBoolean completed = new AtomicBoolean(false);
    private final @NotNull AtomicBoolean authorizerPresent = new AtomicBoolean(false);


    public enum AuthorizationState {
        SUCCESS,
        CONTINUE,
        FAIL,
        DISCONNECT,
        UNDECIDED
    }

    public PublishAuthorizerOutputImpl(@NotNull final PluginOutPutAsyncer asyncer) {
        super(asyncer);
    }

    @Override
    public void authorizeSuccessfully() {
        checkCompleted("authorizeSuccessfully");
        authorizationState = AuthorizationState.SUCCESS;
    }

    @Override
    public void failAuthorization() {
        checkCompleted("failAuthorization");
        this.ackReasonCode = AckReasonCode.NOT_AUTHORIZED;
        authorizationState = AuthorizationState.FAIL;
    }

    public void forceFailedAuthorization() {
        completed.set(true);
        this.ackReasonCode = AckReasonCode.NOT_AUTHORIZED;
        authorizationState = AuthorizationState.FAIL;
    }

    @Override
    public void failAuthorization(final @NotNull AckReasonCode reasonCode) {
        checkCompleted("failAuthorization");
        Preconditions.checkNotNull(reasonCode, "reason code must never be null");
        if (reasonCode == AckReasonCode.SUCCESS || reasonCode == AckReasonCode.NO_MATCHING_SUBSCRIBERS) {
            throw new IllegalArgumentException("Fail must use an Ack Error code");
        }

        this.ackReasonCode = reasonCode;
        authorizationState = AuthorizationState.FAIL;
    }

    @Override
    public void failAuthorization(final @NotNull AckReasonCode reasonCode, final @NotNull String reasonString) {
        checkCompleted("failAuthorization");
        Preconditions.checkNotNull(reasonCode, "reason code must never be null");
        Preconditions.checkNotNull(reasonString, "reason string must never be null");
        if (reasonCode == AckReasonCode.SUCCESS || reasonCode == AckReasonCode.NO_MATCHING_SUBSCRIBERS) {
            throw new IllegalArgumentException("Fail must use an Ack Error code");
        }

        this.ackReasonCode = reasonCode;
        this.reasonString = reasonString;
        authorizationState = AuthorizationState.FAIL;
    }

    @Override
    public void disconnectClient() {
        checkCompleted("disconnectClient");
        this.disconnectReasonCode = DisconnectReasonCode.NOT_AUTHORIZED;
        authorizationState = AuthorizationState.DISCONNECT;
    }

    @Override
    public void disconnectClient(final @NotNull DisconnectReasonCode reasonCode) {
        checkCompleted("disconnectClient");
        Preconditions.checkNotNull(reasonCode, "reason code must never be null");
        this.disconnectReasonCode = reasonCode;
        authorizationState = AuthorizationState.DISCONNECT;
    }

    @Override
    public void disconnectClient(final @NotNull DisconnectReasonCode reasonCode, final @NotNull String reasonString) {
        checkCompleted("disconnectClient");
        Preconditions.checkNotNull(reasonCode, "reason code must never be null");
        Preconditions.checkNotNull(reasonString, "reason string must never be null");
        this.disconnectReasonCode = reasonCode;
        this.reasonString = reasonString;
        authorizationState = AuthorizationState.DISCONNECT;
    }

    @Override
    public void nextExtensionOrDefault() {
        if (completed.get()) {
            throw new UnsupportedOperationException(
                    "nextExtensionOrDefault must not be called if authorizeSuccessfully, " +
                            "failAuthorization, disconnectClient or nextExtensionOrDefault has already been called");
        }
        authorizationState = AuthorizationState.CONTINUE;
    }

    public @Nullable String getReasonString() {
        return reasonString;
    }

    public @NotNull DisconnectReasonCode getDisconnectReasonCode() {
        return disconnectReasonCode;
    }

    public @NotNull AuthorizationState getAuthorizationState() {
        return authorizationState;
    }

    private void checkCompleted(final @NotNull String method) {
        if (!completed.compareAndSet(false, true)) {
            throw new UnsupportedOperationException(method +
                    " must not be called if authorizeSuccessfully, " +
                    "failAuthorization, disconnectClient or nextExtensionOrDefault has already been called");
        }
    }

    public boolean isCompleted() {
        return completed.get();
    }

    @NotNull
    @Override
    public PublishAuthorizerOutputImpl get() {
        return this;
    }

    @Nullable
    public AckReasonCode getAckReasonCode() {
        return ackReasonCode;
    }

    public void authorizerPresent() {
        authorizerPresent.set(true);
    }

    public boolean isAuthorizerPresent() {
        return authorizerPresent.get();
    }
}