org.dataone.client.rest

Class HttpMultipartRestClient

java.lang.Object

org.dataone.client.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. Timeouts are converted into RequestConfigs in this class, and produced by copying the existing default one and setting connection request, connection, and socket timeouts with the supplied value.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.config.RequestConfig	baseRequestConfig
static String	DEFAULT_TIMEOUT_PARAM
static Integer	DEFAULT_TIMEOUT_VALUE
protected static org.apache.commons.logging.Log	log
protected RestClient	rc
protected X509Session	x509Session

Constructor Summary

Constructors

Constructor and Description
HttpMultipartRestClient() creates an HttpMultipartRestClient configured with the certificate in the default or set location in the CertificateManager.
HttpMultipartRestClient(AuthTokenSession authTokenSession)
HttpMultipartRestClient(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder, X509Session x509session) This constructor is used to give users flexibility in creating the HttpClient, but takes care of configuring the ConnectionManager with the X509Session parameter.
HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient, X509Session x509session) The basic constructor to implement the MultipartRestClient interface using apache HttpClient and X509Certificate.
HttpMultipartRestClient(String subjectString) creates an HttpMultipartRestClient configured with the certificate registered to the CertificateManager.
HttpMultipartRestClient(X509Session x509Session) creates an HttpMultipartRestClient configured with the certificate contained in the X509Session.

Method Summary

Modifier and Type	Method and Description
void	clearDefaultTimeout() Clears the default timeout parameter: "D1Client.http.default.timeouts.ms".
void	closeIdleConnections() Deprecated.
InputStream	doDeleteRequest(String url, Integer timeoutMillisecs)
InputStream	doGetRequest(String url, Integer timeoutMillisecs) 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, Integer timeoutMillisecs, boolean followRedirect)
org.apache.http.Header[]	doGetRequestForHeaders(String url, Integer timeoutMillisecs)
org.apache.http.Header[]	doHeadRequest(String url, Integer timeoutMillisecs)
InputStream	doPostRequest(String url, SimpleMultipartEntity entity, Integer timeoutMillisecs)
InputStream	doPutRequest(String url, SimpleMultipartEntity entity, Integer timeoutMillisecs)
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 HttpClient instance used to make the connection
String	getLatestRequestUrl() Gets the string representation of the current Thread's latest http request via this instance.
String	getLatestRequestUrl(Thread t) Gets the string representation of the specified Thread's latest http request via this instance.
X509Session	getSession()
void	setDefaultTimeout(Integer timeout) Sets the default timeout parameter: "D1Client.http.default.timeouts.ms" to the given Integer.
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 build time, as shown in https://redmine.dataone.org/issues/7638

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

baseRequestConfig

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

x509Session

protected X509Session x509Session

DEFAULT_TIMEOUT_PARAM

public static final String DEFAULT_TIMEOUT_PARAM

See Also:

Constant Field Values

DEFAULT_TIMEOUT_VALUE

public static final Integer DEFAULT_TIMEOUT_VALUE

Constructor Detail

HttpMultipartRestClient

public HttpMultipartRestClient(org.apache.http.client.HttpClient httpClient,
                               X509Session x509session)

The basic constructor to implement the MultipartRestClient interface using apache HttpClient and X509Certificate. The user needs to ensure that the X509Session (at least the Session and X509Certificate properties) are the ones used when making the HttpClient, or the X509Session is null. A null X509Session results in client-side certificate validity being skipped.

Parameters:

httpClient -

x509Session -

HttpMultipartRestClient

public HttpMultipartRestClient(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder,
                               X509Session x509session)
                        throws ClientSideException

This constructor is used to give users flexibility in creating the HttpClient, but takes care of configuring the ConnectionManager with the X509Session parameter.

Parameters:

httpClientBuilder -

x509session -

Throws:

ClientSideException

HttpMultipartRestClient

public HttpMultipartRestClient()
                        throws IOException,
                               ClientSideException

creates an HttpMultipartRestClient configured with the certificate in the default or set location in the CertificateManager.

Throws:

IOException

ClientSideException

HttpMultipartRestClient

public HttpMultipartRestClient(String subjectString)
                        throws IOException,
                               ClientSideException

creates an HttpMultipartRestClient configured with the certificate registered to the CertificateManager.

Parameters:

subjectString -

Throws:

FileNotFoundException

IOException

ClientSideException

HttpMultipartRestClient

public HttpMultipartRestClient(X509Session x509Session)
                        throws IOException,
                               ClientSideException

creates an HttpMultipartRestClient configured with the certificate contained in the X509Session.

Parameters:

x509Session -

Throws:

IOException

ClientSideException

HttpMultipartRestClient

public HttpMultipartRestClient(AuthTokenSession authTokenSession)

Method Detail

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 current Thread's latest http request via this instance.

Specified by:

getLatestRequestUrl in interface MultipartRestClient

Returns:

getLatestRequestUrl

public String getLatestRequestUrl(Thread t)

Gets the string representation of the specified Thread's latest http request via this instance.

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,
                                Integer timeoutMillisecs)
                         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,
                                Integer timeoutMillisecs,
                                boolean followRedirect)
                         throws BaseException,
                                ClientSideException

Specified by:

doGetRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doGetRequestForHeaders

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

Specified by:

doGetRequestForHeaders in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doDeleteRequest

public InputStream doDeleteRequest(String url,
                                   Integer timeoutMillisecs)
                            throws BaseException,
                                   ClientSideException

Specified by:

doDeleteRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doHeadRequest

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

Specified by:

doHeadRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doPutRequest

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

Specified by:

doPutRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

doPostRequest

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

Specified by:

doPostRequest in interface MultipartRestClient

Throws:

BaseException

ClientSideException

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 build time, as shown in https://redmine.dataone.org/issues/7638

adds or replaces a header with the provided key and value to the underlying instance to be used for subsequent http requests (added to each HttpRequest). Not thread-aware, so will affect all 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:

getSession

public X509Session getSession()

Specified by:

getSession in interface MultipartRestClient

setDefaultTimeout

public void setDefaultTimeout(Integer timeout)

Sets the default timeout parameter: "D1Client.http.default.timeouts.ms" to the given Integer. This parameter is applied to the RequestConfig if no timeout value is provided when making the API calls.

Parameters:

timeout - the number of milliseconds to wait before timing out. Determines connect timeout, connection request timeout, and socket timeout.

clearDefaultTimeout

public void clearDefaultTimeout()

Clears the default timeout parameter: "D1Client.http.default.timeouts.ms". This parameter is usually applied to the RequestConfig if no timeout value is provided when making the API calls. The default timeout value determines connect timeout, connection request timeout, and socket timeout.