com.mobius.software.mqttsn.parser.avps.Flags Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mqtt-sn-parser Show documentation
Mobius MQTT-SN PARSER
There is a newer version: 1.0.5
package com.mobius.software.mqttsn.parser.avps;

import java.util.EnumSet;

import com.mobius.software.mqttsn.parser.exceptions.MalformedMessageException;

public class Flags
{
	private boolean dup;
	private SNQoS qos;
	private boolean retain;
	private boolean will;
	private boolean cleanSession;
	private TopicType topicType;

	public Flags(boolean dup, SNQoS qos, boolean retain, boolean will, boolean cleanSession, TopicType topicType)
	{
		this.dup = dup;
		this.qos = qos;
		this.retain = retain;
		this.will = will;
		this.cleanSession = cleanSession;
		this.topicType = topicType;
	}

	public Flags reInit(boolean dup, SNQoS qos, boolean retain, boolean will, boolean cleanSession, TopicType topicType)
	{
		this.dup = dup;
		this.qos = qos;
		this.retain = retain;
		this.will = will;
		this.cleanSession = cleanSession;
		this.topicType = topicType;
		return this;
	}

	public static Flags decode(byte flagsByte, SNType type)
	{
		EnumSet bitMask = EnumSet.noneOf(Flag.class);
		for (Flag flag : Flag.values())
		{
			if ((flagsByte & flag.getValue()) == flag.getValue())
				bitMask.add(flag);
		}
		return Flags.validateAndCreate(bitMask, type);
	}

	private static Flags validateAndCreate(EnumSet bitMask, SNType type)
	{
		if (bitMask.contains(Flag.RESERVED_TOPIC))
			throw new MalformedMessageException("Invalid topic type encoding. TopicType reserved bit must not be encoded");

		boolean dup = bitMask.contains(Flag.DUPLICATE);
		boolean retain = bitMask.contains(Flag.RETAIN);
		boolean will = bitMask.contains(Flag.WILL);
		boolean cleanSession = bitMask.contains(Flag.CLEAN_SESSION);

		SNQoS qos = null;
		if (bitMask.contains(Flag.QOS_LEVEL_ONE))
			qos = SNQoS.LEVEL_ONE;
		else if (bitMask.contains(Flag.QOS_2))
			qos = SNQoS.EXACTLY_ONCE;
		else if (bitMask.contains(Flag.QOS_1))
			qos = SNQoS.AT_LEAST_ONCE;
		else
			qos = SNQoS.AT_MOST_ONCE;

		TopicType topicType = null;
		if (bitMask.contains(Flag.SHORT_TOPIC))
			topicType = TopicType.SHORT;
		else if (bitMask.contains(Flag.ID_TOPIC))
			topicType = TopicType.ID;
		else
			topicType = TopicType.NAMED;

		switch (type)
		{
		case CONNECT:
			if (dup)
				throw new MalformedMessageException(type + " invalid encoding: dup flag");
			if (qos != SNQoS.AT_MOST_ONCE)
				throw new MalformedMessageException(type + " invalid encoding: qos flag - " + qos.getValue());
			if (retain)
				throw new MalformedMessageException(type + " invalid encoding: retain flag");
			if (topicType != TopicType.NAMED)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag - " + topicType.getValue());
			break;
		case WILL_TOPIC:
			if (dup)
				throw new MalformedMessageException(type + " invalid encoding: dup flag");
			if (qos == null)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (topicType != TopicType.NAMED)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag - " + topicType.getValue());
			break;

		case PUBLISH:
			if (qos == null)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (topicType == null)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (dup && (qos == SNQoS.AT_MOST_ONCE || qos == SNQoS.LEVEL_ONE))
				throw new MalformedMessageException(type + " invalid encoding: dup flag with invalid qos:" + qos);
			break;

		case SUBSCRIBE:
			if (qos == null)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (qos == SNQoS.LEVEL_ONE)
				throw new MalformedMessageException(type + "invalid encoding: qos " + qos);
			if (retain)
				throw new MalformedMessageException(type + " invalid encoding: retain flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (topicType == null)
				throw new MalformedMessageException(type + " invalid encoding: retain flag");
			break;

		case SUBACK:
			if (dup)
				throw new MalformedMessageException(type + " invalid encoding: dup flag");
			if (qos == null)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (retain)
				throw new MalformedMessageException(type + " invalid encoding: retain flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (topicType != TopicType.NAMED)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag");
			break;

		case UNSUBSCRIBE:
			if (dup)
				throw new MalformedMessageException(type + " invalid encoding: dup flag");
			if (qos != SNQoS.AT_MOST_ONCE)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (retain)
				throw new MalformedMessageException(type + " invalid encoding: retain flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (topicType == null)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag");
			break;

		case WILL_TOPIC_UPD:
			if (dup)
				throw new MalformedMessageException(type + " invalid encoding: dup flag");
			if (qos == null)
				throw new MalformedMessageException(type + " invalid encoding: qos flag");
			if (will)
				throw new MalformedMessageException(type + " invalid encoding: will flag");
			if (cleanSession)
				throw new MalformedMessageException(type + " invalid encoding: cleanSession flag");
			if (topicType != TopicType.NAMED)
				throw new MalformedMessageException(type + " invalid encoding: topicIdType flag");
			break;

		default:
			break;
		}
		return new Flags(dup, qos, retain, will, cleanSession, topicType);
	}

	public static byte encode(boolean dup, SNQoS qos, boolean retain, boolean will, boolean cleanSession, TopicType topicType)
	{
		byte flagsByte = 0;
		if (dup)
			flagsByte += Flag.DUPLICATE.getValue();
		if (qos != null)
			flagsByte += qos.getValue() << 5;
		if (retain)
			flagsByte += Flag.RETAIN.getValue();
		if (will)
			flagsByte += Flag.WILL.getValue();
		if (cleanSession)
			flagsByte += Flag.CLEAN_SESSION.getValue();
		if (topicType != null)
			flagsByte += topicType.getValue();
		return flagsByte;
	}

	public boolean isDup()
	{
		return dup;
	}

	public void setDup(boolean dup)
	{
		this.dup = dup;
	}

	public SNQoS getQos()
	{
		return qos;
	}

	public void setQos(SNQoS qos)
	{
		this.qos = qos;
	}

	public boolean isRetain()
	{
		return retain;
	}

	public void setRetain(boolean retain)
	{
		this.retain = retain;
	}

	public boolean isWill()
	{
		return will;
	}

	public void setWill(boolean will)
	{
		this.will = will;
	}

	public boolean isCleanSession()
	{
		return cleanSession;
	}

	public void setCleanSession(boolean cleanSession)
	{
		this.cleanSession = cleanSession;
	}

	public TopicType getTopicType()
	{
		return topicType;
	}

	public void setTopicType(TopicType topicType)
	{
		this.topicType = topicType;
	}
}