org.dataone.client.rest

Interface MultipartRestClient

All Known Implementing Classes:

DefaultHttpMultipartRestClient, HttpMultipartRestClient

public interface MultipartRestClient

The primary interface to use when constructing DataONE API requests. It encapsulates the requirements for RESTful services and use of Mime Multipart packaging of POST and PUT requests, as well as use of DataONE exception types. IMPORTANT: Users are responsible for closing the input streams returned by method implementations.

Author:

rnahf

Method Summary

Modifier and Type	Method and Description
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)
String	getLatestRequestUrl()
X509Session	getSession()

Method Detail

doGetRequest

InputStream doGetRequest(String url,
                         Integer timeoutMillisecs)
                  throws BaseException,
                         ClientSideException

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:

BaseException

ClientSideException

doGetRequest

InputStream doGetRequest(String url,
                         Integer timeoutMillisecs,
                         boolean followRedirect)
                  throws BaseException,
                         ClientSideException

Throws:

BaseException

ClientSideException

doGetRequestForHeaders

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

Throws:

BaseException

ClientSideException

doDeleteRequest

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

Throws:

BaseException

ClientSideException

doHeadRequest

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

Throws:

BaseException

ClientSideException

doPutRequest

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

Throws:

BaseException

ClientSideException

doPostRequest

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

Throws:

BaseException

ClientSideException

getLatestRequestUrl

String getLatestRequestUrl()

getSession

X509Session getSession()