edu.umass.cs.reconfiguration

Class ReconfigurableAppClientAsync<V>

java.lang.Object

edu.umass.cs.reconfiguration.ReconfigurableAppClientAsync<V>

Type Parameters:

V -

All Implemented Interfaces:

AppRequestParser, AppRequestParserBytes, GigaPaxosClient<V>

Direct Known Subclasses:

NoopAppClient

public abstract class ReconfigurableAppClientAsync<V>
extends java.lang.Object
implements GigaPaxosClient<V>, AppRequestParser

Author:

arun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ReconfigurableAppClientAsync.BlockingRequestCallback [ *
static class	ReconfigurableAppClientAsync.ReconfigurationException

Field Summary

Fields

Modifier and Type	Field and Description
static long	CONNECTIVITY_CHECK_TIMEOUT Default connectivity check timeout.
static long	DEFAULT_GC_TIMEOUT The default timeout for ClientRequest as well as ClientReconfigurationPacket requests.

Constructor Summary

Constructors

Constructor and Description
ReconfigurableAppClientAsync()
ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators)
ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators, boolean checkConnectivity)
ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators, SSLDataProcessingWorker.SSL_MODES sslMode, int clientPortOffset, boolean checkConnectivity) The constructor specifies the default set of reconfigurators.

Method Summary

Modifier and Type	Method and Description
void	checkConnectivity() A connectivity check with every known reconfigurator each with a default timeout of CONNECTIVITY_CHECK_TIMEOUT.
protected boolean	checkConnectivity(long timeout, java.net.InetSocketAddress address) Connectivity check with reconfigurator address that will block for up to timeout duration.
protected boolean	checkConnectivity(long attemptTimeout, int numAttempts, java.net.InetSocketAddress address) Connectivity check that will be attempted up to numAttempts times each with a timeout of attemptTimeout with the reconfigurator address.
void	close()
ReconfigurableAppClientAsync<V>	enableJSONPackets() If true, the app will only be handed JSON formatted packets via getJSONRequest(), not via AppRequestParser.getRequest(String).
java.util.Set<java.net.InetSocketAddress>	getDefaultServers()
protected java.lang.String	getLabel()
protected static void	getMaxOutstandingCRPRequests(int n)
Request	getRequestFromJSON(org.json.JSONObject json)
static void	main(java.lang.String[] args)
void	sendReconfigurationRequest(ReconfigurationPacket.PacketType type, java.lang.String name, java.lang.String initialState, RequestCallback callback)
RequestFuture<ClientReconfigurationPacket>	sendRequest(ClientReconfigurationPacket request)
ClientReconfigurationPacket	sendRequest(ClientReconfigurationPacket request, long timeout)
RequestFuture<ClientReconfigurationPacket>	sendRequest(ClientReconfigurationPacket request, RequestCallback callback) This method exists for backwards compatibility and is slated for deprecation.
RequestFuture<V>	sendRequest(ClientRequest request, Callback<Request,V> callback)
RequestFuture<V>	sendRequest(ClientRequest request, Callback<Request,V> callback, NearestServerSelector redirector) Sends request to the nearest server as determined by redirector, an interface that returns the nearest server from a set of server addresses.
Request	sendRequest(ClientRequest request, java.net.InetSocketAddress server)
RequestFuture<V>	sendRequest(ClientRequest request, java.net.InetSocketAddress server, Callback<Request,V> callback) Sends request to the specified server.
Request	sendRequest(ClientRequest request, java.net.InetSocketAddress server, long timeout)
Request	sendRequest(Request request) A blocking method to retrieve the result of executing request.
RequestFuture<V>	sendRequest(Request request, Callback<Request,V> callback) This method will convert an app request to a ReplicableClientRequest and then send the request.
Request	sendRequest(Request request, long timeout)
void	sendRequest(ServerReconfigurationPacket<?> rcPacket, RequestCallback callback) Server reconfiguration packets have to be privileged, so we authenticate them implicitly by listening for them only on the server-server MUTUAL_AUTH port.
Request	sendRequestAnycast(ClientRequest request)
RequestFuture<V>	sendRequestAnycast(ClientRequest request, Callback<Request,V> callback)
Request	sendRequestAnycast(ClientRequest request, long timeout)
void	setGCTimeout(long timeout)
protected static void	setMaxOutstandingAppRequests(int n)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getMutualAuthRequestTypes, getRequest, getRequest, getRequestTypes, getServerAuthRequestTypes

Field Detail

DEFAULT_GC_TIMEOUT

public static final long DEFAULT_GC_TIMEOUT

The default timeout for ClientRequest as well as ClientReconfigurationPacket requests.

See Also:

Constant Field Values

CONNECTIVITY_CHECK_TIMEOUT

public static final long CONNECTIVITY_CHECK_TIMEOUT

Default connectivity check timeout.

See Also:

Constant Field Values

Constructor Detail

ReconfigurableAppClientAsync

public ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators,
                                    SSLDataProcessingWorker.SSL_MODES sslMode,
                                    int clientPortOffset,
                                    boolean checkConnectivity)
                             throws java.io.IOException

The constructor specifies the default set of reconfigurators. This set may change over time, so it is the caller's responsibility to ensure that this set remains up-to-date. Some staleness however can be tolerated as reconfigurators will by design forward a request to the responsible reconfigurator if they are not responsible.

Parameters:

reconfigurators -

sslMode -

clientPortOffset -

checkConnectivity - If true, a connectivity check with at least one reconfigurator will be enforced and an exception will be thrown if unsuccessful.

Throws:

java.io.IOException

ReconfigurableAppClientAsync

public ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators)
                             throws java.io.IOException

Parameters:

reconfigurators -

Throws:

java.io.IOException

ReconfigurableAppClientAsync

public ReconfigurableAppClientAsync(java.util.Set<java.net.InetSocketAddress> reconfigurators,
                                    boolean checkConnectivity)
                             throws java.io.IOException

Parameters:

reconfigurators -

checkConnectivity -

Throws:

java.io.IOException

ReconfigurableAppClientAsync

public ReconfigurableAppClientAsync()
                             throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLabel

protected java.lang.String getLabel()

setMaxOutstandingAppRequests

protected static void setMaxOutstandingAppRequests(int n)

getMaxOutstandingCRPRequests

protected static void getMaxOutstandingCRPRequests(int n)

setGCTimeout

public final void setGCTimeout(long timeout)

Parameters:

timeout -

sendRequest

public Request sendRequest(Request request)
                    throws java.io.IOException

Description copied from interface: GigaPaxosClient

A blocking method to retrieve the result of executing request.

Specified by:

sendRequest in interface GigaPaxosClient<V>

Parameters:

request -

Returns:

The response obtained by executing this request.

Throws:

java.io.IOException

sendRequest

public Request sendRequest(Request request,
                           long timeout)
                    throws java.io.IOException

Parameters:

request -

timeout -

Returns:

The response obtained by executing this request.

Throws:

java.io.IOException

sendRequest

public RequestFuture<V> sendRequest(Request request,
                                    Callback<Request,V> callback)
                             throws java.io.IOException

This method will convert an app request to a ReplicableClientRequest and then send the request.

Specified by:

sendRequest in interface GigaPaxosClient<V>

Parameters:

request -

callback -

Returns:

True if sent successfully.

Throws:

java.io.IOException

sendRequest

public Request sendRequest(ClientRequest request,
                           java.net.InetSocketAddress server)
                    throws java.io.IOException

Parameters:

request -

server -

Returns:

The response obtained by executing request.

Throws:

java.io.IOException

sendRequest

public Request sendRequest(ClientRequest request,
                           java.net.InetSocketAddress server,
                           long timeout)
                    throws java.io.IOException

Parameters:

request -

server -

timeout -

Returns:

The response obtained by executing request.

Throws:

java.io.IOException

sendRequest

public RequestFuture<V> sendRequest(ClientRequest request,
                                    java.net.InetSocketAddress server,
                                    Callback<Request,V> callback)
                             throws java.io.IOException

Description copied from interface: GigaPaxosClient

Sends request to the specified server.

Specified by:

sendRequest in interface GigaPaxosClient<V>

Parameters:

request -

server -

callback -

Returns:

Request ID.

Throws:

java.io.IOException

sendReconfigurationRequest

public void sendReconfigurationRequest(ReconfigurationPacket.PacketType type,
                                       java.lang.String name,
                                       java.lang.String initialState,
                                       RequestCallback callback)
                                throws java.io.IOException

Parameters:

type -

name -

initialState - Used only if type is ReconfigurationPacket.PacketType.CREATE_SERVICE_NAME .

callback -

Throws:

java.io.IOException

sendRequest

public void sendRequest(ServerReconfigurationPacket<?> rcPacket,
                        RequestCallback callback)
                 throws java.io.IOException

Server reconfiguration packets have to be privileged, so we authenticate them implicitly by listening for them only on the server-server MUTUAL_AUTH port. So we subtract the offset below accordingly.

Parameters:

rcPacket -

callback -

Throws:

java.io.IOException

sendRequest

public RequestFuture<ClientReconfigurationPacket> sendRequest(ClientReconfigurationPacket request)
                                                       throws java.io.IOException,
                                                              ReconfigurableAppClientAsync.ReconfigurationException

Parameters:

request -

Returns:

ClientReconfigurationPacket response for request.

Throws:

java.io.IOException

ReconfigurableAppClientAsync.ReconfigurationException

sendRequest

public ClientReconfigurationPacket sendRequest(ClientReconfigurationPacket request,
                                               long timeout)
                                        throws java.io.IOException,
                                               ReconfigurableAppClientAsync.ReconfigurationException

Parameters:

request -

timeout - Timeout period in milliseconds; 0 means infinity.

Returns:

ClientReconfigurationPacket response for request.

Throws:

java.io.IOException

ReconfigurableAppClientAsync.ReconfigurationException

sendRequest

public RequestFuture<ClientReconfigurationPacket> sendRequest(ClientReconfigurationPacket request,
                                                              RequestCallback callback)
                                                       throws java.io.IOException

This method exists for backwards compatibility and is slated for deprecation.

Parameters:

request -

callback -

Returns:

Future for asynchronous task

Throws:

java.io.IOException

sendRequest

public RequestFuture<V> sendRequest(ClientRequest request,
                                    Callback<Request,V> callback)
                             throws java.io.IOException

Specified by:

sendRequest in interface GigaPaxosClient<V>

Parameters:

request -

callback -

Returns:

Request ID.

Throws:

java.io.IOException

sendRequestAnycast

public Request sendRequestAnycast(ClientRequest request)
                           throws java.io.IOException

Parameters:

request -

Returns:

The response obtained by executing request.

Throws:

java.io.IOException

sendRequestAnycast

public Request sendRequestAnycast(ClientRequest request,
                                  long timeout)
                           throws java.io.IOException

Parameters:

request -

timeout -

Returns:

The response obtained by executing request.

Throws:

java.io.IOException

sendRequestAnycast

public RequestFuture<V> sendRequestAnycast(ClientRequest request,
                                           Callback<Request,V> callback)
                                    throws java.io.IOException

Parameters:

request -

callback -

Returns:

Request ID of sent or enqueued request

Throws:

java.io.IOException

sendRequest

public RequestFuture<V> sendRequest(ClientRequest request,
                                    Callback<Request,V> callback,
                                    NearestServerSelector redirector)
                             throws java.io.IOException

Description copied from interface: GigaPaxosClient

Sends request to the nearest server as determined by redirector, an interface that returns the nearest server from a set of server addresses.

Specified by:

sendRequest in interface GigaPaxosClient<V>

Parameters:

request -

callback -

redirector -

Returns:

Request ID.

Throws:

java.io.IOException

checkConnectivity

protected boolean checkConnectivity(long timeout,
                                    java.net.InetSocketAddress address)

Connectivity check with reconfigurator address that will block for up to timeout duration. If address is null, the check will be performed against a random reconfigurator.

Parameters:

timeout -

address -

Returns:

checkConnectivity

protected boolean checkConnectivity(long attemptTimeout,
                                    int numAttempts,
                                    java.net.InetSocketAddress address)

Connectivity check that will be attempted up to numAttempts times each with a timeout of attemptTimeout with the reconfigurator address. If address is null, a random reconfigurator will be chosen for each attempt.

Parameters:

attemptTimeout -

numAttempts -

address -

Returns:

checkConnectivity

public void checkConnectivity()
                       throws java.io.IOException

A connectivity check with every known reconfigurator each with a default timeout of CONNECTIVITY_CHECK_TIMEOUT.

Throws:

java.io.IOException

close

public void close()

getDefaultServers

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

Returns:

The list of default servers.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRequestFromJSON

public Request getRequestFromJSON(org.json.JSONObject json)
                           throws RequestParseException

Parameters:

json -

Returns:

Request created from JSON json

Throws:

RequestParseException

enableJSONPackets

public ReconfigurableAppClientAsync<V> enableJSONPackets()

If true, the app will only be handed JSON formatted packets via getJSONRequest(), not via AppRequestParser.getRequest(String). If this method is invoked, the protected method #getJSONRequest(JSONObject) must be overridden.

Returns:

this.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Parameters:

args -

Throws:

java.io.IOException

java.lang.InterruptedException