|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jets3t.service.utils.gatekeeper.SignatureRequest
public class SignatureRequest
Represents a signature request - that is, a request that a Gatekeeper allow a specific operation (signature type) on a specific object in S3. The operations that may be requested are: get, head, put.
Field Summary | |
---|---|
static java.lang.String |
SIGNATURE_TYPE_ACL_LOOKUP
|
static java.lang.String |
SIGNATURE_TYPE_ACL_UPDATE
|
static java.lang.String |
SIGNATURE_TYPE_DELETE
|
static java.lang.String |
SIGNATURE_TYPE_GET
|
static java.lang.String |
SIGNATURE_TYPE_HEAD
|
static java.lang.String |
SIGNATURE_TYPE_PUT
|
Constructor Summary | |
---|---|
SignatureRequest()
Constructs an empty signature request. |
|
SignatureRequest(java.lang.String signatureType,
java.lang.String objectKey)
Constructs a signature request for an operation on a specific object key. |
Method Summary | |
---|---|
void |
addObjectMetadata(java.lang.String metadataName,
java.lang.String metadataValue)
Adds to the object's metadata, that will be included in the Gatekeeer message. |
S3Object |
buildObject()
|
void |
declineRequest(java.lang.String reason)
Decline the request by setting the decline reason for this request - performed by a Gatekeeper service when a request has been disallowed. |
java.lang.String |
getBucketName()
|
java.lang.String |
getDeclineReason()
|
java.lang.String |
getObjectKey()
|
java.util.Map |
getObjectMetadata()
|
java.lang.String |
getSignatureType()
|
java.lang.String |
getSignedUrl()
|
boolean |
isSigned()
Returns true if this request has been allowed and includes a signed URL, false otherwise. |
void |
setBucketName(java.lang.String bucketName)
Sets the name of the bucket in which an object is stored - this is not generally required. |
void |
setObjectKey(java.lang.String objectKey)
Sets the key name of the object on which the operation will be performed. |
void |
setObjectMetadata(java.util.Map objectMetadata)
Sets the object's metadata, that will be included in the Gatekeeer message. |
void |
setSignatureType(java.lang.String signatureType)
Sets the signature type (operation) being requested for the object in this request. |
void |
signRequest(java.lang.String signedUrl)
Approve the request by setting the signed URL for this request - performed by a Gatekeeper service when a request has been allowed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SIGNATURE_TYPE_GET
public static final java.lang.String SIGNATURE_TYPE_HEAD
public static final java.lang.String SIGNATURE_TYPE_PUT
public static final java.lang.String SIGNATURE_TYPE_DELETE
public static final java.lang.String SIGNATURE_TYPE_ACL_LOOKUP
public static final java.lang.String SIGNATURE_TYPE_ACL_UPDATE
Constructor Detail |
---|
public SignatureRequest()
public SignatureRequest(java.lang.String signatureType, java.lang.String objectKey)
signatureType
- objectKey
- Method Detail |
---|
public java.lang.String getBucketName()
public void setBucketName(java.lang.String bucketName)
bucketName
- public java.lang.String getObjectKey()
public void setObjectKey(java.lang.String objectKey)
objectKey
- public java.util.Map getObjectMetadata()
public void setObjectMetadata(java.util.Map objectMetadata)
objectMetadata
- public void addObjectMetadata(java.lang.String metadataName, java.lang.String metadataValue)
metadataName
- metadataValue
- public java.lang.String getSignatureType()
public void setSignatureType(java.lang.String signatureType)
signatureType
- the operation being requested, must match one of the SIGNATURE_TYPE_xyz constants
in this class.public void signRequest(java.lang.String signedUrl)
signedUrl
- a URL signed to allow the requested operation on the S3 object.public java.lang.String getSignedUrl()
public void declineRequest(java.lang.String reason)
reason
- a short explanation for why the request was not allowed, such as "Unrecognised user".public java.lang.String getDeclineReason()
public boolean isSigned()
public S3Object buildObject()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |