Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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 static com.amazonaws.util.DateUtils.cloneDate;
 
 import java.util.Date;
 import java.util.Map;
 
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,
 {
     /*
      * 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<StringStringuserMetadata = new HashMap<StringString>();

    
All other (non user custom) headers such as Content-Length, Content-Type, etc.
 
     private Map<StringObjectmetadata = new HashMap<StringObject>();
 
     public static final String AES_256_SERVER_SIDE_ENCRYPTION =
             ..getAlgorithm();

    
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;
 
     public ObjectMetadata() {}
 
     private ObjectMetadata(ObjectMetadata from) {
         this. = from.userMetadata == null
             ? null
             : new HashMap<String,String>(from.userMetadata);
         // shallow clone the meata data
         this. = from.metadata == null
             ? null
            : new HashMap<StringObject>(from.metadata);
        this. = cloneDate(from.expirationTime);
        this. = from.expirationTimeRuleId;
        this. = cloneDate(from.httpExpiresDate);
        this. = from.ongoingRestore;
        this. = cloneDate(from.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.

Returns:
The custom user metadata for the associated object.
See also:
setUserMetadata(java.util.Map)
addUserMetadata(java.lang.String,java.lang.String)
    public Map<StringStringgetUserMetadata() {
        return ;
    }

    

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.

Parameters:
userMetadata The custom user-metadata for the associated object. Note that the key should not include the internal S3 HTTP header prefix.
See also:
getUserMetadata()
addUserMetadata(java.lang.String,java.lang.String)
    public void setUserMetadata(Map<StringStringuserMetadata) {
        this. = userMetadata;
    }

    
For internal use only. Sets a specific metadata header value. Not intended to be called by external code.

Parameters:
key The name of the header being set.
value The value for the header.
    public void setHeader(String keyObject value) {
        .put(keyvalue);
    }

    

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.

Parameters:
key The key for the custom user metadata entry. Note that the key should not include the internal S3 HTTP header prefix.
value The value for the custom user-metadata entry.
See also:
setUserMetadata(java.util.Map)
getUserMetadata()
    public void addUserMetadata(String keyString value) {
        this..put(keyvalue);
    }

    
For internal use only. Gets a map of the raw metadata/headers for the associated object.

Returns:
A map of the raw metadata/headers for the associated object.
    public Map<StringObjectgetRawMetadata() {
        return Collections.unmodifiableMap(new HashMap<String,Object>());
    }

    
For internal use only. Returns the raw value of the metadata/headers for the specified key.
    public Object getRawMetadataValue(String key) {
        return .get(key);
    }

    
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. Returns null if the Last-Modified header hasn't been set.
    public Date getLastModified() {
        return cloneDate((Date).get(.));
    }

    
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.

Parameters:
lastModified The date and time at which Amazon S3 last recorded a modification to the associated object.
    public void setLastModified(Date lastModified) {
        .put(.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

Returns:
The Content-Length HTTP header indicating the size of the associated object in bytes. Returns null if it hasn't been set yet.
See also:
setContentLength(long)
    public long getContentLength() {
        Long contentLength = (Long).get(.);
        if (contentLength == nullreturn 0;
        return contentLength.longValue();
    }

    
Returns the physical length of the entire object stored in S3. This is useful during, for example, a range get operation.
    public long getInstanceLength() {
        // See Content-Range in
        // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
        String contentRange = (String).get(.);
        if (contentRange != null) {
            int pos = contentRange.lastIndexOf("/");
            if (pos >= 0)
                return Long.parseLong(contentRange.substring(pos+1));
        }
        return getContentLength();
    }

    

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

Parameters:
contentLength The Content-Length HTTP header indicating the size of the associated object in bytes.
See also:
getContentLength()
    public void setContentLength(long contentLength) {
        .put(.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

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.
See also:
setContentType(java.lang.String)
    public String getContentType() {
        return (String).get(.);
    }

    

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

Parameters:
contentType The HTTP Content-Type header indicating the type of content stored in the associated S3 object.
See also:
getContentType()
    public void setContentType(String contentType) {
        .put(.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

Returns:
The HTTP Content-Encoding header. Returns null if it hasn't been set.
See also:
setContentType(java.lang.String)
    public String getContentEncoding() {
        return (String).get(.);
    }

    

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

Parameters:
encoding The HTTP Content-Encoding header, as defined in RFC 2616.
See also:
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.sec14.11
getContentType()
    public void setContentEncoding(String encoding) {
        .put(.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

Returns:
The HTTP Cache-Control header as defined in RFC 2616. Returns null if it hasn't been set.
See also:
setCacheControl(java.lang.String)
    public String getCacheControl() {
        return (String).get(.);
    }

    

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

Parameters:
cacheControl The HTTP Cache-Control header as defined in RFC 2616.
See also:
getCacheControl()
    public void setCacheControl(String cacheControl) {
        .put(.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.

Parameters:
md5Base64 The base64 encoded MD5 hash of the content for the object associated with this metadata.
See also:
getContentMD5()
    public void setContentMD5(String md5Base64) {
        if(md5Base64 == null){
            .remove(.);
        }else{
            .put(.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.

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.
See also:
setContentMD5(java.lang.String)
    public String getContentMD5() {
        return (String).get(.);
    }

    

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

Parameters:
disposition The value for the Content-Disposition header.
See also:
getContentDisposition()
    public void setContentDisposition(String disposition) {
        .put(.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

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
setCacheControl(java.lang.String)
    public String getContentDisposition() {
        return (String).get(.);
    }

    
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.
    public String getETag() {
        return (String).get(.);
    }

    
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.
    public String getVersionId() {
        return (String).get(.);
    }

    
Returns the server-side encryption algorithm when encrypting the object using AWS-managed keys .
    @Override
    public String getSSEAlgorithm() {
    }

    

Deprecated:
Replaced by getSSEAlgorithm()
    @Deprecated
    public String getServerSideEncryption() {
    }

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

Parameters:
algorithm The server-side encryption algorithm when encrypting the object using AWS-managed keys .
    @Override
    public void setSSEAlgorithm(String algorithm) {
        .put(.algorithm);
    }


    

Deprecated:
Replaced by setSSEAlgorithm(java.lang.String)
    @Deprecated
    public void setServerSideEncryption(String algorithm) {
        .put(.algorithm);
    }

    
    @Override
    public String getSSECustomerAlgorithm() {
    }

    
For internal use only. This method is only used to set the value in the object after receiving the value in a response from S3. When sending requests, use SSECustomerKey members in request objects.
    @Override
    public void setSSECustomerAlgorithm(String algorithm) {
    }

    
    @Override
    public String getSSECustomerKeyMd5() {
    }

    
For internal use only. This method is only used to set the value in the object after receiving the value in a response from S3. When sending requests, use SSECustomerKey members in request objects.
    public void setSSECustomerKeyMd5(String md5Digest) {
    }

    
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 cloneDate();
    }

    
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.

Parameters:
expirationTime The expiration time for the object.
    public void setExpirationTime(Date expirationTime) {
        this. = expirationTime;
    }

    
Returns the BucketLifecycleConfiguration rule ID for this object's expiration, or null if it doesn't expire.
    public String getExpirationTimeRuleId() {
        return ;
    }

    
Sets the BucketLifecycleConfiguration rule ID for this object's expiration

Parameters:
expirationTimeRuleId The rule ID for this object's expiration
    public void setExpirationTimeRuleId(String expirationTimeRuleId) {
        this. = 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 cloneDate();
    }

    
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.

Parameters:
restoreExpirationTime The new restore expiration time for the object.
    public void setRestoreExpirationTime(Date restoreExpirationTime) {
        this. = 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. = Boolean.valueOf(ongoingRestore);
    }


    
Returns the boolean value which indicates whether there is ongoing restore request.
    public Boolean getOngoingRestore() {
        return this.;
    }

    
Set the date when the object is no longer cacheable.
    public void setHttpExpiresDate(Date httpExpiresDate) {
        this. = httpExpiresDate;
    }

    
Returns the date when the object is no longer cacheable.
    public Date getHttpExpiresDate() {
        return cloneDate();
    }

    
Returns the value of the specified user meta datum.
    public String getUserMetaDataOf(String key) {
        return  == null ? null : .get(key);
    }

    
Returns a clone of this ObjectMetadata. Note the clone of the internal metadata is limited to a shallow copy due to the unlimited type of value in the map. Other fields can be regarded as deep clone.
    public ObjectMetadata clone() {
        return new ObjectMetadata(this);
    }

    
Returns the AWS Key Management System key id used for Server Side Encryption of the Amazon S3 object.
    public String getSSEAwsKmsKeyId() {
        return (String
                .get(.);
    }
New to GrepCode? Check out our FAQ X