edu.umass.cs.reconfiguration.reconfigurationpackets

Class ReconfigurationPacket<NodeIDType>

java.lang.Object

edu.umass.cs.protocoltask.json.ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket<NodeIDType>

Type Parameters:

NodeIDType -

All Implemented Interfaces:

Byteable, ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>, ThresholdProtocolEvent<NodeIDType,ReconfigurationPacket.PacketType,java.lang.String>, Keyable<java.lang.String>

Direct Known Subclasses:

BasicReconfigurationPacket

public abstract class ReconfigurationPacket<NodeIDType>
extends ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>
implements Byteable

Author:

V. Arun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReconfigurationPacket.PacketType End of ReconfigurationpacketType

Nested classes/interfaces inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

ProtocolPacket.Keys

Field Summary

Fields

Modifier and Type	Field and Description
static ReconfigurationPacket.PacketType[]	clientPacketTypes
static java.lang.String	HANDLER_METHOD_PREFIX Used for reflection for invoking packet handling methods.
static java.lang.String	PACKET_TYPE Reconfiguration packet type JSON key.
static ReconfigurationPacket.PacketType[]	serverPacketTypes

Fields inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

type

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReconfigurationPacket(org.json.JSONObject json, Stringifiable<NodeIDType> unstringer)
protected	ReconfigurationPacket(NodeIDType initiator) End of ReconfigurationpacketType class map

Method Summary

Modifier and Type	Method and Description
static void	assertPacketTypeChecks(java.util.Map<ReconfigurationPacket.PacketType,java.lang.Class<?>> typeMap, java.lang.Class<?> target)
static void	assertPacketTypeChecks(java.util.Map<ReconfigurationPacket.PacketType,java.lang.Class<?>> typeMap, java.lang.Class<?> target, java.lang.String handlerMethodPrefix)
static void	assertPacketTypeChecks(ReconfigurationPacket.PacketType[] types, java.lang.Class<?> target, java.lang.String handlerMethodPrefix)
static void	assertPacketTypeChecks(ReconfigurationPacket.PacketType type, java.lang.String packetName, java.lang.Class<?> target, java.lang.String handlerMethodPrefix)
static ReconfigurationPacket.PacketType[]	concatenate(ReconfigurationPacket.PacketType[]... types)
java.lang.Object	getMessage()
ReconfigurationPacket.PacketType	getPacketType(org.json.JSONObject json)
static java.lang.String	getPacketTypeCanonicalClassName(ReconfigurationPacket.PacketType type)
static java.lang.Class<?>	getPacketTypeClass(ReconfigurationPacket.PacketType type)
static java.lang.String	getPacketTypeClassName(ReconfigurationPacket.PacketType type)
static BasicReconfigurationPacket<?>	getReconfigurationPacket(org.json.JSONObject json, Stringifiable<?> unstringer)
static BasicReconfigurationPacket<?>	getReconfigurationPacket(Request request, Stringifiable<?> unstringer)
static BasicReconfigurationPacket<?>	getReconfigurationPacketSuppressExceptions(org.json.JSONObject json, Stringifiable<?> unstringer)
static BasicReconfigurationPacket<?>	getReconfigurationPacketSuppressExceptions(java.lang.String str, Stringifiable<?> unstringer)
ReconfigurationPacket.PacketType	getReconfigurationPacketType()
static ReconfigurationPacket.PacketType	getReconfigurationPacketType(org.json.JSONObject json)
static boolean	isReconfigurationPacket(org.json.JSONObject json)
void	putPacketType(org.json.JSONObject json, ReconfigurationPacket.PacketType type)
byte[]	toBytes() The recommendation that the first four bytes contain the integer packet type is for bring able to write efficient demultiplexers that will not attempt to decode an incoming packet unless the type matches one of the types they expect to receive.
org.json.JSONObject	toJSONObjectImpl()
java.lang.String	toString()

Methods inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

flip, getInitiator, getKey, getSender, getType, setKey, setSender, setType, toJSONObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PACKET_TYPE

public static final java.lang.String PACKET_TYPE

Reconfiguration packet type JSON key.

See Also:

Constant Field Values

HANDLER_METHOD_PREFIX

public static final java.lang.String HANDLER_METHOD_PREFIX

Used for reflection for invoking packet handling methods.

See Also:

Constant Field Values

clientPacketTypes

public static final ReconfigurationPacket.PacketType[] clientPacketTypes

serverPacketTypes

public static final ReconfigurationPacket.PacketType[] serverPacketTypes

Constructor Detail

ReconfigurationPacket

protected ReconfigurationPacket(NodeIDType initiator)

End of ReconfigurationpacketType class map

ReconfigurationPacket

public ReconfigurationPacket(org.json.JSONObject json,
                             Stringifiable<NodeIDType> unstringer)
                      throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

toJSONObjectImpl

public org.json.JSONObject toJSONObjectImpl()
                                     throws org.json.JSONException

Specified by:

toJSONObjectImpl in class ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

Throws:

org.json.JSONException

getMessage

public java.lang.Object getMessage()

Specified by:

getMessage in interface ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>

Overrides:

getMessage in class ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

Returns:

An object whose toString() method must serialize this event to a String.

getPacketType

public ReconfigurationPacket.PacketType getPacketType(org.json.JSONObject json)
                                               throws org.json.JSONException

Specified by:

getPacketType in class ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

Throws:

org.json.JSONException

putPacketType

public void putPacketType(org.json.JSONObject json,
                          ReconfigurationPacket.PacketType type)
                   throws org.json.JSONException

Specified by:

putPacketType in class ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

Throws:

org.json.JSONException

toString

public java.lang.String toString()

Overrides:

toString in class ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

getReconfigurationPacketType

public ReconfigurationPacket.PacketType getReconfigurationPacketType()

isReconfigurationPacket

public static final boolean isReconfigurationPacket(org.json.JSONObject json)
                                             throws org.json.JSONException

Throws:

org.json.JSONException

getReconfigurationPacketType

public static final ReconfigurationPacket.PacketType getReconfigurationPacketType(org.json.JSONObject json)
                                                                           throws org.json.JSONException

Throws:

org.json.JSONException

getPacketTypeCanonicalClassName

public static final java.lang.String getPacketTypeCanonicalClassName(ReconfigurationPacket.PacketType type)

getPacketTypeClassName

public static final java.lang.String getPacketTypeClassName(ReconfigurationPacket.PacketType type)

getPacketTypeClass

public static final java.lang.Class<?> getPacketTypeClass(ReconfigurationPacket.PacketType type)

getReconfigurationPacketSuppressExceptions

public static BasicReconfigurationPacket<?> getReconfigurationPacketSuppressExceptions(org.json.JSONObject json,
                                                                                       Stringifiable<?> unstringer)

getReconfigurationPacketSuppressExceptions

public static BasicReconfigurationPacket<?> getReconfigurationPacketSuppressExceptions(java.lang.String str,
                                                                                       Stringifiable<?> unstringer)

getReconfigurationPacket

public static BasicReconfigurationPacket<?> getReconfigurationPacket(org.json.JSONObject json,
                                                                     Stringifiable<?> unstringer)
                                                              throws org.json.JSONException

Throws:

org.json.JSONException

getReconfigurationPacket

public static BasicReconfigurationPacket<?> getReconfigurationPacket(Request request,
                                                                     Stringifiable<?> unstringer)
                                                              throws org.json.JSONException

Throws:

org.json.JSONException

assertPacketTypeChecks

public static void assertPacketTypeChecks(ReconfigurationPacket.PacketType[] types,
                                          java.lang.Class<?> target,
                                          java.lang.String handlerMethodPrefix)

assertPacketTypeChecks

public static void assertPacketTypeChecks(java.util.Map<ReconfigurationPacket.PacketType,java.lang.Class<?>> typeMap,
                                          java.lang.Class<?> target,
                                          java.lang.String handlerMethodPrefix)

assertPacketTypeChecks

public static void assertPacketTypeChecks(ReconfigurationPacket.PacketType type,
                                          java.lang.String packetName,
                                          java.lang.Class<?> target,
                                          java.lang.String handlerMethodPrefix)

assertPacketTypeChecks

public static void assertPacketTypeChecks(java.util.Map<ReconfigurationPacket.PacketType,java.lang.Class<?>> typeMap,
                                          java.lang.Class<?> target)

concatenate

public static ReconfigurationPacket.PacketType[] concatenate(ReconfigurationPacket.PacketType[]... types)

toBytes

public byte[] toBytes()

Description copied from interface: Byteable

The recommendation that the first four bytes contain the integer packet type is for bring able to write efficient demultiplexers that will not attempt to decode an incoming packet unless the type matches one of the types they expect to receive. Not following this requirement will will not break applications but can result in wasted decoding attempts if the inital bytes happen to accidentally match the header patterns used by other demultiplexers.

Specified by:

toBytes in interface Byteable

Returns:

byte[] serialized form of this object. It is recommended that the first four bytes contain the integer packet type of this packet in network byte order, i.e., ByteBuffer.wrap(bytes,0,4).getInt() should return the expected type on the bytes being returned.