org.jets3t.servlets.gatekeeper.impl

Class RenameToUuidUrlSigner

java.lang.Object

org.jets3t.servlets.gatekeeper.UrlSigner

org.jets3t.servlets.gatekeeper.impl.DefaultUrlSigner

org.jets3t.servlets.gatekeeper.impl.RenameToUuidUrlSigner

public class RenameToUuidUrlSigner
extends DefaultUrlSigner

UrlSigner implementation that extends the DefaultUrlSigner class to perform some additional work - speficically this class renames the S3 objects keys based on the transaction ID.

Field Summary

Fields inherited from class org.jets3t.servlets.gatekeeper.impl.DefaultUrlSigner

credentials, s3BucketName, s3Service, secondsUntilExpiry, TRANSACTION_ID_METADATA_NAME

Constructor Summary

Constructors

Constructor and Description
RenameToUuidUrlSigner(javax.servlet.ServletConfig servletConfig) Constructs the UrlSigner with the required parameters.

Method Summary

Modifier and Type	Method and Description
protected void	updateObject(SignatureRequest signatureRequest, java.util.Properties messageProperties) Overrides the implementation in DefaultUrlProvider to do everything that class does, but also to rename objects based on the transaction ID.

Methods inherited from class org.jets3t.servlets.gatekeeper.impl.DefaultUrlSigner

signDelete, signGet, signGetAcl, signHead, signPut, signPutAcl

Methods inherited from class org.jets3t.servlets.gatekeeper.UrlSigner

calculateExpiryTime

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameToUuidUrlSigner

public RenameToUuidUrlSigner(javax.servlet.ServletConfig servletConfig)
                      throws javax.servlet.ServletException

Constructs the UrlSigner with the required parameters.

The required parameters that must be available in the servlet configuration are:

• S3BucketName: The bucket all objects are stored in (regardless of what bucket name the client provided).
• SecondsToSign: How many seconds until the signed URLs will expire
  Note: this setting must allow enough time for the operation to complete before the expiry time is reached. For example, if uploads are expected over slow connections the expiry time must be long enough for the uploads to finish otherwise the uploaded file will be rejected after it has finished uploading.

Parameters:

servletConfig -

Throws:

javax.servlet.ServletException

Method Detail

updateObject

protected void updateObject(SignatureRequest signatureRequest,
                            java.util.Properties messageProperties)
                     throws S3ServiceException

Overrides the implementation in DefaultUrlProvider to do everything that class does, but also to rename objects based on the transaction ID.

Each object is renamed to the following format:
transactionId.objectCount.objectExtension

Objects that arrive with the metadata property GatekeeperMessage.SUMMARY_DOCUMENT_METADATA_FLAG as treated as special cases, as this flag indicates that the object is an XML summary document provided by the JetS3t Uploader application. In this case, the object should not be renamed as it is already named according to the last transaction ID.

Overrides:

updateObject in class DefaultUrlSigner

Parameters:

signatureRequest -

messageProperties -

Throws:

S3ServiceException