org.dataone.client

Class RestClient

java.lang.Object

org.dataone.client.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 D1RestClient for that). Specifically, it requires encoding of message bodies as mime-multipart. It exposes the underlying httpClient for further configuration of the connection. ( Each RestClient has an HttpClient that is reused for all do{XX}Requests )

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAddedHeaders() clears the map of added headers
org.apache.http.HttpResponse	doDeleteRequest(String url) send a Delete request to the resource and get the response
org.apache.http.HttpResponse	doGetRequest(String url) send a GET request to the resource and get the response
org.apache.http.HttpResponse	doHeadRequest(String url) send a Head request to the resource and get the response
org.apache.http.HttpResponse	doPostRequest(String url, SimpleMultipartEntity mpe) send a POST request to the resource and get the response
org.apache.http.HttpResponse	doPutRequest(String url, SimpleMultipartEntity mpe) send a PUT request to the resource and get the response
HashMap<String,String>	getAddedHeaders() returns a Map of the headers added via setHeader(..)
org.apache.http.client.HttpClient	getHttpClient() Gets the DefaultHttpClient instance used to make the connection
String	getLatestRequestUrl()
void	setHeader(String name, String value) adds headers with the provided key and value to the RestClient instance to be used for subsequent calls
void	setHttpClient(org.apache.http.impl.client.AbstractHttpClient httpClient) Sets the AbstractHttpClient instance used for the connection.
void	setTimeouts(int milliseconds) Sets the CONNECTION_TIMEOUT and SO_TIMEOUT values for the underlying httpClient.

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

Constructor Detail

RestClient

public RestClient()

Default constructor to create a new instance.

RestClient

public RestClient(org.apache.http.impl.client.AbstractHttpClient client)

Method Detail

getLatestRequestUrl

public String getLatestRequestUrl()

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.impl.client.AbstractHttpClient httpClient)

Sets the AbstractHttpClient instance used for the connection. Use with caution. AbstractHttpClient is necessary to make use of the setParams() method.

Parameters:

httpClient -

setTimeouts

public void setTimeouts(int milliseconds)

Sets the CONNECTION_TIMEOUT and SO_TIMEOUT values for the underlying httpClient. (max delay in initial response, max delay between tcp packets, respectively). Uses the same value for both. (The default value set by the constructor is 30 seconds)

Parameters:

milliseconds -

setHeader

public void setHeader(String name,
             String value)

adds headers with the provided key and value to the RestClient instance to be used for subsequent calls

Parameters:

name -

value -

getAddedHeaders

public HashMap<String,String> getAddedHeaders()

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

Returns:

clearAddedHeaders

public void clearAddedHeaders()

clears the map of added headers

doGetRequest

public org.apache.http.HttpResponse doGetRequest(String url)
                                          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)
                                           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)
                                             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)
                                           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)
                                          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