com.hivemq.extensions.events.OnServerDisconnectEvent 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.events;

import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.packets.general.DisconnectedReasonCode;
import com.hivemq.extensions.packets.general.UserPropertiesImpl;
import com.hivemq.mqtt.message.disconnect.DISCONNECT;
import com.hivemq.mqtt.message.mqtt5.Mqtt5UserProperties;

/**
 * The event to fire when the server sends a disconnect to a client or closes a clients channel.
 *
 * @author Florian Limpöck
 * @since 4.0.0
 */
@Immutable
public class OnServerDisconnectEvent {

    private final @Nullable DisconnectedReasonCode reasonCode;
    private final @Nullable String reasonString;
    private final @Nullable UserPropertiesImpl userProperties;

    public OnServerDisconnectEvent(
            final @Nullable DisconnectedReasonCode reasonCode,
            final @Nullable String reasonString,
            final @Nullable Mqtt5UserProperties userProperties) {

        this.reasonCode = reasonCode;
        this.reasonString = reasonString;
        this.userProperties = (userProperties == null) ? null : UserPropertiesImpl.of(userProperties.asList());
    }

    public OnServerDisconnectEvent(final @Nullable DISCONNECT disconnect) {
        if (disconnect != null) {
            this.reasonCode = disconnect.getReasonCode().toDisconnectedReasonCode();
            this.reasonString = disconnect.getReasonString();
            this.userProperties = UserPropertiesImpl.of(disconnect.getUserProperties().asList());
        } else {
            this.reasonCode = null;
            this.reasonString = null;
            this.userProperties = null;
        }
    }

    public @Nullable DisconnectedReasonCode getReasonCode() {
        return reasonCode;
    }

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

    public @Nullable UserPropertiesImpl getUserProperties() {
        return userProperties;
    }
}