org.dataone.client

Class D1RestClient

java.lang.Object

org.dataone.client.D1RestClient

public class D1RestClient
extends Object

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

Constructor Summary

Constructors

Constructor and Description
D1RestClient() Default constructor to create a new instance.
D1RestClient(org.apache.http.impl.client.AbstractHttpClient httpClient)
D1RestClient(org.apache.http.impl.client.AbstractHttpClient httpClient, Session session)
D1RestClient(Session session) Constructor to create a new instance with given session/subject.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeIdleConnections() Calls closeIdleConnections on the underlying connection manager.
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 AbstractHttpClient instance used to make the connection
String	getLatestRequestUrl() Gets the string representation of the latest http call made by the underlying RestClient
void	setHeader(String name, String value)
void	setTimeouts(int milliseconds) Sets the CONNECTION_TIMEOUT and SO_TIMEOUT values for the underlying httpClient.
void	setupSSL(Session session) Method used by the constructors to setup the connection with SSL.

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

Constructor Detail

D1RestClient

public D1RestClient()

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

D1RestClient

public D1RestClient(org.apache.http.impl.client.AbstractHttpClient httpClient)

D1RestClient

public D1RestClient(Session session)

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

D1RestClient

public D1RestClient(org.apache.http.impl.client.AbstractHttpClient httpClient,
            Session session)

Method Detail

getHttpClient

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

Gets the AbstractHttpClient 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

Returns:

closeIdleConnections

public void closeIdleConnections()

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

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 in the constructor is 30 seconds)

Parameters:

milliseconds -

setupSSL

public void setupSSL(Session session)

Method used by the constructors to setup the connection with SSL. With the current CertificateManager implementation, a null value for the session object causes the certificate at the default location to be used. If the certificate is not found, a warning will be logged and SSL scheme setup will continue.

Calling from a D1RestClient instance should override previous connection setups

Parameters:

session -

doGetRequest

public InputStream doGetRequest(String url)
                         throws AuthenticationTimeout,
                                IdentifierNotUnique,
                                InsufficientResources,
                                InvalidCredentials,
                                InvalidRequest,
                                InvalidSystemMetadata,
                                InvalidToken,
                                NotAuthorized,
                                NotFound,
                                NotImplemented,
                                ServiceFailure,
                                SynchronizationFailed,
                                UnsupportedMetadataType,
                                UnsupportedType,
                                IllegalStateException,
                                org.apache.http.client.ClientProtocolException,
                                IOException,
                                org.apache.http.HttpException,
                                VersionMismatch

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.

Parameters:

url - - the encoded url string

Returns:

the InputStream from the http Response

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedQueryType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doGetRequest

public InputStream doGetRequest(String url,
                       boolean allowRedirect)
                         throws AuthenticationTimeout,
                                IdentifierNotUnique,
                                InsufficientResources,
                                InvalidCredentials,
                                InvalidRequest,
                                InvalidSystemMetadata,
                                InvalidToken,
                                NotAuthorized,
                                NotFound,
                                NotImplemented,
                                ServiceFailure,
                                SynchronizationFailed,
                                UnsupportedMetadataType,
                                UnsupportedType,
                                IllegalStateException,
                                org.apache.http.client.ClientProtocolException,
                                IOException,
                                org.apache.http.HttpException,
                                VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doGetRequestForHeaders

public org.apache.http.Header[] doGetRequestForHeaders(String url)
                                                throws AuthenticationTimeout,
                                                       IdentifierNotUnique,
                                                       InsufficientResources,
                                                       InvalidCredentials,
                                                       InvalidRequest,
                                                       InvalidSystemMetadata,
                                                       InvalidToken,
                                                       NotAuthorized,
                                                       NotFound,
                                                       NotImplemented,
                                                       ServiceFailure,
                                                       SynchronizationFailed,
                                                       UnsupportedMetadataType,
                                                       UnsupportedType,
                                                       IllegalStateException,
                                                       org.apache.http.client.ClientProtocolException,
                                                       IOException,
                                                       org.apache.http.HttpException,
                                                       VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doDeleteRequest

public InputStream doDeleteRequest(String url)
                            throws AuthenticationTimeout,
                                   IdentifierNotUnique,
                                   InsufficientResources,
                                   InvalidCredentials,
                                   InvalidRequest,
                                   InvalidSystemMetadata,
                                   InvalidToken,
                                   NotAuthorized,
                                   NotFound,
                                   NotImplemented,
                                   ServiceFailure,
                                   SynchronizationFailed,
                                   UnsupportedMetadataType,
                                   UnsupportedType,
                                   IllegalStateException,
                                   org.apache.http.client.ClientProtocolException,
                                   IOException,
                                   org.apache.http.HttpException,
                                   VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doHeadRequest

public org.apache.http.Header[] doHeadRequest(String url)
                                       throws AuthenticationTimeout,
                                              IdentifierNotUnique,
                                              InsufficientResources,
                                              InvalidCredentials,
                                              InvalidRequest,
                                              InvalidSystemMetadata,
                                              InvalidToken,
                                              NotAuthorized,
                                              NotFound,
                                              NotImplemented,
                                              ServiceFailure,
                                              SynchronizationFailed,
                                              UnsupportedMetadataType,
                                              UnsupportedType,
                                              IllegalStateException,
                                              org.apache.http.client.ClientProtocolException,
                                              IOException,
                                              org.apache.http.HttpException,
                                              VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doPutRequest

public InputStream doPutRequest(String url,
                       SimpleMultipartEntity entity)
                         throws AuthenticationTimeout,
                                IdentifierNotUnique,
                                InsufficientResources,
                                InvalidCredentials,
                                InvalidRequest,
                                InvalidSystemMetadata,
                                InvalidToken,
                                NotAuthorized,
                                NotFound,
                                NotImplemented,
                                ServiceFailure,
                                SynchronizationFailed,
                                UnsupportedMetadataType,
                                UnsupportedType,
                                IllegalStateException,
                                org.apache.http.client.ClientProtocolException,
                                IOException,
                                org.apache.http.HttpException,
                                VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

doPostRequest

public InputStream doPostRequest(String url,
                        SimpleMultipartEntity entity)
                          throws AuthenticationTimeout,
                                 IdentifierNotUnique,
                                 InsufficientResources,
                                 InvalidCredentials,
                                 InvalidRequest,
                                 InvalidSystemMetadata,
                                 InvalidToken,
                                 NotAuthorized,
                                 NotFound,
                                 NotImplemented,
                                 ServiceFailure,
                                 SynchronizationFailed,
                                 UnsupportedMetadataType,
                                 UnsupportedType,
                                 IllegalStateException,
                                 org.apache.http.client.ClientProtocolException,
                                 IOException,
                                 org.apache.http.HttpException,
                                 VersionMismatch

Throws:

AuthenticationTimeout

IdentifierNotUnique

InsufficientResources

InvalidCredentials

InvalidRequest

InvalidSystemMetadata

InvalidToken

NotAuthorized

NotFound

NotImplemented

ServiceFailure

SynchronizationFailed

UnsupportedMetadataType

UnsupportedType

IllegalStateException

org.apache.http.client.ClientProtocolException

IOException

org.apache.http.HttpException

VersionMismatch

setHeader

public void setHeader(String name,
             String value)

getAddedHeaders

public HashMap<String,String> getAddedHeaders()