com.hivemq.extensions.packets.publish.PublishPacketImpl 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.packets.publish;

import com.google.common.primitives.ImmutableIntArray;
import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.packets.general.Qos;
import com.hivemq.extension.sdk.api.packets.publish.PayloadFormatIndicator;
import com.hivemq.extension.sdk.api.packets.publish.PublishPacket;
import com.hivemq.extensions.packets.general.UserPropertiesImpl;
import com.hivemq.mqtt.message.publish.PUBLISH;

import java.nio.ByteBuffer;
import java.util.List;
import java.util.Objects;
import java.util.Optional;

/**
 * @author Florian Limpöck
 * @author Silvio Giebl
 * @since 4.0.0
 */
@Immutable
public class PublishPacketImpl implements PublishPacket {

    final @NotNull String topic;
    final @NotNull Qos qos;
    final @NotNull Qos onwardQos;
    final int packetId;
    final boolean dupFlag;
    final @Nullable ByteBuffer payload;
    final boolean retain;
    final long messageExpiryInterval;
    final @Nullable PayloadFormatIndicator payloadFormatIndicator;
    final @Nullable String contentType;
    final @Nullable String responseTopic;
    final @Nullable ByteBuffer correlationData;
    final @NotNull ImmutableIntArray subscriptionIdentifiers;
    final @NotNull UserPropertiesImpl userProperties;
    final long timestamp;

    public PublishPacketImpl(
            final @NotNull String topic,
            final @NotNull Qos qos,
            final @NotNull Qos onwardQos,
            final int packetId,
            final boolean dupFlag,
            final @Nullable ByteBuffer payload,
            final boolean retain,
            final long messageExpiryInterval,
            final @Nullable PayloadFormatIndicator payloadFormatIndicator,
            final @Nullable String contentType,
            final @Nullable String responseTopic,
            final @Nullable ByteBuffer correlationData,
            final @NotNull ImmutableIntArray subscriptionIdentifiers,
            final @NotNull UserPropertiesImpl userProperties,
            final long timestamp) {

        this.topic = topic;
        this.qos = qos;
        this.onwardQos = onwardQos;
        this.packetId = packetId;
        this.dupFlag = dupFlag;
        this.payload = payload;
        this.retain = retain;
        this.messageExpiryInterval = messageExpiryInterval;
        this.payloadFormatIndicator = payloadFormatIndicator;
        this.contentType = contentType;
        this.responseTopic = responseTopic;
        this.correlationData = correlationData;
        this.subscriptionIdentifiers = subscriptionIdentifiers;
        this.userProperties = userProperties;
        this.timestamp = timestamp;
    }

    public PublishPacketImpl(final @NotNull PUBLISH publish) {
        this(publish.getTopic(),
                publish.getQoS().toQos(),
                publish.getOnwardQoS().toQos(),
                publish.getPacketIdentifier(),
                publish.isDuplicateDelivery(),
                (publish.getPayload() == null) ? null : ByteBuffer.wrap(publish.getPayload()),
                publish.isRetain(),
                publish.getMessageExpiryInterval(),
                (publish.getPayloadFormatIndicator() == null) ?
                        null :
                        publish.getPayloadFormatIndicator().toPayloadFormatIndicator(),
                publish.getContentType(),
                publish.getResponseTopic(),
                publish.getCorrelationData() == null ? null : ByteBuffer.wrap(publish.getCorrelationData()),
                (publish.getSubscriptionIdentifiers() == null) ?
                        ImmutableIntArray.of() :
                        publish.getSubscriptionIdentifiers(),
                UserPropertiesImpl.of(publish.getUserProperties().asList()),
                publish.getTimestamp());
    }

    @Override
    public @NotNull String getTopic() {
        return topic;
    }

    @Override
    public @NotNull Qos getQos() {
        return qos;
    }

    public @NotNull Qos getOnwardQos() {
        return onwardQos;
    }

    @Override
    public int getPacketId() {
        return packetId;
    }

    @Override
    public boolean getDupFlag() {
        return dupFlag;
    }

    @Override
    public @NotNull Optional getPayload() {
        return (payload == null) ? Optional.empty() : Optional.of(payload.asReadOnlyBuffer());
    }

    @Override
    public boolean getRetain() {
        return retain;
    }

    @Override
    public @NotNull Optional getMessageExpiryInterval() {
        if (messageExpiryInterval == PUBLISH.MESSAGE_EXPIRY_INTERVAL_NOT_SET) {
            return Optional.empty();
        } else {
            return Optional.of(messageExpiryInterval);
        }
    }

    @Override
    public @NotNull Optional getPayloadFormatIndicator() {
        return Optional.ofNullable(payloadFormatIndicator);
    }

    @Override
    public @NotNull Optional getContentType() {
        return Optional.ofNullable(contentType);
    }

    @Override
    public @NotNull Optional getResponseTopic() {
        return Optional.ofNullable(responseTopic);
    }

    @Override
    public @NotNull Optional getCorrelationData() {
        return (correlationData == null) ? Optional.empty() : Optional.of(correlationData.asReadOnlyBuffer());
    }

    @Override
    public @NotNull List getSubscriptionIdentifiers() {
        return subscriptionIdentifiers.asList();
    }

    @Override
    public @NotNull UserPropertiesImpl getUserProperties() {
        return userProperties;
    }

    @Override
    public long getTimestamp() {
        return timestamp;
    }

    @Override
    public boolean equals(final @Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof PublishPacketImpl)) {
            return false;
        }
        final PublishPacketImpl that = (PublishPacketImpl) o;
        return that.canEqual(this) &&
                topic.equals(that.topic) &&
                (qos == that.qos) &&
                (onwardQos == that.onwardQos) &&
                (packetId == that.packetId) &&
                (dupFlag == that.dupFlag) &&
                Objects.equals(payload, that.payload) &&
                (retain == that.retain) &&
                (messageExpiryInterval == that.messageExpiryInterval) &&
                (payloadFormatIndicator == that.payloadFormatIndicator) &&
                Objects.equals(contentType, that.contentType) &&
                Objects.equals(responseTopic, that.responseTopic) &&
                Objects.equals(correlationData, that.correlationData) &&
                subscriptionIdentifiers.equals(that.subscriptionIdentifiers) &&
                userProperties.equals(that.userProperties) &&
                timestamp == that.timestamp;
    }

    protected boolean canEqual(final @Nullable Object o) {
        return o instanceof PublishPacketImpl;
    }

    @Override
    public int hashCode() {
        return Objects.hash(topic,
                qos,
                onwardQos,
                packetId,
                dupFlag,
                payload,
                retain,
                messageExpiryInterval,
                payloadFormatIndicator,
                contentType,
                responseTopic,
                correlationData,
                subscriptionIdentifiers,
                userProperties,
                timestamp);
    }
}