org.dataone.client.rest

Class RestClient

java.lang.Object

org.dataone.client.rest.RestClient

public class RestClient
extends Object

A generic client class that contains base functionality for making REST calls to remote REST servers. It is built to encapsulate the communication conventions dataONE is following but does not know about dataone objects (see HttpMultipartRestClient for that). Specifically, it requires encoding of message bodies as mime-multipart. The HttpClient can be set either in the constructor or via the setter. It is generally advised to not change the HttpClient once set.

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,String>	headers
protected org.apache.http.client.HttpClient	httpClient
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
RestClient(org.apache.http.client.HttpClient client) Default constructor to create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAddedHeaders() Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638
org.apache.http.HttpResponse	doDeleteRequest(String url, org.apache.http.client.config.RequestConfig requestConfig) send a Delete request to the resource and get the response
org.apache.http.HttpResponse	doGetRequest(String url, org.apache.http.client.config.RequestConfig requestConfig) send a GET request to the resource and get the response
org.apache.http.HttpResponse	doHeadRequest(String url, org.apache.http.client.config.RequestConfig requestConfig) send a Head request to the resource and get the response
org.apache.http.HttpResponse	doPostRequest(String url, SimpleMultipartEntity mpe, org.apache.http.client.config.RequestConfig requestConfig) send a POST request to the resource and get the response
org.apache.http.HttpResponse	doPutRequest(String url, SimpleMultipartEntity mpe, org.apache.http.client.config.RequestConfig requestConfig) send a PUT request to the resource and get the response
HashMap<String,String>	getAddedHeaders() Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638
org.apache.http.client.HttpClient	getHttpClient() Gets the DefaultHttpClient instance used to make the connection
String	getLatestRequestUrl() returns a description of the latest rest call made by this instance.
String	getLatestRequestUrl(Thread t) To support cross thread retrieval of request info, a parameterized form of this method.
void	setHeader(String name, String value) Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638
void	setHttpClient(org.apache.http.client.HttpClient httpClient) Sets the HttpClient instance used for the connection.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

httpClient

protected org.apache.http.client.HttpClient httpClient

headers

protected HashMap<String,String> headers

Constructor Detail

RestClient

public RestClient(org.apache.http.client.HttpClient client)

Default constructor to create a new instance.

Method Detail

getLatestRequestUrl

public String getLatestRequestUrl()

returns a description of the latest rest call made by this instance. In order to handle multi-threaded uses of a single RestClient, the latest call is tracked per thread, and will return the description for the latest call on that thread.

Returns:

getLatestRequestUrl

public String getLatestRequestUrl(Thread t)

To support cross thread retrieval of request info, a parameterized form of this method.

Parameters:

t -

Returns:

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Gets the DefaultHttpClient instance used to make the connection

Returns:

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

Sets the HttpClient instance used for the connection. Use with caution.

Parameters:

httpClient -

setHeader

@Deprecated
public void setHeader(String name,
                        String value)

Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638

adds or replaces a header with the provided key and value to the RestClient instance to be used for all subsequent http requests (added to each HttpRequest). Not thread-safe, so will affect all future request invocations.

Parameters:

name -

value -

getAddedHeaders

@Deprecated
public HashMap<String,String> getAddedHeaders()

Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638

returns a Map of the headers added via setHeader(..)

Returns:

clearAddedHeaders

@Deprecated
public void clearAddedHeaders()

Deprecated. As of release 2.1, due to thread safety issues. Use an HttpRequestInterceptor added to the HttpClient build time, as shown in https://redmine.dataone.org/issues/7638

clears the map of added headers. Not thread-aware, so will affect all request invocations.

doGetRequest

public org.apache.http.HttpResponse doGetRequest(String url,
                                        org.apache.http.client.config.RequestConfig requestConfig)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 IOException

send a GET request to the resource and get the response

Throws:

IOException

org.apache.http.client.ClientProtocolException

doHeadRequest

public org.apache.http.HttpResponse doHeadRequest(String url,
                                         org.apache.http.client.config.RequestConfig requestConfig)
                                           throws org.apache.http.client.ClientProtocolException,
                                                  IOException

send a Head request to the resource and get the response

Throws:

IOException

org.apache.http.client.ClientProtocolException

doDeleteRequest

public org.apache.http.HttpResponse doDeleteRequest(String url,
                                           org.apache.http.client.config.RequestConfig requestConfig)
                                             throws org.apache.http.client.ClientProtocolException,
                                                    IOException

send a Delete request to the resource and get the response

Throws:

IOException

org.apache.http.client.ClientProtocolException

doPostRequest

public org.apache.http.HttpResponse doPostRequest(String url,
                                         SimpleMultipartEntity mpe,
                                         org.apache.http.client.config.RequestConfig requestConfig)
                                           throws org.apache.http.client.ClientProtocolException,
                                                  IOException

send a POST request to the resource and get the response

Throws:

IOException

org.apache.http.client.ClientProtocolException

doPutRequest

public org.apache.http.HttpResponse doPutRequest(String url,
                                        SimpleMultipartEntity mpe,
                                        org.apache.http.client.config.RequestConfig requestConfig)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 IOException

send a PUT request to the resource and get the response

Throws:

IOException

org.apache.http.client.ClientProtocolException