org.jets3t.service.utils.signedurl

Class GatekeeperClientUtils

java.lang.Object

org.jets3t.service.utils.signedurl.GatekeeperClientUtils

public class GatekeeperClientUtils
extends java.lang.Object

Utility class to handle common operations performed by Gatekeeper client applications.

Field Summary

Fields

Modifier and Type	Field and Description
private int	connectionTimeout
private org.apache.http.client.CredentialsProvider	credentialsProvider
private java.lang.String	gatekeeperUrl
private org.apache.http.client.HttpClient	httpClientGatekeeper
private static org.apache.commons.logging.Log	log
private int	maxRetryCount
private java.lang.Exception	priorFailureException Variable to store application exceptions, so that client failure information can be included in the information provided to the Gatekeeper when uploads are retried.
private java.lang.String	userAgentDescription

Constructor Summary

Constructors

Constructor and Description
GatekeeperClientUtils(java.lang.String gatekeeperUrl, java.lang.String userAgentDescription, int maxRetryCount, int connectionTimeoutMS, org.apache.http.client.CredentialsProvider credentialsProvider)

Method Summary

Modifier and Type	Method and Description
S3Object[]	buildS3ObjectsFromSignatureRequests(SignatureRequest[] srs) Parse the data in a set of SignatureRequest objects and build the corresponding S3Objects represented by that data.
java.lang.String	getGatekeeperUrl()
private org.apache.http.client.HttpClient	initHttpConnection() Prepares objects for HTTP communications with the Gatekeeper servlet.
GatekeeperMessage	requestActionThroughGatekeeper(java.lang.String operationType, java.lang.String bucketName, S3Object[] objects, java.util.Map applicationPropertiesMap) Request permission from the Gatekeeper for a particular operation.

Methods inherited from class java.lang.Object

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

Field Detail

httpClientGatekeeper

private org.apache.http.client.HttpClient httpClientGatekeeper

log

private static final org.apache.commons.logging.Log log

priorFailureException

private java.lang.Exception priorFailureException

Variable to store application exceptions, so that client failure information can be included in the information provided to the Gatekeeper when uploads are retried.

gatekeeperUrl

private java.lang.String gatekeeperUrl

userAgentDescription

private final java.lang.String userAgentDescription

maxRetryCount

private final int maxRetryCount

connectionTimeout

private final int connectionTimeout

credentialsProvider

private org.apache.http.client.CredentialsProvider credentialsProvider

Constructor Detail

GatekeeperClientUtils

public GatekeeperClientUtils(java.lang.String gatekeeperUrl,
                             java.lang.String userAgentDescription,
                             int maxRetryCount,
                             int connectionTimeoutMS,
                             org.apache.http.client.CredentialsProvider credentialsProvider)

Parameters:

gatekeeperUrl -

userAgentDescription -

maxRetryCount -

connectionTimeoutMS -

credentialsProvider -

Method Detail

initHttpConnection

private org.apache.http.client.HttpClient initHttpConnection()

Prepares objects for HTTP communications with the Gatekeeper servlet.

Returns:

requestActionThroughGatekeeper

public GatekeeperMessage requestActionThroughGatekeeper(java.lang.String operationType,
                                                        java.lang.String bucketName,
                                                        S3Object[] objects,
                                                        java.util.Map applicationPropertiesMap)
                                                 throws org.apache.http.HttpException,
                                                        java.lang.Exception

Request permission from the Gatekeeper for a particular operation.

Parameters:

operationType -

bucketName -

objects -

applicationPropertiesMap -

Throws:

org.apache.http.HttpException

java.lang.Exception

buildS3ObjectsFromSignatureRequests

public S3Object[] buildS3ObjectsFromSignatureRequests(SignatureRequest[] srs)

Parse the data in a set of SignatureRequest objects and build the corresponding S3Objects represented by that data.

Parameters:

srs - signature requests that represent S3 objects.

Returns:

objects reconstructed from the provided signature requests.

getGatekeeperUrl

public java.lang.String getGatekeeperUrl()