org.mule.extension.s3.api.group

Class ObjectMetadataParameterGroup

java.lang.Object

org.mule.extension.s3.api.group.ObjectMetadataParameterGroup

All Implemented Interfaces:

Serializable

public class ObjectMetadataParameterGroup
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectMetadataParameterGroup()
ObjectMetadataParameterGroup(Map<String,String> userMetadata, LocalDateTime lastModified, Long contentLength, String contentType, String contentLanguage, String contentEncoding, String cacheControl, String contentMD5, String contentDisposition, String etag, String versionId, String sseAlgorithm, String sseCustomerAlgorithm, String sseCustomerKeyMd5, LocalDateTime expirationTime, String expirationTimeRuleId, LocalDateTime restoreExpirationTime, boolean ongoingRestore, LocalDateTime httpExpiresDate, StorageClass storageClass, String sseAwsKmsKeyId, boolean requesterCharged, String replicationStatus)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCacheControl() Gets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.
String	getContentDisposition() Gets the optional Content-Disposition HTTP header, which specifies presentation information for the object such as the recommended filename for the object to be saved as.
String	getContentEncoding() Gets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.
String	getContentLanguage() Gets the Content-Language HTTP header, which describes the natural language(s) of the intended audience for the enclosed entity.
Long	getContentLength() Gets the Content-Length HTTP header indicating the size of the associated object in bytes.
String	getContentMD5() Gets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
String	getContentType() Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object.
String	getEtag() Gets the hex encoded 128-bit MD5 digest of the associated object according to RFC 1864.
LocalDateTime	getExpirationTime()
String	getExpirationTimeRuleId()
LocalDateTime	getHttpExpiresDate()
LocalDateTime	getLastModified() Gets the value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.
String	getReplicationStatus()
LocalDateTime	getRestoreExpirationTime() Returns the time at which an object that has been temporarily restored from Amazon Glacier will expire, and will need to be restored again in order to be accessed.
String	getSseAlgorithm()
String	getSseAwsKmsKeyId()
String	getSseCustomerAlgorithm()
String	getSseCustomerKeyMd5()
StorageClass	getStorageClass()
Map<String,String>	getUserMetadata() Gets the custom user-metadata for the associated object.
String	getVersionId() Gets the version ID of the associated Amazon S3 object if available.
int	hashCode()
boolean	isOngoingRestore()
boolean	isRequesterCharged()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMetadataParameterGroup

public ObjectMetadataParameterGroup()

ObjectMetadataParameterGroup

public ObjectMetadataParameterGroup(Map<String,String> userMetadata,
                                    LocalDateTime lastModified,
                                    Long contentLength,
                                    String contentType,
                                    String contentLanguage,
                                    String contentEncoding,
                                    String cacheControl,
                                    String contentMD5,
                                    String contentDisposition,
                                    String etag,
                                    String versionId,
                                    String sseAlgorithm,
                                    String sseCustomerAlgorithm,
                                    String sseCustomerKeyMd5,
                                    LocalDateTime expirationTime,
                                    String expirationTimeRuleId,
                                    LocalDateTime restoreExpirationTime,
                                    boolean ongoingRestore,
                                    LocalDateTime httpExpiresDate,
                                    StorageClass storageClass,
                                    String sseAwsKmsKeyId,
                                    boolean requesterCharged,
                                    String replicationStatus)

Method Detail

getUserMetadata

public Map<String,String> getUserMetadata()

Gets the custom user-metadata for the associated object.

Amazon S3 can store additional metadata on objects by internally representing it as HTTP headers prefixed with "x-amz-meta-". Use user-metadata to store arbitrary metadata alongside their data in Amazon S3. When setting user metadata, callers should not include the internal "x-amz-meta-" prefix; this library will handle that for them. Likewise, when callers retrieve custom user-metadata, they will not see the "x-amz-meta-" header prefix.

User-metadata keys are case insensitive and will be returned as lowercase strings, even if they were originally specified with uppercase strings.

Note that user-metadata for an object is limited by the HTTP request header limit. All HTTP headers included in a request (including user metadata headers and other standard HTTP headers) must be less than 8KB.

Returns:

The custom user metadata for the associated object.

getLastModified

public LocalDateTime getLastModified()

Gets the value of the Last-Modified header, indicating the date and time at which Amazon S3 last recorded a modification to the associated object.

Returns:

The date and time at which Amazon S3 last recorded a modification to the associated object.

getContentLength

public Long getContentLength()

Gets the Content-Length HTTP header indicating the size of the associated object in bytes.

This field is required when uploading objects to S3, but the AWS S3 Java client will automatically set it when working directly with files. When uploading directly from a stream, set this field if possible. Otherwise the client must buffer the entire stream in order to calculate the content length before sending the data to Amazon S3.

For more information on the Content-Length HTTP header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13

Returns:

The Content-Length HTTP header indicating the size of the associated object in bytes. Returns null if it hasn't been set yet.

getContentType

public String getContentType()

Gets the Content-Type HTTP header, which indicates the type of content stored in the associated object. The value of this header is a standard MIME type.

When uploading files, the AWS S3 Java client will attempt to determine the correct content type if one hasn't been set yet. Users are responsible for ensuring a suitable content type is set when uploading streams. If no content type is provided and cannot be determined by the filename, the default content type, "application/octet-stream", will be used.

For more information on the Content-Type header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17

Returns:

The HTTP Content-Type header, indicating the type of content stored in the associated S3 object. Returns null if it hasn't been set.

getContentLanguage

public String getContentLanguage()

Gets the Content-Language HTTP header, which describes the natural language(s) of the intended audience for the enclosed entity.

For more information on the Content-Type header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17

Returns:

The HTTP Content-Language header, which describes the natural language(s) of the intended audience for the enclosed entity. Returns null if it hasn't been set.

getContentEncoding

public String getContentEncoding()

Gets the optional Content-Encoding HTTP header specifying what content encodings have been applied to the object and what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type field.

For more information on how the Content-Encoding HTTP header works, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11

Returns:

The HTTP Content-Encoding header. Returns null if it hasn't been set.

getCacheControl

public String getCacheControl()

Gets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.

For more information on how the Cache-Control HTTP header affects HTTP requests and responses, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9

Returns:

The HTTP Cache-Control header as defined in RFC 2616. Returns null if it hasn't been set.

getContentMD5

public String getContentMD5()

Gets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864. This data is used as a message integrity check to verify that the data received by Amazon S3 is the same data that the caller sent.

This field represents the base64 encoded 128-bit MD5 digest digest of an object's content as calculated on the caller's side. The ETag metadata field represents the hex encoded 128-bit MD5 digest as computed by Amazon S3.

The AWS S3 Java client will attempt to calculate this field automatically when uploading files to Amazon S3.

Returns:

The base64 encoded MD5 hash of the content for the associated object. Returns null if the MD5 hash of the content hasn't been set.

getContentDisposition

public String getContentDisposition()

Gets the optional Content-Disposition HTTP header, which specifies presentation information for the object such as the recommended filename for the object to be saved as.

For more information on how the Content-Disposition header affects HTTP client behavior, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

Returns:

The value of the Content-Disposition header. Returns null if the Content-Disposition header hasn't been set.

See Also:

http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

getEtag

public String getEtag()

Gets the hex encoded 128-bit MD5 digest of the associated object according to RFC 1864. This data is used as an integrity check to verify that the data received by the caller is the same data that was sent by Amazon S3.

This field represents the hex encoded 128-bit MD5 digest of an object's content as calculated by Amazon S3. The ContentMD5 field represents the base64 encoded 128-bit MD5 digest as calculated on the caller's side.

Returns:

The hex encoded MD5 hash of the content for the associated object as calculated by Amazon S3. Returns null if it hasn't been set yet.

getVersionId

public String getVersionId()

Gets the version ID of the associated Amazon S3 object if available. Version IDs are only assigned to objects when an object is uploaded to an Amazon S3 bucket that has object versioning enabled.

Returns:

The version ID of the associated Amazon S3 object if available.

getSseAlgorithm

public String getSseAlgorithm()

Returns:

the server-side encryption algorithm when encrypting the object using AWS-managed keys.

getSseCustomerAlgorithm

public String getSseCustomerAlgorithm()

getSseCustomerKeyMd5

public String getSseCustomerKeyMd5()

getExpirationTime

public LocalDateTime getExpirationTime()

Returns:

the time this object will expire and be completely removed from S3. Returns null if this object will never expire.

getExpirationTimeRuleId

public String getExpirationTimeRuleId()

Returns:

the rule ID for this object's expiration, or null if it doesn't expire.

getRestoreExpirationTime

public LocalDateTime getRestoreExpirationTime()

Returns the time at which an object that has been temporarily restored from Amazon Glacier will expire, and will need to be restored again in order to be accessed. Returns null if this is not a temporary copy of an object restored from Glacier.

Returns:

the time at which an object that has been temporarily restored from Amazon Glacier will expire.

isOngoingRestore

public boolean isOngoingRestore()

Returns:

The boolean value which indicates whether there is ongoing restore request.

getHttpExpiresDate

public LocalDateTime getHttpExpiresDate()

Returns:

The date when the object is no longer cacheable.

getStorageClass

public StorageClass getStorageClass()

Returns:

The storage class of the object. Returns null if the object is in STANDARD storage. See StorageClass for possible values

getSseAwsKmsKeyId

public String getSseAwsKmsKeyId()

Returns:

The AWS Key Management System key id used for Server Side Encryption of the Amazon S3 object.

isRequesterCharged

public boolean isRequesterCharged()

getReplicationStatus

public String getReplicationStatus()

Returns:

The replication status of the object if it is from a bucket that is the source or destination in a cross-region replication.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object