edu.umass.cs.reconfiguration.reconfigurationpackets

Class CreateServiceName

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

edu.umass.cs.reconfiguration.reconfigurationpackets.CreateServiceName

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:

BatchedCreateServiceName

public class CreateServiceName
extends ClientReconfigurationPacket

Author:

V. Arun This class has a field to specify the initial state in addition to the default fields in ClientReconfigurationPacket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateServiceName.Keys

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

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
java.lang.String	initialState Initial state.
java.util.Map<java.lang.String,java.lang.String>	nameStates Map of name,state pairs for batched creates.
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

Modifier	Constructor and Description
protected	CreateServiceName(java.net.InetSocketAddress initiator, java.lang.String name, int epochNumber, java.lang.String state)
	CreateServiceName(java.net.InetSocketAddress initiator, java.lang.String name, int epochNumber, java.lang.String state, java.net.InetSocketAddress myReceiver) For internal use only.
	CreateServiceName(java.net.InetSocketAddress initiator, java.lang.String name, int epochNumber, java.lang.String state, java.util.Map<java.lang.String,java.lang.String> nameStates)
	CreateServiceName(org.json.JSONObject json)
	CreateServiceName(org.json.JSONObject json, Stringifiable<?> unstringer)
	CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates)
	CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates, CreateServiceName create) FIXME: need to document the reliance on the consistent ordering of the head element in nameStates.
	CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates, ReconfigurationConfig.ReconfigureUponActivesChange policy)
	CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates, java.util.Set<java.lang.String> failedCreates, CreateServiceName create)
	CreateServiceName(java.lang.String name, java.lang.String state)
	CreateServiceName(java.lang.String name, java.lang.String state, ReconfigurationConfig.ReconfigureUponActivesChange policy)
	CreateServiceName(java.lang.String name, java.lang.String state, java.util.Set<java.net.InetSocketAddress> initGroup) A constructor that allows the caller to specify an initial group.
	CreateServiceName(java.lang.String name, java.lang.String state, java.util.Set<java.net.InetSocketAddress> initGroup, ReconfigurationConfig.ReconfigureUponActivesChange policy) A constructor to specify both an initial group and a policy for reconfiguration upon addition or deletion of active replicas.

Method Summary

Modifier and Type	Method and Description
CreateServiceName	getHeadOnly()
java.util.Set<java.net.InetSocketAddress>	getInitGroup() Returns the initGroup specified in this message.
java.lang.String	getInitialState()
protected static org.json.JSONArray	getNameStateJSONArray(java.util.Map<java.lang.String,java.lang.String> nameStates)
protected static java.util.Map<java.lang.String,java.lang.String>	getNameStateMap(org.json.JSONObject json)
java.util.Map<java.lang.String,java.lang.String>	getNameStates()
ReconfigurationConfig.ReconfigureUponActivesChange	getReconfigureUponActivesChangePolicy()
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	isBatched()
static CreateServiceName[]	makeCreateNameRequest(java.util.Map<java.lang.String,java.lang.String> nameStates, int batchSize)
static CreateServiceName[]	makeCreateNameRequest(java.util.Map<java.lang.String,java.lang.String> nameStates, int batchSize, java.util.Set<java.lang.String> reconfigurators)
int	size()
org.json.JSONObject	toJSONObjectImpl()

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

getCreateTime, getCreator, getForwader, getForwardee, getHashRCs, getMyReceiver, getRequestType, getResponseCode, getResponseMessage, isFailed, isForwardable, isForwarded, isRecursiveRedirectEnabled, isRedirectedResponse, isRequest, makeResponse, setFailed, setFailed, setForwader, setForwardee, setHashRCs, setRecursiveRedirect, setResponseMessage

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.

initialState

public final java.lang.String initialState

Initial state.

nameStates

public final java.util.Map<java.lang.String,java.lang.String> nameStates

Map of name,state pairs for batched creates.

Constructor Detail

CreateServiceName

public CreateServiceName(java.lang.String name,
                         java.lang.String state)

Parameters:

name -

state -

CreateServiceName

public CreateServiceName(java.lang.String name,
                         java.lang.String state,
                         java.util.Set<java.net.InetSocketAddress> initGroup)

A constructor that allows the caller to specify an initial group. This method is meant primarily for internal use. End-clients should let the reconfigurators pick the initial set of replicas randomly by default.

Parameters:

name -

state -

initGroup -

CreateServiceName

public CreateServiceName(java.lang.String name,
                         java.lang.String state,
                         ReconfigurationConfig.ReconfigureUponActivesChange policy)

Parameters:

name -

state -

policy -

CreateServiceName

public CreateServiceName(java.lang.String name,
                         java.lang.String state,
                         java.util.Set<java.net.InetSocketAddress> initGroup,
                         ReconfigurationConfig.ReconfigureUponActivesChange policy)

A constructor to specify both an initial group and a policy for reconfiguration upon addition or deletion of active replicas.

Parameters:

name -

state -

initGroup -

policy -

CreateServiceName

public CreateServiceName(java.net.InetSocketAddress initiator,
                         java.lang.String name,
                         int epochNumber,
                         java.lang.String state,
                         java.util.Map<java.lang.String,java.lang.String> nameStates)

CreateServiceName

protected CreateServiceName(java.net.InetSocketAddress initiator,
                            java.lang.String name,
                            int epochNumber,
                            java.lang.String state)

Parameters:

initiator -

name -

epochNumber -

state -

CreateServiceName

public CreateServiceName(java.net.InetSocketAddress initiator,
                         java.lang.String name,
                         int epochNumber,
                         java.lang.String state,
                         java.net.InetSocketAddress myReceiver)

For internal use only.

Parameters:

initiator -

name -

epochNumber -

state -

myReceiver -

CreateServiceName

public CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates)

Parameters:

nameStates -

CreateServiceName

public CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates,
                         ReconfigurationConfig.ReconfigureUponActivesChange policy)

Parameters:

nameStates -

policy -

CreateServiceName

public CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates,
                         CreateServiceName create)

FIXME: need to document the reliance on the consistent ordering of the head element in nameStates.

Parameters:

nameStates -

create -

CreateServiceName

public CreateServiceName(java.util.Map<java.lang.String,java.lang.String> nameStates,
                         java.util.Set<java.lang.String> failedCreates,
                         CreateServiceName create)

Parameters:

nameStates -

failedCreates -

create -

CreateServiceName

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

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

CreateServiceName

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

Parameters:

json -

Throws:

org.json.JSONException

Method Detail

getHeadOnly

public CreateServiceName getHeadOnly()

Returns:

thiswith only head name and state.

toJSONObjectImpl

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

Overrides:

toJSONObjectImpl in class ClientReconfigurationPacket

Throws:

org.json.JSONException

isBatched

public boolean isBatched()

Returns:

True if this is a batched create request or response.

getInitGroup

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

Returns the initGroup specified in this message.

Returns:

getNameStateJSONArray

protected static org.json.JSONArray getNameStateJSONArray(java.util.Map<java.lang.String,java.lang.String> nameStates)
                                                   throws org.json.JSONException

Throws:

org.json.JSONException

getNameStateMap

protected static java.util.Map<java.lang.String,java.lang.String> getNameStateMap(org.json.JSONObject json)
                                                                           throws org.json.JSONException

Throws:

org.json.JSONException

getInitialState

public java.lang.String getInitialState()

Returns:

Initial state.

getNameStates

public java.util.Map<java.lang.String,java.lang.String> getNameStates()

Returns:

Name, state tuple map.

size

public int size()

Returns:

Number of creates in this request or respose.

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 ClientReconfigurationPacket

Returns:

A pretty-print summary.

makeCreateNameRequest

public static CreateServiceName[] makeCreateNameRequest(java.util.Map<java.lang.String,java.lang.String> nameStates,
                                                        int batchSize)

Parameters:

nameStates -

batchSize -

Returns:

Array of batched CreateServiceName requests.

makeCreateNameRequest

public static CreateServiceName[] makeCreateNameRequest(java.util.Map<java.lang.String,java.lang.String> nameStates,
                                                        int batchSize,
                                                        java.util.Set<java.lang.String> reconfigurators)

Parameters:

nameStates -

batchSize -

reconfigurators -

Returns:

Array of batched CreateServiceName requests.

getReconfigureUponActivesChangePolicy

public ReconfigurationConfig.ReconfigureUponActivesChange getReconfigureUponActivesChangePolicy()

Returns:

ReconfigurationConfig.ReconfigureUponActivesChange policy