edu.umass.cs.reconfiguration.reconfigurationpackets

Class ReplicableClientRequest

java.lang.Object

edu.umass.cs.nio.JSONPacket

edu.umass.cs.reconfiguration.reconfigurationpackets.ReplicableClientRequest

All Implemented Interfaces:

ClientRequest, Request, RequestIdentifier, Byteable, ReconfigurableRequest, ReplicableRequest, Summarizable

public class ReplicableClientRequest
extends JSONPacket
implements ReplicableRequest, ClientRequest, ReconfigurableRequest, Byteable

Author:

arun

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	CHARSET Default charset used to encode this packet to bytes.
static boolean	DEFAULT_COORDINATION_MODE

Fields inherited from class edu.umass.cs.nio.JSONPacket

PACKET_TYPE, type

Fields inherited from interface edu.umass.cs.reconfiguration.interfaces.ReconfigurableRequest

STOP

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

NO_OP

Constructor Summary

Constructors

Constructor and Description
ReplicableClientRequest(byte[] buf, AppRequestParser parser)
ReplicableClientRequest(byte[] buf, NIOHeader header, AppRequestParserBytes parser)
ReplicableClientRequest(org.json.JSONObject json, Stringifiable<?> unstringer)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.net.InetSocketAddress	getClientAddress()
int	getEpochNumber()
Request	getRequest()
Request	getRequest(AppRequestParser parser)
Request	getRequest(AppRequestParserBytes parser, NIOHeader header)
java.lang.String	getRequestAsString()
long	getRequestID() The uniqueness of this identifier across all requests to a replica group is important for safety when PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION is enabled as gigapaxos may otherwise assume that the duplicate request identifier corresponds to a retransmission and will send back the response if any corresponding to the first execution.
IntegerPacketType	getRequestType()
ClientRequest	getResponse()
java.lang.String	getServiceName()
boolean	isStop()
boolean	needsCoordination()
ReplicableClientRequest	setClientAddress(java.net.InetSocketAddress csa)
byte[]	toBytes() The implementation of this method is tied to and must be the inverse of AppRequestParser.getRequest(byte[], edu.umass.cs.nio.nioutils.NIOHeader) , i.e., invoking getRequest(request.toBytes(), header).equals(request).
protected org.json.JSONObject	toJSONObjectImpl()
java.lang.String	toString() Note: This method returns the stringified form of the underlying request.
static ReplicableClientRequest	wrap(Request request)
static ReplicableClientRequest	wrap(Request request, boolean coord)
static ReplicableClientRequest	wrap(Request request, long requestID)

Methods inherited from class edu.umass.cs.nio.JSONPacket

couldBeJSON, couldBeJSON, couldBeJSON, couldBeJSONArray, couldBeJSONObject, getPacketType, putPacketType, putPacketType, toJSONObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.umass.cs.reconfiguration.interfaces.ReplicableRequest

setNeedsCoordination

Methods inherited from interface edu.umass.cs.reconfiguration.interfaces.ReconfigurableRequest

getSummary

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

getSummary

Field Detail

DEFAULT_COORDINATION_MODE

public static final boolean DEFAULT_COORDINATION_MODE

See Also:

Constant Field Values

CHARSET

public final java.lang.String CHARSET

Default charset used to encode this packet to bytes.

See Also:

Constant Field Values

Constructor Detail

ReplicableClientRequest

public ReplicableClientRequest(byte[] buf,
                               NIOHeader header,
                               AppRequestParserBytes parser)

Parameters:

buf -

header -

parser -

ReplicableClientRequest

public ReplicableClientRequest(byte[] buf,
                               AppRequestParser parser)

Parameters:

buf -

parser -

ReplicableClientRequest

public ReplicableClientRequest(org.json.JSONObject json,
                               Stringifiable<?> unstringer)
                        throws org.json.JSONException,
                               java.io.UnsupportedEncodingException

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

java.io.UnsupportedEncodingException

Method Detail

wrap

public static ReplicableClientRequest wrap(Request request)

Parameters:

request -

Returns:

Wrapped app request from request.

wrap

public static ReplicableClientRequest wrap(Request request,
                                           long requestID)

Parameters:

request -

requestID -

Returns:

Wrapped app request from request.

wrap

public static ReplicableClientRequest wrap(Request request,
                                           boolean coord)

Parameters:

request -

coord - If true, the request will be coordinated, else it will not be coordinated. If the coord flag is specified, it determines the coordination mode even if the underlying request is a ReplicableRequest and its ReplicableRequest.needsCoordination() method returns a conflicting value.

Returns:

WrappedAppRequest from request.

getRequest

public Request getRequest(AppRequestParser parser)
                   throws java.io.UnsupportedEncodingException,
                          RequestParseException

Parameters:

parser -

Returns:

App request

Throws:

java.io.UnsupportedEncodingException

RequestParseException

getRequest

public Request getRequest()

Returns:

The underlying app request.

getRequest

public Request getRequest(AppRequestParserBytes parser,
                          NIOHeader header)
                   throws java.io.UnsupportedEncodingException,
                          RequestParseException

Parameters:

parser -

header -

Returns:

App request

Throws:

java.io.UnsupportedEncodingException

RequestParseException

getRequestType

public IntegerPacketType getRequestType()

Specified by:

getRequestType in interface Request

Returns:

The IntegerPacketType type corresponding to this request.

getServiceName

public java.lang.String getServiceName()

Specified by:

getServiceName in interface Request

Returns:

Returns the unique app-level replica-group ID.

getRequestID

public long getRequestID()

Description copied from interface: RequestIdentifier

The uniqueness of this identifier across all requests to a replica group is important for safety when PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION is enabled as gigapaxos may otherwise assume that the duplicate request identifier corresponds to a retransmission and will send back the response if any corresponding to the first execution. With PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION disabled, the uniqueness is important for liveness as duplicate request identifiers may result in the client not receiving a response for the latter request; this is because gigapaxos stores request execution callbacks indexed by the request identifier, so there must be at most one outstanding request with a given identifier for a given replica group.

Specified by:

getRequestID in interface RequestIdentifier

Returns:

A unique request identifier for this request.

getEpochNumber

public int getEpochNumber()

Specified by:

getEpochNumber in interface ReconfigurableRequest

Returns:

The epoch number.

isStop

public boolean isStop()

Specified by:

isStop in interface ReconfigurableRequest

Returns:

True if this request is a stop request.

getResponse

public ClientRequest getResponse()

Specified by:

getResponse in interface ClientRequest

Returns:

The response to be sent back to the client that issued this request. AbstractReplicaCoordinator, e.g., PaxosManager, will invoke this method immediately after Application.execute(Request) and, if the returned response is non-null, will send it back to the client that issued that request. Applications are expected to internally implement logic that sets the response at the end of Application.execute(Request) as follows:

public boolean Replicable.execute(Request request)} {
// execute request to obtain response
request.setResponse(response);
}

needsCoordination

public boolean needsCoordination()

Specified by:

needsCoordination in interface ReplicableRequest

Returns:

True if this request needs to be coordinated, false otherwise.

toJSONObjectImpl

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

Specified by:

toJSONObjectImpl in class JSONPacket

Returns:

JSONObject corresponding to fields in classes extending this class.

Throws:

org.json.JSONException

toBytes

public byte[] toBytes()

Description copied from interface: Request

The implementation of this method is tied to and must be the inverse of AppRequestParser.getRequest(byte[], edu.umass.cs.nio.nioutils.NIOHeader) , i.e., invoking getRequest(request.toBytes(), header).equals(request).

Specified by:

toBytes in interface Request

Specified by:

toBytes in interface Byteable

Returns:

byte[] serialized form of this request

setClientAddress

public ReplicableClientRequest setClientAddress(java.net.InetSocketAddress csa)

Parameters:

csa -

Returns:

this

getClientAddress

public java.net.InetSocketAddress getClientAddress()

Specified by:

getClientAddress in interface ClientRequest

Returns:

The socket address of the client that sent this request. This method is now deprecated and exists only for backwards compatibility, so it is okay for applications to not explicitly override the default implementation of this method (that simply returns null); AbstractReplicaCoordinator already knows the sending client's address anyway.

getRequestAsString

public java.lang.String getRequestAsString()

Returns:

Request as String.

toString

public java.lang.String toString()

Note: This method returns the stringified form of the underlying request. To get the stringified form of this ReplicableClientRequest, use JSONPacket.toJSONObject().toString().

Specified by:

toString in interface Request

Overrides:

toString in class JSONPacket

Returns:

Returns this request serialized as a String.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object