org.dataone.client.impl.rest

Class HttpMultipartRestClient

java.lang.Object

org.dataone.client.impl.rest.HttpMultipartRestClient

All Implemented Interfaces:

MultipartRestClient

Direct Known Subclasses:

DefaultHttpMultipartRestClient

public class HttpMultipartRestClient
extends Object
implements MultipartRestClient

This class wraps the RestClient, adding uniform exception deserialization and the setup of SSL for standard DataONE communications.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log
protected RestClient	rc
protected org.apache.http.client.config.RequestConfig	reqConfig

Constructor Summary

Constructors

Constructor and Description
HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient, org.apache.http.client.config.RequestConfig reqConfig) Default constructor to create a new instance.
HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient, Session session, org.apache.http.client.config.RequestConfig reqConfig) Constructor to create a new instance with given session/subject.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeIdleConnections() Deprecated.
InputStream	doDeleteRequest(String url)
InputStream	doGetRequest(String url) Perform an HTTP GET request, setting the headers first and parsing /filtering exceptions to the exception stream on the response into their respective java instances.
InputStream	doGetRequest(String url, boolean allowRedirect)
org.apache.http.Header[]	doGetRequestForHeaders(String url)
org.apache.http.Header[]	doHeadRequest(String url)
InputStream	doPostRequest(String url, SimpleMultipartEntity entity)
InputStream	doPutRequest(String url, SimpleMultipartEntity entity)
HashMap<String,String>	getAddedHeaders()
org.apache.http.client.HttpClient	getHttpClient() Gets the HttpClient instance used to make the connection
String	getLatestRequestUrl() Gets the string representation of the latest http call made by the underlying RestClient
org.apache.http.client.config.RequestConfig	getRequestConfig()
void	setHeader(String name, String value)
void	setRequestConfig(org.apache.http.client.config.RequestConfig reqConfig)

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

rc

protected RestClient rc

reqConfig

protected org.apache.http.client.config.RequestConfig reqConfig

Constructor Detail

HttpMultipartRestClient

public HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient,
                       org.apache.http.client.config.RequestConfig reqConfig)

Default constructor to create a new instance. SSL is setup using the default location for the client certificate.

HttpMultipartRestClient

public HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient,
                       Session session,
                       org.apache.http.client.config.RequestConfig reqConfig)

Constructor to create a new instance with given session/subject. The session's subject is used to find the registered certificate and key

Method Detail

setRequestConfig

public void setRequestConfig(org.apache.http.client.config.RequestConfig reqConfig)

getRequestConfig

public org.apache.http.client.config.RequestConfig getRequestConfig()

getHttpClient

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

Gets the HttpClient instance used to make the connection

Returns:

getLatestRequestUrl

public String getLatestRequestUrl()

Gets the string representation of the latest http call made by the underlying RestClient

Specified by:

getLatestRequestUrl in interface MultipartRestClient

Returns:

closeIdleConnections

@Deprecated
public void closeIdleConnections()

Deprecated.

Calls closeIdleConnections on the underlying connection manager. This will effectively close all released connections managed by the connection manager.

doGetRequest

public InputStream doGetRequest(String url)
                         throws BaseException,
                                ClientSideException

Description copied from interface: MultipartRestClient

Perform an HTTP GET request, setting the headers first and parsing /filtering exceptions to the exception stream on the response into their respective java instances.

Specified by:

doGetRequest in interface MultipartRestClient

Parameters:

url - - the encoded url string

Returns:

the InputStream from the http Response

Throws:

BaseException

ClientSideException

doGetRequest

public InputStream doGetRequest(String url,
                       boolean allowRedirect)
                         throws BaseException,
                                ClientSideException

Specified by:

doGetRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doGetRequestForHeaders

public org.apache.http.Header[] doGetRequestForHeaders(String url)
                                                throws BaseException,
                                                       ClientSideException

Specified by:

doGetRequestForHeaders in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doDeleteRequest

public InputStream doDeleteRequest(String url)
                            throws BaseException,
                                   ClientSideException

Specified by:

doDeleteRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doHeadRequest

public org.apache.http.Header[] doHeadRequest(String url)
                                       throws BaseException,
                                              ClientSideException

Specified by:

doHeadRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doPutRequest

public InputStream doPutRequest(String url,
                       SimpleMultipartEntity entity)
                         throws BaseException,
                                ClientSideException

Specified by:

doPutRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doPostRequest

public InputStream doPostRequest(String url,
                        SimpleMultipartEntity entity)
                          throws BaseException,
                                 ClientSideException

Specified by:

doPostRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

setHeader

public void setHeader(String name,
             String value)

getAddedHeaders

public HashMap<String,String> getAddedHeaders()