Update subscribe/unsubscribe related messages (#60)

Author: JavaSaBr

application/src/test/groovy/javasabr/mqtt/broker/application/PublishRetryTest.groovy

@@ -6,7 +6,7 @@ import javasabr.mqtt.model.reason.code.ConnectAckReasonCode
 import javasabr.mqtt.model.reason.code.PublishCompletedReasonCode
 import javasabr.mqtt.model.reason.code.PublishReceivedReasonCode
 import javasabr.mqtt.model.reason.code.SubscribeAckReasonCode
-import javasabr.mqtt.model.subscribtion.Subscription
+import javasabr.mqtt.model.subscription.Subscription
 import javasabr.mqtt.model.topic.TopicFilter
 import javasabr.mqtt.network.message.in.ConnectAckMqttInMessage
 import javasabr.mqtt.network.message.in.PublishMqttInMessage

model/src/main/java/javasabr/mqtt/model/MqttMessageProperty.java

@@ -1,18 +1,19 @@
 package javasabr.mqtt.model;
 
-import java.util.stream.Stream;
 import javasabr.mqtt.model.data.type.MqttDataType;
 import javasabr.rlib.common.util.ClassUtils;
+import javasabr.rlib.common.util.NumberedEnum;
+import javasabr.rlib.common.util.NumberedEnumMap;
 import javasabr.rlib.common.util.ObjectUtils;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.experimental.Accessors;
 import lombok.experimental.FieldDefaults;
 import org.jspecify.annotations.Nullable;
 
-@Accessors(fluent = true, chain = false)
+@Accessors
 @FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
-public enum MqttMessageProperty {
+public enum MqttMessageProperty implements NumberedEnum<MqttMessageProperty> {
   PAYLOAD_FORMAT_INDICATOR(0x01, MqttDataType.BYTE),
   MESSAGE_EXPIRY_INTERVAL(0x02, MqttDataType.INTEGER),
   CONTENT_TYPE(0x03, MqttDataType.UTF_8_STRING),
@@ -41,38 +42,17 @@ public enum MqttMessageProperty {
   SUBSCRIPTION_IDENTIFIER_AVAILABLE(0x29, MqttDataType.BYTE),
   SHARED_SUBSCRIPTION_AVAILABLE(0x2A, MqttDataType.BYTE);
 
-  private static final MqttMessageProperty[] PROPERTIES;
-
-  static {
-
-    int maxId = Stream
-        .of(values())
-        .mapToInt(MqttMessageProperty::id)
-        .max()
-        .orElse(0);
-
-    var result = new MqttMessageProperty[maxId + 1];
-
-    Stream
-        .of(values())
-        .forEach(prop -> result[prop.id] = prop);
-
-    PROPERTIES = result;
-  }
+  private static final NumberedEnumMap<MqttMessageProperty> NUMBERED_MAP =
+      new NumberedEnumMap<>(MqttMessageProperty.class);
 
   public static MqttMessageProperty byId(int id) {
-    if (id < 0 || id >= PROPERTIES.length) {
-      throw new IllegalArgumentException("Unknown property with id: " + id);
-    } else {
-      return PROPERTIES[id];
-    }
+    return NUMBERED_MAP.require(id);
   }
 
   @Getter
   byte id;
   @Getter
   MqttDataType dataType;
-
   @Nullable
   Object defaultValue;
 
@@ -86,6 +66,11 @@ public static MqttMessageProperty byId(int id) {
     this.defaultValue = defaultValue;
   }
 
+  @Override
+  public int number() {
+    return id;
+  }
+
   public <T> T defaultValue() {
     return ClassUtils.unsafeNNCast(ObjectUtils.notNull(defaultValue));
   }

model/src/main/java/javasabr/mqtt/model/MqttProperties.java

@@ -47,6 +47,9 @@ public interface MqttProperties {
   int TOPIC_ALIAS_INVALID = 0;
 
   int SUBSCRIPTION_ID_IS_NOT_SET = 0;
+  int SUBSCRIPTION_ID_MIN = 1;
+  int SUBSCRIPTION_ID_MAX = 268_435_455;
+
   int MESSAGE_ID_IS_NOT_SET = 0;
 
   boolean SESSIONS_ENABLED_DEFAULT = true;

model/src/main/java/javasabr/mqtt/model/MqttProtocolErrors.java

@@ -1,16 +1,17 @@
 package javasabr.mqtt.model;
 
 public interface MqttProtocolErrors {
-  String NO_ANY_TOPIC_FILTER = "Not provided any information about TopicFilters";
+  String NO_ANY_TOPIC_FILTERS = "Not provided any information about 'Topic Filters'";
   String NO_ANY_TOPIC_NANE = "Not provided any information about TopicName";
   //String INVALID_TOPIC_ALIAS = "Provided invalid TopicAlias";
   String INVALID_PAYLOAD_FORMAT = "Provided invalid PayloadFormat";
   String INVALID_MESSAGE_EXPIRY_INTERVAL = "Provided invalid MessageExpiryInterval";
   String INVALID_RESPONSE_TOPIC_NAME = "Provided invalid ResponseTopicName";
-  String UNSUPPORTED_QOS_OR_RETAIN_HANDLING = "Unsupported 'QoS' or 'RetainHandling'";
+  String UNSUPPORTED_QOS_OR_RETAIN_HANDLING = "Provided unsupported 'QoS' or 'RetainHandling'";
   String MISSED_REQUIRED_MESSAGE_ID = "'Packet Identifier' must be presented'";
   String NOT_EXPECTED_MESSAGE_ID = "'Packet Identifier' must be zero'";
-  String PROTOCOL_LEVEL_UNSUPPORTED_NO_LOCAL_OPTION = "'NoLocal' option is not available on this protocol level";
-  String PROTOCOL_LEVEL_UNSUPPORTED_RETAIN_AS_PUBLISH_OPTION = "'RetainAsPublished' option is not available on this protocol level";
-  String PROTOCOL_LEVEL_UNSUPPORTED_RETAIN_HANDLING_OPTION = "'RetainHandling' option is not available on this protocol level";
+  String INVALID_SUBSCRIPTION_ID = "Provided invalid 'Subscription Identifier'";
+  String PROTOCOL_LEVEL_UNSUPPORTED_NO_LOCAL_OPTION = "'No Local' option is not available on this protocol level";
+  String PROTOCOL_LEVEL_UNSUPPORTED_RETAIN_AS_PUBLISH_OPTION = "'Retain As Published' option is not available on this protocol level";
+  String PROTOCOL_LEVEL_UNSUPPORTED_RETAIN_HANDLING_OPTION = "'Retain Handling' option is not available on this protocol level";
 }

model/src/main/java/javasabr/mqtt/model/message/MqttMessageType.java

@@ -1,18 +1,17 @@
 package javasabr.mqtt.model.message;
 
-import lombok.AccessLevel;
+import javasabr.rlib.common.util.NumberedEnum;
+import javasabr.rlib.common.util.NumberedEnumMap;
 import lombok.CustomLog;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.experimental.Accessors;
-import lombok.experimental.FieldDefaults;
 
 @Getter
 @CustomLog
-@Accessors(fluent = true)
+@Accessors
 @RequiredArgsConstructor
-@FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
-public enum MqttMessageType {
+public enum MqttMessageType implements NumberedEnum<MqttMessageType> {
   RESERVED(0),
   /**
    * After a Network Connection is established by a Client to a Server, the first Packet sent from the Client to the
@@ -105,16 +104,17 @@ public enum MqttMessageType {
    */
   INVALID(16);
 
-  private static final MqttMessageType[] VALUES = values();
+  private static final NumberedEnumMap<MqttMessageType> NUMBERED_MAP =
+      new NumberedEnumMap<>(MqttMessageType.class);
 
-  public static MqttMessageType fromByte(byte messageType) {
-    if (messageType < 0 || messageType > AUTHENTICATION.typeIndex()) {
-      log.warning(messageType, "Invalid message type:[%s]"::formatted);
-      return INVALID;
-    } else {
-      return VALUES[messageType];
-    }
+  public static MqttMessageType fromByte(int messageType) {
+    return NUMBERED_MAP.resolve(messageType, MqttMessageType.INVALID);
   }
 
-  int typeIndex;
+  private final int typeIndex;
+
+  @Override
+  public int number() {
+    return typeIndex;
+  }
 }

model/src/main/java/javasabr/mqtt/model/message/package-info.java

@@ -0,0 +1,4 @@
+@NullMarked
+package javasabr.mqtt.model.message;
+
+import org.jspecify.annotations.NullMarked;

model/src/main/java/javasabr/mqtt/model/reason/code/SubscribeAckReasonCode.java

@@ -2,17 +2,14 @@
 
 import javasabr.rlib.common.util.NumberedEnum;
 import javasabr.rlib.common.util.NumberedEnumMap;
-import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.experimental.Accessors;
-import lombok.experimental.FieldDefaults;
 
 @Getter
+@Accessors
 @RequiredArgsConstructor
-@Accessors(fluent = true, chain = false)
-@FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
-public enum SubscribeAckReasonCode implements NumberedEnum<SubscribeAckReasonCode> {
+public enum SubscribeAckReasonCode implements NumberedEnum<SubscribeAckReasonCode>, ReasonCode {
   /**
    * The subscription is accepted and the maximum QoS sent will be QoS 0. This might be a lower QoS than was requested.
    */
@@ -73,7 +70,7 @@ public static SubscribeAckReasonCode ofCode(int code) {
     return NUMBERED_MAP.require(code);
   }
 
-  int code;
+  private final int code;
 
   @Override
   public int number() {

model/src/main/java/javasabr/mqtt/model/reason/code/UnsubscribeAckReasonCode.java

@@ -1,72 +1,58 @@
 package javasabr.mqtt.model.reason.code;
 
-import java.util.stream.Stream;
-import javasabr.rlib.common.util.ObjectUtils;
+import javasabr.rlib.common.util.NumberedEnum;
+import javasabr.rlib.common.util.NumberedEnumMap;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
 
+@Getter
+@Accessors
 @RequiredArgsConstructor
-public enum UnsubscribeAckReasonCode {
+public enum UnsubscribeAckReasonCode implements NumberedEnum<UnsubscribeAckReasonCode>, ReasonCode {
   /**
    * The subscription is deleted.
    */
-  SUCCESS((byte) 0x00),
+  SUCCESS(0x00),
   /**
    * The subscription is accepted and the maximum QoS sent will be QoS 1. This might be a lower QoS than was requested.
    */
-  NO_SUBSCRIPTION_EXISTED((byte) 0x11),
+  NO_SUBSCRIPTION_EXISTED(0x11),
 
   // ERRORS
-
   /**
    * The unsubscribe could not be completed and the Server either does not wish to reveal the reason or none of the
    * other Reason Codes apply.
    */
-  UNSPECIFIED_ERROR((byte) 0x80),
+  UNSPECIFIED_ERROR(0x80),
   /**
    * The UNSUBSCRIBE is valid but the Server does not accept it.
    */
-  IMPLEMENTATION_SPECIFIC_ERROR((byte) 0x83),
+  IMPLEMENTATION_SPECIFIC_ERROR(0x83),
   /**
    * The Client is not authorized to unsubscribe.
    */
-  NOT_AUTHORIZED((byte) 0x87),
+  NOT_AUTHORIZED(0x87),
   /**
    * The Topic Filter is correctly formed but is not allowed for this Client.
    */
-  TOPIC_FILTER_INVALID((byte) 0x8F),
+  TOPIC_FILTER_INVALID(0x8F),
   /**
    * The specified Packet Identifier is already in use.
    */
-  PACKET_IDENTIFIER_IN_USE((byte) 0x91);
-
-  private static final UnsubscribeAckReasonCode[] VALUES;
-
-  static {
-
-    var maxId = Stream
-        .of(values())
-        .mapToInt(UnsubscribeAckReasonCode::value)
-        .map(value -> Byte.toUnsignedInt((byte) value))
-        .max()
-        .orElse(0);
+  PACKET_IDENTIFIER_IN_USE(0x91);
 
-    var values = new UnsubscribeAckReasonCode[maxId + 1];
+  private static final NumberedEnumMap<UnsubscribeAckReasonCode> NUMBERED_MAP =
+      new NumberedEnumMap<>(UnsubscribeAckReasonCode.class);
 
-    for (var value : values()) {
-      values[Byte.toUnsignedInt(value.value)] = value;
-    }
-
-    VALUES = values;
+  public static UnsubscribeAckReasonCode ofCode(int code) {
+    return NUMBERED_MAP.require(code);
   }
 
-  public static UnsubscribeAckReasonCode of(int index) {
-    return ObjectUtils.notNull(
-        VALUES[index],
-        index,
-        arg -> new IndexOutOfBoundsException("Doesn't support reason code: " + arg));
-  }
+  private final int code;
 
-  @Getter
-  private final byte value;
+  @Override
+  public int number() {
+    return code;
+  }
 }

model/src/main/java/javasabr/mqtt/model/session/ActiveSubscriptions.java

@@ -1,6 +1,6 @@
 package javasabr.mqtt.model.session;
 
-import javasabr.mqtt.model.subscribtion.Subscription;
+import javasabr.mqtt.model.subscription.Subscription;
 import javasabr.mqtt.model.topic.TopicFilter;
 import javasabr.rlib.collections.array.Array;
 

model/src/main/java/javasabr/mqtt/model/subscriber/SharedSubscriber.java

@@ -2,7 +2,7 @@
 
 import java.util.Collection;
 import java.util.concurrent.atomic.AtomicInteger;
-import javasabr.mqtt.model.subscribtion.SubscriptionOwner;
+import javasabr.mqtt.model.subscription.SubscriptionOwner;
 import javasabr.mqtt.model.topic.SharedTopicFilter;
 import javasabr.rlib.collections.array.Array;
 import javasabr.rlib.collections.array.ArrayFactory;