co.codewizards.cloudstore.ls.rest.client

Class LocalServerRestClient

java.lang.Object

co.codewizards.cloudstore.ls.rest.client.LocalServerRestClient

public class LocalServerRestClient
extends Object

Client for executing REST requests.

An instance of this class is used to send data to, query data from or execute logic on the server.

If a series of multiple requests is to be sent to the server, it is recommended to keep an instance of this class (because it caches resources) and invoke multiple requests with it.

This class is thread-safe.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_SOCKET_CONNECT_TIMEOUT The key for the connection timeout used with Config.getPropertyAsInt(String, int).
static String	CONFIG_KEY_SOCKET_READ_TIMEOUT The key for the read timeout used with Config.getPropertyAsInt(String, int).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalServerRestClient() Create a new client.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.client.Invocation.Builder	assignCredentials(javax.ws.rs.client.Invocation.Builder builder)
<R> R	execute(Request<R> request)
String	getBaseUrl() Get the server's base-URL.
javax.ws.rs.client.Client	getClientOrFail() Get the Client which was previously acquired (and not yet released) on the same thread.
CredentialsProvider	getCredentialsProvider()
static LocalServerRestClient	getInstance()
Integer	getSocketConnectTimeout()
Integer	getSocketReadTimeout()
void	handleAndRethrowException(RuntimeException x)
void	registerRestComponent(Object restComponent)
void	setCredentialsProvider(CredentialsProvider credentialsProvider)
void	setSocketConnectTimeout(Integer socketConnectTimeout)
void	setSocketReadTimeout(Integer socketReadTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_SOCKET_CONNECT_TIMEOUT

public static final String CONFIG_KEY_SOCKET_CONNECT_TIMEOUT

The key for the connection timeout used with Config.getPropertyAsInt(String, int).

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

CONFIG_KEY_SOCKET_READ_TIMEOUT

public static final String CONFIG_KEY_SOCKET_READ_TIMEOUT

The key for the read timeout used with Config.getPropertyAsInt(String, int).

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

Constructor Detail

LocalServerRestClient

protected LocalServerRestClient()

Create a new client.

Method Detail

getInstance

public static LocalServerRestClient getInstance()

getSocketConnectTimeout

public Integer getSocketConnectTimeout()

setSocketConnectTimeout

public void setSocketConnectTimeout(Integer socketConnectTimeout)

getSocketReadTimeout

public Integer getSocketReadTimeout()

setSocketReadTimeout

public void setSocketReadTimeout(Integer socketReadTimeout)

getBaseUrl

public String getBaseUrl()

Get the server's base-URL.

This base-URL is the base of the LocalServerRest application. Hence all URLs beneath this base-URL are processed by the LocalServerRest application.

Returns:

the base-URL. This URL always ends with "/".

execute

public <R> R execute(Request<R> request)

assignCredentials

public javax.ws.rs.client.Invocation.Builder assignCredentials(javax.ws.rs.client.Invocation.Builder builder)

registerRestComponent

public void registerRestComponent(Object restComponent)

getClientOrFail

public javax.ws.rs.client.Client getClientOrFail()

Get the Client which was previously acquired (and not yet released) on the same thread.

Returns:

the Client. Never null.

Throws:

IllegalStateException - if there is no Client bound to the current thread.

See Also:

acquireClient()

handleAndRethrowException

public void handleAndRethrowException(RuntimeException x)

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider credentialsProvider)