co.codewizards.cloudstore.rest.client

Class CloudStoreRestClient

java.lang.Object

co.codewizards.cloudstore.rest.client.CloudStoreRestClient

public class CloudStoreRestClient
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

Constructor Summary

Constructors

Constructor and Description
CloudStoreRestClient(String url, javax.ws.rs.client.ClientBuilder clientBuilder) Create a new client.
CloudStoreRestClient(URL url, javax.ws.rs.client.ClientBuilder clientBuilder) 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()
void	handleAndRethrowException(RuntimeException x)
void	setCredentialsProvider(CredentialsProvider credentialsProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudStoreRestClient

public CloudStoreRestClient(URL url,
                            javax.ws.rs.client.ClientBuilder clientBuilder)

Create a new client.

Parameters:

url - any URL to the server. Must not be null. May be the base-URL, any repository's remote-root-URL or any URL within a remote-root-URL. The base-URL is automatically determined by cutting sub-paths, step by step.

CloudStoreRestClient

public CloudStoreRestClient(String url,
                            javax.ws.rs.client.ClientBuilder clientBuilder)

Create a new client.

Parameters:

url - any URL to the server. Must not be null. May be the base-URL, any repository's remote-root-URL or any URL within a remote-root-URL. The base-URL is automatically determined by cutting sub-paths, step by step.

Method Detail

getBaseUrl

public String getBaseUrl()

Get the server's base-URL.

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

In other words: All repository-names are located directly beneath this base-URL. The special services, too, are located directly beneath this base-URL.

For example, if the server's base-URL is "https://host.domain:8443/", then the test-service is available via "https://host.domain:8443/_test" and the repository with the alias "myrepo" is "https://host.domain:8443/myrepo".

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)

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)