com.amazonaws.services.s3.model.ObjectMetadata Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.s3.model;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.apache.commons.codec.binary.Base64;
import com.amazonaws.services.s3.Headers;
import com.amazonaws.services.s3.internal.ObjectExpirationResult;
import com.amazonaws.services.s3.internal.ObjectRestoreResult;
import com.amazonaws.services.s3.internal.ServerSideEncryptionResult;
/**
* Represents the object metadata that is stored with Amazon S3. This includes custom
* user-supplied metadata, as well as the standard HTTP headers that Amazon S3
* sends and receives (Content-Length, ETag, Content-MD5, etc.).
*/
public class ObjectMetadata implements ServerSideEncryptionResult,
ObjectExpirationResult, ObjectRestoreResult, Cloneable
{
/*
* TODO: Might be nice to get as many of the internal use only methods out
* of here so users never even see them.
* Example: we could set the ETag header directly through the raw
* metadata map instead of having a setter for it.
*/
/**
* Custom user metadata, represented in responses with the x-amz-meta-
* header prefix
*/
private Map userMetadata;
/**
* All other (non user custom) headers such as Content-Length, Content-Type,
* etc.
*/
private Map metadata;
public static final String AES_256_SERVER_SIDE_ENCRYPTION = "AES256";
/**
* The date when the object is no longer cacheable.
*/
private Date httpExpiresDate;
/**
* The time this object will expire and be completely removed from S3, or
* null if this object will never expire.
*
* This and the expiration time rule aren't stored in the metadata map
* because the header contains both the time and the rule.
*/
private Date expirationTime;
/**
* The expiration rule id for this object.
*/
private String expirationTimeRuleId;
/**
* Boolean value indicating whether there is an ongoing request to restore
* an archived copy of this object from Amazon Glacier.
*/
private Boolean ongoingRestore;
/**
* The time at which an object that has been temporarily restored from
* Glacier will expire, and will need to be restored again in order to be
* accessed. Null if this object has not been restored from Glacier.
*/
private Date restoreExpirationTime;
/**
*
* 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.
*
*
* @return The custom user metadata for the associated object.
*
* @see ObjectMetadata#setUserMetadata(Map)
* @see ObjectMetadata#addUserMetadata(String, String)
*/
public Map getUserMetadata() {
return userMetadata;
}
/**
*
* Sets 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.
*
*
* @param userMetadata
* The custom user-metadata for the associated object. Note that
* the key should not include the internal S3 HTTP header prefix.
* @see ObjectMetadata#getUserMetadata()
* @see ObjectMetadata#addUserMetadata(String, String)
*/
public void setUserMetadata(Map userMetadata) {
this.userMetadata = userMetadata;
}
/**
* For internal use only. Sets a specific metadata header value. Not
* intended to be called by external code.
*
* @param key
* The name of the header being set.
* @param value
* The value for the header.
*/
public void setHeader(String key, Object value) {
metadata.put(key, value);
}
/**
*
* Adds the key value pair of custom user-metadata for the associated
* object. If the entry in the custom user-metadata map already contains the
* specified key, it will be replaced with these new contents.
*
*
* 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.
*
*
* 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.
*
*
* @param key
* The key for the custom user metadata entry. Note that the key
* should not include
* the internal S3 HTTP header prefix.
* @param value
* The value for the custom user-metadata entry.
*
* @see ObjectMetadata#setUserMetadata(Map)
* @see ObjectMetadata#getUserMetadata()
*/
public void addUserMetadata(String key, String value) {
this.userMetadata.put(key, value);
}
/**
* For internal use only. Gets a map of the raw metadata/headers
* for the associated object.
*
* @return A map of the raw metadata/headers for the associated object.
*/
public Map getRawMetadata() {
return Collections.unmodifiableMap(metadata);
}
/**
* 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.
*
* @return The date and time at which Amazon S3 last recorded a modification
* to the associated object. Returns null if
* the Last-Modified header hasn't been set.
*/
public Date getLastModified() {
return (Date)metadata.get(Headers.LAST_MODIFIED);
}
/**
* For internal use only. Sets the Last-Modified header value
* indicating the date and time at which Amazon S3 last recorded a
* modification to the associated object.
*
* @param lastModified
* The date and time at which Amazon S3 last recorded a
* modification to the associated object.
*/
public void setLastModified(Date lastModified) {
metadata.put(Headers.LAST_MODIFIED, lastModified);
}
/**
*
* 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
*
*
* @return The Content-Length HTTP header indicating the size of the
* associated object in bytes. Returns null
* if it hasn't been set yet.
*
* @see ObjectMetadata#setContentLength(long)
*/
public long getContentLength() {
Long contentLength = (Long)metadata.get(Headers.CONTENT_LENGTH);
if (contentLength == null) return 0;
return contentLength.longValue();
}
/**
*
* Sets 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
*
*
* @param contentLength
* The Content-Length HTTP header indicating the size of the
* associated object in bytes.
*
* @see ObjectMetadata#getContentLength()
*/
public void setContentLength(long contentLength) {
metadata.put(Headers.CONTENT_LENGTH, contentLength);
}
/**
*
* 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
*
*
* @return The HTTP Content-Type header, indicating the type of content
* stored in the associated S3 object. Returns null
* if it hasn't been
* set.
*
* @see ObjectMetadata#setContentType(String)
*/
public String getContentType() {
return (String)metadata.get(Headers.CONTENT_TYPE);
}
/**
*
* Sets the Content-Type HTTP header indicating 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
*
*
* @param contentType
* The HTTP Content-Type header indicating the type of content
* stored in the associated S3 object.
*
* @see ObjectMetadata#getContentType()
*/
public void setContentType(String contentType) {
metadata.put(Headers.CONTENT_TYPE, contentType);
}
/**
*
* 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
*
*
* @return The HTTP Content-Encoding header.
* Returns null if it hasn't been set.
*
* @see ObjectMetadata#setContentType(String)
*/
public String getContentEncoding() {
return (String)metadata.get(Headers.CONTENT_ENCODING);
}
/**
*
* Sets 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
*
*
* @param encoding
* The HTTP Content-Encoding header, as defined in RFC 2616.
*
* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
*
* @see ObjectMetadata#getContentType()
*/
public void setContentEncoding(String encoding) {
metadata.put(Headers.CONTENT_ENCODING, encoding);
}
/**
*
* 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
*
*
* @return The HTTP Cache-Control header as defined in RFC 2616.
* Returns null if
* it hasn't been set.
*
* @see ObjectMetadata#setCacheControl(String)
*/
public String getCacheControl() {
return (String)metadata.get(Headers.CACHE_CONTROL);
}
/**
*
* Sets 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
*
*
* @param cacheControl
* The HTTP Cache-Control header as defined in RFC 2616.
*
* @see ObjectMetadata#getCacheControl()
*/
public void setCacheControl(String cacheControl) {
metadata.put(Headers.CACHE_CONTROL, cacheControl);
}
/**
*
* Sets 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. If set to null,then the
* MD5 digest is removed from the metadata.
*
*
* 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.
*
*
* @param md5Base64
* The base64 encoded MD5 hash of the content for the object
* associated with this metadata.
*
* @see ObjectMetadata#getContentMD5()
*/
public void setContentMD5(String md5Base64) {
if(md5Base64 == null){
metadata.remove(Headers.CONTENT_MD5);
}else{
metadata.put(Headers.CONTENT_MD5, md5Base64);
}
}
/**
*
* 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.
*
*
* @return 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.
*
* @see ObjectMetadata#setContentMD5(String)
*/
public String getContentMD5() {
return (String)metadata.get(Headers.CONTENT_MD5);
}
/**
*
* Sets the optional Content-Disposition HTTP header, which specifies
* presentational information 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
*
*
* @param disposition
* The value for the Content-Disposition header.
*
* @see ObjectMetadata#getContentDisposition()
*/
public void setContentDisposition(String disposition) {
metadata.put(Headers.CONTENT_DISPOSITION, disposition);
}
/**
*
* 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
*
*
* @return The value of the Content-Disposition header.
* Returns null if the Content-Disposition header
* hasn't been set.
*
* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
*
* @see ObjectMetadata#setCacheControl(String)
*/
public String getContentDisposition() {
return (String)metadata.get(Headers.CONTENT_DISPOSITION);
}
/**
* 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.
*
*
* @return 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.
*/
public String getETag() {
return (String)metadata.get(Headers.ETAG);
}
/**
* 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.
*
* @return The version ID of the associated Amazon S3 object if available.
*/
public String getVersionId() {
return (String)metadata.get(Headers.S3_VERSION_ID);
}
/**
* Returns the server-side encryption algorithm for the object, or null if
* none was used.
*/
public String getServerSideEncryption() {
return (String)metadata.get(Headers.SERVER_SIDE_ENCRYPTION);
}
/**
* Sets the server-side encryption algorithm for the object.
*
* @param serverSideEncryption
* The server-side encryption algorithm for the object.
*/
public void setServerSideEncryption(String serverSideEncryption) {
metadata.put(Headers.SERVER_SIDE_ENCRYPTION, serverSideEncryption);
}
/**
* Returns the time this object will expire and be completely removed from
* S3. Returns null if this object will never expire.
*/
public Date getExpirationTime() {
return expirationTime;
}
/**
* For internal use only. This will *not* set the object's expiration time,
* and is only used to set the value in the object after receiving the value
* in a response from S3.
*
* @param expirationTime
* The expiration time for the object.
*/
public void setExpirationTime(Date expirationTime) {
this.expirationTime = expirationTime;
}
/**
* Returns the {@link BucketLifecycleConfiguration} rule ID for this
* object's expiration, or null if it doesn't expire.
*/
public String getExpirationTimeRuleId() {
return expirationTimeRuleId;
}
/**
* Sets the {@link BucketLifecycleConfiguration} rule ID for this object's
* expiration
*
* @param expirationTimeRuleId
* The rule ID for this object's expiration
*/
public void setExpirationTimeRuleId(String expirationTimeRuleId) {
this.expirationTimeRuleId = expirationTimeRuleId;
}
/**
* 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.
*/
public Date getRestoreExpirationTime() {
return restoreExpirationTime;
}
/**
* For internal use only. This will *not* set the object's restore
* expiration time, and is only used to set the value in the object after
* receiving the value in a response from S3.
*
* @param restoreExpirationTime
* The new restore expiration time for the object.
*/
public void setRestoreExpirationTime(Date restoreExpirationTime) {
this.restoreExpirationTime = restoreExpirationTime;
}
/**
* For internal use only. Sets the boolean value which indicates whether
* there is ongoing restore request. Not intended to be called by external
* code.
*/
public void setOngoingRestore(boolean ongoingRestore) {
this.ongoingRestore = Boolean.valueOf(ongoingRestore);
}
/**
* Returns the boolean value which indicates whether there is ongoing restore request.
*/
public Boolean getOngoingRestore() {
return this.ongoingRestore;
}
/**
* Set the date when the object is no longer cacheable.
*/
public void setHttpExpiresDate(Date httpExpiresDate) {
this.httpExpiresDate = httpExpiresDate;
}
/**
* Returns the date when the object is no longer cacheable.
*/
public Date getHttpExpiresDate() {
return httpExpiresDate;
}
/**
* Returns the value of the specified user meta datum.
*/
public String getUserMetaDataOf(String key) {
return userMetadata == null ? null : userMetadata.get(key);
}
public ObjectMetadata() {
userMetadata = new HashMap();
metadata = new HashMap();
}
private ObjectMetadata(ObjectMetadata from) {
// shallow clone the internal hash maps
userMetadata = from.userMetadata == null ? null : new HashMap(from.userMetadata);
metadata = from.metadata == null ? null : new HashMap(from.metadata);
this.expirationTime = from.expirationTime;
this.expirationTimeRuleId = from.expirationTimeRuleId;
this.httpExpiresDate = from.httpExpiresDate;
this.ongoingRestore = from.ongoingRestore;
this.restoreExpirationTime = from.restoreExpirationTime;
}
public ObjectMetadata clone() {
return new ObjectMetadata(this);
}
}