edu.umass.cs.reconfiguration.reconfigurationpackets

Class ClientReconfigurationPacket

java.lang.Object

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

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

edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket<java.net.InetSocketAddress>

edu.umass.cs.reconfiguration.reconfigurationpackets.ClientReconfigurationPacket

All Implemented Interfaces:

Request, Byteable, ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>, ThresholdProtocolEvent<java.net.InetSocketAddress,ReconfigurationPacket.PacketType,java.lang.String>, ReconfiguratorRequest, Keyable<java.lang.String>, Summarizable

Direct Known Subclasses:

ActiveReplicaError, CreateServiceName, DeleteServiceName, RequestActiveReplicas

public abstract class ClientReconfigurationPacket
extends BasicReconfigurationPacket<java.net.InetSocketAddress>
implements ReconfiguratorRequest

Author:

V. Arun This abstract class is the parent class for all packets that go back and forth between clients and reconfigurators. The current instantiations of this class include CreateServiceName, DeleteServiceName, and RequestActiveReplicas. The same implementation of ClientReconfigurationPacket is used for both the request and the corresponding response. The method isRequest() says whether the packet is an incoming request or an outgoing response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientReconfigurationPacket.Keys
static class	ClientReconfigurationPacket.ResponseCodes

Nested classes/interfaces inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

ReconfigurationPacket.PacketType

Field Summary

Fields

Modifier and Type	Field and Description
static Stringifiable<java.net.InetSocketAddress>	unstringer Unstringer needed to handle client InetSocketAddresses as opposed to NodeIDType.

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

epochNumber, serviceName

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

clientPacketTypes, HANDLER_METHOD_PREFIX, PACKET_TYPE, serverPacketTypes

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

type

Fields inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

NO_OP

Constructor Summary

Constructors

Constructor and Description
ClientReconfigurationPacket(java.net.InetSocketAddress initiator, ReconfigurationPacket.PacketType type, java.lang.String name, int epochNumber)
ClientReconfigurationPacket(java.net.InetSocketAddress initiator, ReconfigurationPacket.PacketType type, java.lang.String name, int epochNumber, java.net.InetSocketAddress myReceiver) myReceiver may need to be set at creation time in create/delete responses.
ClientReconfigurationPacket(org.json.JSONObject json)
ClientReconfigurationPacket(org.json.JSONObject json, Stringifiable<?> unstringer)
ClientReconfigurationPacket(java.lang.String name, ClientReconfigurationPacket crp)

Method Summary

Modifier and Type	Method and Description
long	getCreateTime()
java.net.InetSocketAddress	getCreator()
java.net.InetSocketAddress	getForwader()
java.net.InetSocketAddress	getForwardee()
java.util.Set<java.net.InetSocketAddress>	getHashRCs()
java.net.InetSocketAddress	getMyReceiver()
IntegerPacketType	getRequestType()
ClientReconfigurationPacket.ResponseCodes	getResponseCode()
java.lang.String	getResponseMessage()
java.lang.String	getSummary() Implementations are encouraged to return an inline created new Object() whose toString() method will return the actual String instead of just returning the String directly.
boolean	isFailed()
boolean	isForwardable()
boolean	isForwarded()
boolean	isRecursiveRedirectEnabled()
boolean	isRedirectedResponse() The sender will be different from the forwarder.
boolean	isRequest()
ClientReconfigurationPacket	makeResponse()
ClientReconfigurationPacket	setFailed()
ClientReconfigurationPacket	setFailed(ClientReconfigurationPacket.ResponseCodes code) Sets as failed and marks as response.
ClientReconfigurationPacket	setForwader(java.net.InetSocketAddress isa)
ClientReconfigurationPacket	setForwardee(java.net.InetSocketAddress isa)
ClientReconfigurationPacket	setHashRCs(java.util.Set<java.net.InetSocketAddress> RCs)
void	setRecursiveRedirect(boolean b)
ClientReconfigurationPacket	setResponseMessage(java.lang.String msg) Sets response message and marks as response.
org.json.JSONObject	toJSONObjectImpl()

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

getEpochNumber, getServiceName

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, concatenate, getMessage, getPacketType, getPacketTypeCanonicalClassName, getPacketTypeClass, getPacketTypeClassName, getReconfigurationPacket, getReconfigurationPacket, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketType, getReconfigurationPacketType, isReconfigurationPacket, putPacketType, toBytes, 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, toString, wait, wait, wait

Methods inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

getServiceName, toBytes, toString

Methods inherited from interface edu.umass.cs.utils.Summarizable

getSummary

Field Detail

unstringer

public static final Stringifiable<java.net.InetSocketAddress> unstringer

Unstringer needed to handle client InetSocketAddresses as opposed to NodeIDType.

Constructor Detail

ClientReconfigurationPacket

public ClientReconfigurationPacket(java.net.InetSocketAddress initiator,
                                   ReconfigurationPacket.PacketType type,
                                   java.lang.String name,
                                   int epochNumber)

Parameters:

initiator -

type -

name -

epochNumber -

ClientReconfigurationPacket

public ClientReconfigurationPacket(java.net.InetSocketAddress initiator,
                                   ReconfigurationPacket.PacketType type,
                                   java.lang.String name,
                                   int epochNumber,
                                   java.net.InetSocketAddress myReceiver)

myReceiver may need to be set at creation time in create/delete responses.

Parameters:

initiator -

type -

name -

epochNumber -

myReceiver -

ClientReconfigurationPacket

public ClientReconfigurationPacket(java.lang.String name,
                                   ClientReconfigurationPacket crp)

Parameters:

name -

crp -

ClientReconfigurationPacket

public ClientReconfigurationPacket(org.json.JSONObject json,
                                   Stringifiable<?> unstringer)
                            throws org.json.JSONException

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

ClientReconfigurationPacket

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

Parameters:

json -

Throws:

org.json.JSONException

Method Detail

toJSONObjectImpl

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

Overrides:

toJSONObjectImpl in class BasicReconfigurationPacket<java.net.InetSocketAddress>

Throws:

org.json.JSONException

getRequestType

public IntegerPacketType getRequestType()

Specified by:

getRequestType in interface Request

Overrides:

getRequestType in class BasicReconfigurationPacket<java.net.InetSocketAddress>

Returns:

The IntegerPacketType type corresponding to this request.

setFailed

public ClientReconfigurationPacket setFailed(ClientReconfigurationPacket.ResponseCodes code)

Sets as failed and marks as response.

Parameters:

code -

Returns:

Returns this after setting as failed.

setFailed

public ClientReconfigurationPacket setFailed()

Specified by:

setFailed in interface ReconfiguratorRequest

Returns:

Returns this after setting as failed.

isFailed

public boolean isFailed()

Specified by:

isFailed in interface ReconfiguratorRequest

Returns:

Whether this request failed.

setResponseMessage

public ClientReconfigurationPacket setResponseMessage(java.lang.String msg)

Sets response message and marks as response.

Specified by:

setResponseMessage in interface ReconfiguratorRequest

Parameters:

msg -

Returns:

this

getResponseMessage

public java.lang.String getResponseMessage()

Specified by:

getResponseMessage in interface ReconfiguratorRequest

Returns:

The success or failure message.

getResponseCode

public ClientReconfigurationPacket.ResponseCodes getResponseCode()

Returns:

Response code.

setHashRCs

public ClientReconfigurationPacket setHashRCs(java.util.Set<java.net.InetSocketAddress> RCs)

Parameters:

RCs - Set of consistently hashed reconfigurators for this name.

Returns:

this

getHashRCs

public java.util.Set<java.net.InetSocketAddress> getHashRCs()

Returns:

Set of consistently hashed reconfigurators for this name.

setRecursiveRedirect

public void setRecursiveRedirect(boolean b)

Parameters:

b -

isRecursiveRedirectEnabled

public boolean isRecursiveRedirectEnabled()

Returns:

True if recursive redirection enabled.

isRequest

public boolean isRequest()

Returns:

True if this is a request.

makeResponse

public ClientReconfigurationPacket makeResponse()

Returns:

this marked as a response.

getForwader

public java.net.InetSocketAddress getForwader()

Returns:

The socket address of the forwarding node.

getForwardee

public java.net.InetSocketAddress getForwardee()

Returns:

The socket address of the forwarding node.

getMyReceiver

public java.net.InetSocketAddress getMyReceiver()

Returns:

The socket address of the forwarding node.

getCreator

public java.net.InetSocketAddress getCreator()

Returns:

The socket address of the forwarding node.

setForwader

public ClientReconfigurationPacket setForwader(java.net.InetSocketAddress isa)

Parameters:

isa -

Returns:

this

setForwardee

public ClientReconfigurationPacket setForwardee(java.net.InetSocketAddress isa)

Parameters:

isa -

Returns:

this

isForwardable

public boolean isForwardable()

Returns:

True if it has not already been forwarded and recursive redirect is enabled.

isForwarded

public boolean isForwarded()

Returns:

True if forwarded.

isRedirectedResponse

public boolean isRedirectedResponse()

The sender will be different from the forwarder. The initiator is the end client that initiated this request.

Returns:

True if this is a response from a node that received a forwarded client request.

getCreateTime

public long getCreateTime()

Returns:

Creation timestamp.

getSummary

public java.lang.String getSummary()

Description copied from interface: Summarizable

Implementations are encouraged to return an inline created new Object() whose toString() method will return the actual String instead of just returning the String directly. This helps loggers be more efficient as the String won't be generated until the log level demands it.

Specified by:

getSummary in interface Request

Specified by:

getSummary in interface Summarizable

Overrides:

getSummary in class BasicReconfigurationPacket<java.net.InetSocketAddress>

Returns:

A pretty-print summary.