com.amazonaws.services.s3.model.transform

Class XmlResponsesSaxParser.CopyObjectResultHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser.CopyObjectResultHandler

All Implemented Interfaces:

ObjectExpirationResult, S3RequesterChargedResult, S3VersionResult, ServerSideEncryptionResult, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Enclosing class:

XmlResponsesSaxParser

public static class XmlResponsesSaxParser.CopyObjectResultHandler
extends org.xml.sax.helpers.DefaultHandler
implements ObjectExpirationResult, S3RequesterChargedResult, S3VersionResult

Constructor Summary

Constructors

Constructor and Description
CopyObjectResultHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	atTopLevel()
void	characters(char[] ch, int start, int length)
protected void	doEndElement(String uri, String name, String qName)
protected void	doStartElement(String uri, String name, String qName, Attributes attrs)
void	endElement(String uri, String name, String qName)
String	getErrorCode()
String	getErrorHostId()
String	getErrorMessage()
String	getErrorRequestId()
String	getETag()
Date	getExpirationTime() Returns the expiration date of the object, or null if the object is not configured to expire.
String	getExpirationTimeRuleId() Returns the bucket lifecycle configuration rule ID for the expiration of this object.
Date	getLastModified()
String	getSSEAlgorithm() Returns the server-side encryption algorithm if the object is encrypted using AWS-managed keys.
String	getSSECustomerAlgorithm() Returns the server-side encryption algorithm if the object is encrypted using customer-provided keys.
String	getSSECustomerKeyMd5() Returns the base64-encoded MD5 digest of the encryption key for server-side encryption, if the object is encrypted using customer-provided keys.
protected String	getText()
String	getVersionId() Gets the version ID of the newly copied object.
protected boolean	in(String... path)
boolean	isErrorResponse()
boolean	isRequesterCharged() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setExpirationTime(Date expirationTime) Sets the expiration date of the object.
void	setExpirationTimeRuleId(String expirationTimeRuleId) Sets the bucket lifecycle configuration rule ID for the expiration of this object.
void	setRequesterCharged(boolean isRequesterCharged) Used for conducting this operation from a Requester Pays Bucket.
void	setSSEAlgorithm(String serverSideEncryption) Sets the server-side encryption algorithm for the response.
void	setSSECustomerAlgorithm(String algorithm) Sets the server-side encryption algorithm used when encrypting the object with customer-provided keys.
void	setSSECustomerKeyMd5(String md5Digest) Sets the base64-encoded MD5 digest of the encryption key for server-side encryption.
void	setVersionId(String versionId) Sets the version ID of the newly copied object.
protected ServerSideEncryptionResult	sseResult() Used to get access to the specific server side encryption (SSE) result from the subclass.
void	startElement(String uri, String name, String qName, Attributes attrs)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyObjectResultHandler

public CopyObjectResultHandler()

Method Detail

sseResult

protected ServerSideEncryptionResult sseResult()

Used to get access to the specific server side encryption (SSE) result from the subclass.

getLastModified

public Date getLastModified()

getVersionId

public String getVersionId()

Description copied from interface: S3VersionResult

Gets the version ID of the newly copied object. This field is only present if object versioning has been enabled for the bucket the object was copied to.

Specified by:

getVersionId in interface S3VersionResult

Returns:

The version ID of the newly copied object.

See Also:

CopyObjectResult.setVersionId(String), CompleteMultipartUploadResult.getVersionId(), PutObjectResult.getVersionId()

setVersionId

public void setVersionId(String versionId)

Description copied from interface: S3VersionResult

Sets the version ID of the newly copied object.

Specified by:

setVersionId in interface S3VersionResult

Parameters:

versionId - The version ID of the newly copied object.

See Also:

CopyObjectResult.getVersionId(), CompleteMultipartUploadResult.getVersionId(), PutObjectResult.getVersionId()

getExpirationTime

public Date getExpirationTime()

Description copied from interface: ObjectExpirationResult

Returns the expiration date of the object, or null if the object is not configured to expire.

Specified by:

getExpirationTime in interface ObjectExpirationResult

setExpirationTime

public void setExpirationTime(Date expirationTime)

Description copied from interface: ObjectExpirationResult

Sets the expiration date of the object.

Specified by:

setExpirationTime in interface ObjectExpirationResult

Parameters:

expirationTime - The date the object will expire.

getExpirationTimeRuleId

public String getExpirationTimeRuleId()

Description copied from interface: ObjectExpirationResult

Returns the bucket lifecycle configuration rule ID for the expiration of this object.

Specified by:

getExpirationTimeRuleId in interface ObjectExpirationResult

See Also:

BucketLifecycleConfiguration.Rule.getId()

setExpirationTimeRuleId

public void setExpirationTimeRuleId(String expirationTimeRuleId)

Description copied from interface: ObjectExpirationResult

Sets the bucket lifecycle configuration rule ID for the expiration of this object.

Specified by:

setExpirationTimeRuleId in interface ObjectExpirationResult

Parameters:

expirationTimeRuleId - The rule ID of this object's expiration configuration

getETag

public String getETag()

getErrorCode

public String getErrorCode()

getErrorHostId

public String getErrorHostId()

getErrorMessage

public String getErrorMessage()

getErrorRequestId

public String getErrorRequestId()

isErrorResponse

public boolean isErrorResponse()

isRequesterCharged

public boolean isRequesterCharged()

Description copied from interface: S3RequesterChargedResult

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket

Specified by:

isRequesterCharged in interface S3RequesterChargedResult

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

setRequesterCharged

public void setRequesterCharged(boolean isRequesterCharged)

Description copied from interface: S3RequesterChargedResult

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for conducting the operation from the bucket.

If a bucket is enabled for Requester Pays, then any attempt of operation from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Specified by:

setRequesterCharged in interface S3RequesterChargedResult

Parameters:

isRequesterCharged - Indicates requester is charged for this operation.

doStartElement

protected void doStartElement(String uri,
                              String name,
                              String qName,
                              Attributes attrs)

doEndElement

protected void doEndElement(String uri,
                            String name,
                            String qName)

getSSEAlgorithm

public final String getSSEAlgorithm()

Description copied from interface: ServerSideEncryptionResult

Returns the server-side encryption algorithm if the object is encrypted using AWS-managed keys. Otherwise returns null.

Specified by:

getSSEAlgorithm in interface ServerSideEncryptionResult

setSSEAlgorithm

public final void setSSEAlgorithm(String serverSideEncryption)

Description copied from interface: ServerSideEncryptionResult

Sets the server-side encryption algorithm for the response.

Specified by:

setSSEAlgorithm in interface ServerSideEncryptionResult

Parameters:

serverSideEncryption - The server-side encryption algorithm for the response.

getSSECustomerAlgorithm

public final String getSSECustomerAlgorithm()

Description copied from interface: ServerSideEncryptionResult

Returns the server-side encryption algorithm if the object is encrypted using customer-provided keys. Otherwise returns null.

Specified by:

getSSECustomerAlgorithm in interface ServerSideEncryptionResult

setSSECustomerAlgorithm

public final void setSSECustomerAlgorithm(String algorithm)

Description copied from interface: ServerSideEncryptionResult

Sets the server-side encryption algorithm used when encrypting the object with customer-provided keys.

Specified by:

setSSECustomerAlgorithm in interface ServerSideEncryptionResult

Parameters:

algorithm - The server-side encryption algorithm used when encrypting the object with customer-provided keys.

getSSECustomerKeyMd5

public final String getSSECustomerKeyMd5()

Description copied from interface: ServerSideEncryptionResult

Returns the base64-encoded MD5 digest of the encryption key for server-side encryption, if the object is encrypted using customer-provided keys. Otherwise returns null.

Specified by:

getSSECustomerKeyMd5 in interface ServerSideEncryptionResult

setSSECustomerKeyMd5

public final void setSSECustomerKeyMd5(String md5Digest)

Description copied from interface: ServerSideEncryptionResult

Sets the base64-encoded MD5 digest of the encryption key for server-side encryption.

Specified by:

setSSECustomerKeyMd5 in interface ServerSideEncryptionResult

Parameters:

md5Digest - The base64-encoded MD5 digest of the encryption key for server-side encryption.

startElement

public final void startElement(String uri,
                               String name,
                               String qName,
                               Attributes attrs)

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public final void endElement(String uri,
                             String name,
                             String qName)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

public final void characters(char[] ch,
                             int start,
                             int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

getText

protected final String getText()

atTopLevel

protected final boolean atTopLevel()

in

protected final boolean in(String... path)

Parameters:

path - Path to test

Returns:

True if the path provided is the same as the current context. False otherwise