eu.hgross.blaubot.admin

Class AbstractAdminMessage

java.lang.Object

eu.hgross.blaubot.admin.AbstractAdminMessage

Direct Known Subclasses:

ACKPronouncePrinceAdminMessage, AddSubscriptionAdminMessage, BowDownToNewKingAdminMessage, CensusMessage, CloseRelayConnectionAdminMessage, DiscoveredDeviceAdminMessage, FinishedHandshakeAdminMessage, PrinceFoundAKingAdminMessage, PronouncePrinceAdminMessage, RelayAdminMessage, RemoveSubscriptionAdminMessage, ServerConnectionAvailableAdminMessage, ServerConnectionDownAdminMessage, StringAdminMessage

public abstract class AbstractAdminMessage
extends java.lang.Object

Abstract class for AdminMessages. The admin messages are identified by their classifiers encoded as one byte. AdminMessages should be created using the AdminMessageFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CLASSIFIER_ADD_SUBSCRIPTION
static byte	CLASSIFIER_BOW_DOWN_TO_NEW_KING
static byte	CLASSIFIER_CENSUS_MESSAGE
static byte	CLASSIFIER_CLOSE_SERVER_CONNECTION
static byte	CLASSIFIER_DISCOVERED_DEVICE
static byte	CLASSIFIER_FINISHED_HANDSHAKE
static byte	CLASSIFIER_KEEP_ALIVE_MESSAGE
static byte	CLASSIFIER_NEW_PRINCE_MESSAGE
static byte	CLASSIFIER_PRINCE_ACK
static byte	CLASSIFIER_PRINCE_FOUND_A_KING_MESSAGE
static byte	CLASSIFIER_REMOVE_SUBSCRIPTION
static byte	CLASSIFIER_SERVER_CONNECTION_AVAILABLE
static byte	CLASSIFIER_SERVER_CONNECTION_DOWN
static byte	CLASSIFIER_SERVER_CONNECTION_RELAY_PAYLOAD
static byte	CLASSIFIER_STRING_MESSAGE
protected static com.google.gson.Gson	gson
static int	HEADER_LENGTH The admin message header length in bytes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAdminMessage(BlaubotMessage message)
	AbstractAdminMessage(byte classifier)

Method Summary

Modifier and Type	Method and Description
protected byte[]	classifierAndPayloadBytes() Get this message's byte representation including the classifier bytes
boolean	equals(java.lang.Object obj)
byte	getClassifier()
int	hashCode()
protected abstract byte[]	payloadToBytes() Gets this message's byte representation (NOT including the classifier)
protected void	setClassifier(byte classifier)
protected abstract void	setUpFromBytes(java.nio.ByteBuffer messagePayloadAsBytes) Should set the message's attributes based on the message's payload.
BlaubotMessage	toBlaubotMessage() Creates a BlaubotMessage representing this AbstractAdminMessage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_LENGTH

public static int HEADER_LENGTH

The admin message header length in bytes. It is actually just a one byte discriminator.

gson

protected static final com.google.gson.Gson gson

CLASSIFIER_CENSUS_MESSAGE

public static final byte CLASSIFIER_CENSUS_MESSAGE

See Also:

Constant Field Values

CLASSIFIER_NEW_PRINCE_MESSAGE

public static final byte CLASSIFIER_NEW_PRINCE_MESSAGE

See Also:

Constant Field Values

CLASSIFIER_KEEP_ALIVE_MESSAGE

public static final byte CLASSIFIER_KEEP_ALIVE_MESSAGE

See Also:

Constant Field Values

CLASSIFIER_PRINCE_FOUND_A_KING_MESSAGE

public static final byte CLASSIFIER_PRINCE_FOUND_A_KING_MESSAGE

See Also:

Constant Field Values

CLASSIFIER_BOW_DOWN_TO_NEW_KING

public static final byte CLASSIFIER_BOW_DOWN_TO_NEW_KING

See Also:

Constant Field Values

CLASSIFIER_PRINCE_ACK

public static final byte CLASSIFIER_PRINCE_ACK

See Also:

Constant Field Values

CLASSIFIER_ADD_SUBSCRIPTION

public static final byte CLASSIFIER_ADD_SUBSCRIPTION

See Also:

Constant Field Values

CLASSIFIER_REMOVE_SUBSCRIPTION

public static final byte CLASSIFIER_REMOVE_SUBSCRIPTION

See Also:

Constant Field Values

CLASSIFIER_STRING_MESSAGE

public static final byte CLASSIFIER_STRING_MESSAGE

See Also:

Constant Field Values

CLASSIFIER_SERVER_CONNECTION_AVAILABLE

public static final byte CLASSIFIER_SERVER_CONNECTION_AVAILABLE

See Also:

Constant Field Values

CLASSIFIER_SERVER_CONNECTION_DOWN

public static final byte CLASSIFIER_SERVER_CONNECTION_DOWN

See Also:

Constant Field Values

CLASSIFIER_SERVER_CONNECTION_RELAY_PAYLOAD

public static final byte CLASSIFIER_SERVER_CONNECTION_RELAY_PAYLOAD

See Also:

Constant Field Values

CLASSIFIER_CLOSE_SERVER_CONNECTION

public static final byte CLASSIFIER_CLOSE_SERVER_CONNECTION

See Also:

Constant Field Values

CLASSIFIER_DISCOVERED_DEVICE

public static final byte CLASSIFIER_DISCOVERED_DEVICE

See Also:

Constant Field Values

CLASSIFIER_FINISHED_HANDSHAKE

public static final byte CLASSIFIER_FINISHED_HANDSHAKE

See Also:

Constant Field Values

Constructor Detail

AbstractAdminMessage

protected AbstractAdminMessage(BlaubotMessage message)

AbstractAdminMessage

public AbstractAdminMessage(byte classifier)

Method Detail

setClassifier

protected void setClassifier(byte classifier)

getClassifier

public byte getClassifier()

payloadToBytes

protected abstract byte[] payloadToBytes()

Gets this message's byte representation (NOT including the classifier)

Returns:

the payload as byte array

classifierAndPayloadBytes

protected byte[] classifierAndPayloadBytes()

Get this message's byte representation including the classifier bytes

Returns:

the serialized classifier and payload bytes

setUpFromBytes

protected abstract void setUpFromBytes(java.nio.ByteBuffer messagePayloadAsBytes)

Should set the message's attributes based on the message's payload. The ByteBuffer contains the classifier bytes but it's current index will be set beyond that.

Parameters:

messagePayloadAsBytes - a ByteBuffer wrapped around the message's payload with it's current index set beyond the classifier bytes

toBlaubotMessage

public BlaubotMessage toBlaubotMessage()

Creates a BlaubotMessage representing this AbstractAdminMessage

Returns:

the BlaubotMessage representation

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object