org.jets3t.service.utils

Class RestUtils

java.lang.Object

org.jets3t.service.utils.RestUtils

public class RestUtils
extends java.lang.Object

Utilities useful for REST/HTTP S3Service implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestUtils.ConnManagerFactory A ClientConnectionManagerFactory that creates ThreadSafeClientConnManager
static class	RestUtils.JetS3tRetryHandler
static class	RestUtils.ThreadSafeConnManager ThreadSafeConnManager is a ThreadSafeClientConnManager configured via jets3tProperties.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	HTTP_HEADER_METADATA_NAMES A list of HTTP-specific header names, that may be present in S3Objects as metadata but which should be treated as plain HTTP headers during transmission (ie not converted into S3 Object metadata items).

Constructor Summary

Constructors

Constructor and Description
RestUtils()

Method Summary

Modifier and Type	Method and Description
static long	calculateTimeAdjustmentOffset(org.apache.http.HttpResponse response) Calculates and returns a time offset value to reflect the time difference between your computer's clock and the current time according to the 'Date' header in the given HTTP response, likely provided by a service endpoint whose time you wish to treat as authoritative.
static java.util.Map<java.lang.String,java.lang.String>	convertHeadersToMap(org.apache.http.Header[] headers)
static org.apache.http.params.HttpParams	createDefaultHttpParams() Default Http parameters got from the DefaultHttpClient implementation.
static java.lang.String	encodeUrlPath(java.lang.String path, java.lang.String delimiter) Encodes a URL string but leaves a delimiter string unencoded.
static java.lang.String	encodeUrlString(java.lang.String path) Encodes a URL string, and ensures that spaces are encoded as "%20" instead of "+" to keep fussy web browsers happier.
static java.lang.String	httpGetUrlAsString(java.lang.String uri)
static org.apache.http.client.HttpClient	initHttpConnection(JetS3tRequestAuthorizer requestAuthorizer, Jets3tProperties jets3tProperties, java.lang.String userAgentDescription, org.apache.http.client.CredentialsProvider credentialsProvider) Initialises, or re-initialises, the underlying HttpConnectionManager and HttpClient objects a service will use to communicate with an AWS service.
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, Jets3tProperties jets3tProperties) Initialises this service's HTTP proxy by auto-detecting the proxy settings.
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, Jets3tProperties jets3tProperties, boolean proxyAutodetect, java.lang.String proxyHostAddress, int proxyPort, java.lang.String proxyUser, java.lang.String proxyPassword, java.lang.String proxyDomain)
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, Jets3tProperties jets3tProperties, boolean proxyAutodetect, java.lang.String proxyHostAddress, int proxyPort, java.lang.String proxyUser, java.lang.String proxyPassword, java.lang.String proxyDomain, java.lang.String endpoint)
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, Jets3tProperties jets3tProperties, java.lang.String endpoint) Initialises this service's HTTP proxy by auto-detecting the proxy settings using the given endpoint.
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, Jets3tProperties jets3tProperties, java.lang.String proxyHostAddress, int proxyPort, java.lang.String proxyUser, java.lang.String proxyPassword, java.lang.String proxyDomain) Initialises this service's HTTP proxy for authentication using the given proxy settings.
static void	initHttpProxy(org.apache.http.client.HttpClient httpClient, java.lang.String proxyHostAddress, int proxyPort, Jets3tProperties jets3tProperties) Initialises this service's HTTP proxy with the given proxy settings.
static java.lang.String	makeServiceCanonicalString(java.lang.String method, java.lang.String resource, java.util.Map<java.lang.String,java.lang.Object> headersMap, java.lang.String expires, java.lang.String headerPrefix, java.util.List<java.lang.String> serviceResourceParameterNames) Calculate the canonical string for a REST/HTTP request to a storage service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_HEADER_METADATA_NAMES

public static final java.util.List<java.lang.String> HTTP_HEADER_METADATA_NAMES

A list of HTTP-specific header names, that may be present in S3Objects as metadata but which should be treated as plain HTTP headers during transmission (ie not converted into S3 Object metadata items). All items in this list are in lower case.

This list includes the items:

Unchanged metadata names
content-type
content-md5
content-length
content-language
expires
cache-control
content-disposition
content-encoding

Constructor Detail

RestUtils

public RestUtils()

Method Detail

encodeUrlString

public static java.lang.String encodeUrlString(java.lang.String path)

Encodes a URL string, and ensures that spaces are encoded as "%20" instead of "+" to keep fussy web browsers happier.

Parameters:

path -

Returns:

encoded URL.

encodeUrlPath

public static java.lang.String encodeUrlPath(java.lang.String path,
                                             java.lang.String delimiter)

Encodes a URL string but leaves a delimiter string unencoded. Spaces are encoded as "%20" instead of "+".

Parameters:

path -

delimiter -

Returns:

encoded URL string.

makeServiceCanonicalString

public static java.lang.String makeServiceCanonicalString(java.lang.String method,
                                                          java.lang.String resource,
                                                          java.util.Map<java.lang.String,java.lang.Object> headersMap,
                                                          java.lang.String expires,
                                                          java.lang.String headerPrefix,
                                                          java.util.List<java.lang.String> serviceResourceParameterNames)

Calculate the canonical string for a REST/HTTP request to a storage service. When expires is non-null, it will be used instead of the Date header.

initHttpConnection

public static org.apache.http.client.HttpClient initHttpConnection(JetS3tRequestAuthorizer requestAuthorizer,
                                                                   Jets3tProperties jets3tProperties,
                                                                   java.lang.String userAgentDescription,
                                                                   org.apache.http.client.CredentialsProvider credentialsProvider)

Initialises, or re-initialises, the underlying HttpConnectionManager and HttpClient objects a service will use to communicate with an AWS service. If proxy settings are specified in this service's Jets3tProperties object, these settings will also be passed on to the underlying objects.

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 Jets3tProperties jets3tProperties)

Initialises this service's HTTP proxy by auto-detecting the proxy settings.

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 Jets3tProperties jets3tProperties,
                                 java.lang.String endpoint)

Initialises this service's HTTP proxy by auto-detecting the proxy settings using the given endpoint.

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 java.lang.String proxyHostAddress,
                                 int proxyPort,
                                 Jets3tProperties jets3tProperties)

Initialises this service's HTTP proxy with the given proxy settings.

Parameters:

proxyHostAddress -

proxyPort -

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 Jets3tProperties jets3tProperties,
                                 java.lang.String proxyHostAddress,
                                 int proxyPort,
                                 java.lang.String proxyUser,
                                 java.lang.String proxyPassword,
                                 java.lang.String proxyDomain)

Initialises this service's HTTP proxy for authentication using the given proxy settings.

Parameters:

proxyHostAddress -

proxyPort -

proxyUser -

proxyPassword -

proxyDomain - if a proxy domain is provided, an NTCredentials credential provider will be used. If the proxy domain is null, a UsernamePasswordCredentials credentials provider will be used.

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 Jets3tProperties jets3tProperties,
                                 boolean proxyAutodetect,
                                 java.lang.String proxyHostAddress,
                                 int proxyPort,
                                 java.lang.String proxyUser,
                                 java.lang.String proxyPassword,
                                 java.lang.String proxyDomain)

Parameters:

httpClient -

proxyAutodetect -

proxyHostAddress -

proxyPort -

proxyUser -

proxyPassword -

proxyDomain -

initHttpProxy

public static void initHttpProxy(org.apache.http.client.HttpClient httpClient,
                                 Jets3tProperties jets3tProperties,
                                 boolean proxyAutodetect,
                                 java.lang.String proxyHostAddress,
                                 int proxyPort,
                                 java.lang.String proxyUser,
                                 java.lang.String proxyPassword,
                                 java.lang.String proxyDomain,
                                 java.lang.String endpoint)

Parameters:

httpClient -

proxyAutodetect -

proxyHostAddress -

proxyPort -

proxyUser -

proxyPassword -

proxyDomain -

endpoint -

calculateTimeAdjustmentOffset

public static long calculateTimeAdjustmentOffset(org.apache.http.HttpResponse response)
                                          throws java.text.ParseException

Calculates and returns a time offset value to reflect the time difference between your computer's clock and the current time according to the 'Date' header in the given HTTP response, likely provided by a service endpoint whose time you wish to treat as authoritative. Ideally you should not rely on this method to overcome clock-related disagreements between your computer and a service endpoint. If you computer is set to update its clock periodically and has the correct timezone setting you should never have to resort to this work-around.

Throws:

java.text.ParseException

convertHeadersToMap

public static java.util.Map<java.lang.String,java.lang.String> convertHeadersToMap(org.apache.http.Header[] headers)

createDefaultHttpParams

public static org.apache.http.params.HttpParams createDefaultHttpParams()

Default Http parameters got from the DefaultHttpClient implementation.

Returns:

Default HTTP connection parameters

httpGetUrlAsString

public static java.lang.String httpGetUrlAsString(java.lang.String uri)
                                           throws org.apache.http.client.ClientProtocolException,
                                                  java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException