com.solidfire.core.client

Class HttpsRequestDispatcher

java.lang.Object

com.solidfire.core.client.HttpsRequestDispatcher

All Implemented Interfaces:

RequestDispatcher, Versionable

Direct Known Subclasses:

HttpsRequestDispatcherWithoutSSLVerification

public class HttpsRequestDispatcher
extends java.lang.Object
implements RequestDispatcher

A request dispatcher for dispatching JSON-RPC encoded requests to an Element OS cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT
static int	DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
HttpsRequestDispatcher(java.net.URL endpoint) Create a dispatcher using no authentication.
HttpsRequestDispatcher(java.net.URL endpoint, java.lang.String username, java.lang.String password) Create a dispatcher using HTTP basic authentication using the supplied username and password.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	decodeResponse(java.io.InputStream response) Decodes a response stream into a string
java.lang.String	dispatchRequest(java.lang.String input) Dispatch an encoded request to the system and await some response.
java.net.URL	getEndpoint() Getter for property 'endpoint'.
int	getPort() Returns the port associated with the endpoint
java.lang.String	getVersion() Provide a version of the service
protected void	prepareConnection(javax.net.ssl.HttpsURLConnection connection) Constructs a HTTPS POST connection
void	setConnectionTimeout(int timeInMilliseconds) Sets the time to attempt to connect to a cluster.
void	setReadTimeout(int timeInMilliseconds) Sets the time to attempt to read data from a request to a cluster.
void	setTimeoutToDefault() Sets the time to attempt to connect to a cluster and the time to attempt to read data from a request to a cluster to the default settings.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

HttpsRequestDispatcher

public HttpsRequestDispatcher(java.net.URL endpoint)

Create a dispatcher using no authentication.

HttpsRequestDispatcher

public HttpsRequestDispatcher(java.net.URL endpoint,
                              java.lang.String username,
                              java.lang.String password)

Create a dispatcher using HTTP basic authentication using the supplied username and password.

Parameters:

endpoint - the hostname or IP address of the connection

username - username credential

password - password credential

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: Versionable

Provide a version of the service

Specified by:

getVersion in interface Versionable

Returns:

the version of the Element OS endpoint used in the connection

dispatchRequest

public java.lang.String dispatchRequest(java.lang.String input)
                                 throws java.io.IOException,
                                        ApiConnectionException

Dispatch an encoded request to the system and await some response. Can throw java.net.SocketTimeoutException if the connection or read timeout occurs.

Specified by:

dispatchRequest in interface RequestDispatcher

Parameters:

input - The input string to send to the remote server.

Returns:

The server's response.

Throws:

java.io.IOException - if anything went wrong on the connection side of things.

ApiConnectionException

prepareConnection

protected void prepareConnection(javax.net.ssl.HttpsURLConnection connection)

Constructs a HTTPS POST connection

Parameters:

connection - the https connection to a Element OS cluster

decodeResponse

protected java.lang.String decodeResponse(java.io.InputStream response)
                                   throws java.io.IOException

Decodes a response stream into a string

Parameters:

response - the response as a stream

Returns:

the response as a string

Throws:

java.io.IOException

setTimeoutToDefault

public void setTimeoutToDefault()

Sets the time to attempt to connect to a cluster and the time to attempt to read data from a request to a cluster to the default settings. Connection Default: 15 seconds Read Default: 60 seconds

Specified by:

setTimeoutToDefault in interface RequestDispatcher

getPort

public int getPort()

Description copied from interface: RequestDispatcher

Returns the port associated with the endpoint

Specified by:

getPort in interface RequestDispatcher

Returns:

port as int

setConnectionTimeout

public void setConnectionTimeout(int timeInMilliseconds)

Sets the time to attempt to connect to a cluster. Default: 15 seconds

Specified by:

setConnectionTimeout in interface RequestDispatcher

Parameters:

timeInMilliseconds - an int that specifies the timeout value to be used in milliseconds

setReadTimeout

public void setReadTimeout(int timeInMilliseconds)

Sets the time to attempt to read data from a request to a cluster. Default: 60 seconds

Specified by:

setReadTimeout in interface RequestDispatcher

Parameters:

timeInMilliseconds - an int that specifies the timeout value to be used in milliseconds

getEndpoint

public java.net.URL getEndpoint()

Getter for property 'endpoint'.

Returns:

Value for property 'endpoint'.