org.jets3t.service.model

Class S3Object

java.lang.Object

org.jets3t.service.model.BaseStorageItem

org.jets3t.service.model.StorageObject

org.jets3t.service.model.S3Object

All Implemented Interfaces:

java.lang.Cloneable

public class S3Object
extends StorageObject
implements java.lang.Cloneable

An S3 object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	S3_VERSION_ID
static java.lang.String	SERVER_SIDE_ENCRYPTION__AES256
static java.lang.String	SERVER_SIDE_ENCRYPTION__NONE
static java.lang.String	STORAGE_CLASS_GLACIER
static java.lang.String	STORAGE_CLASS_REDUCED_REDUNDANCY
static java.lang.String	STORAGE_CLASS_STANDARD

Fields inherited from class org.jets3t.service.model.StorageObject

acl, bucketName, dataInputFile, dataInputStream, isMetadataComplete, METADATA_HEADER_HASH_MD5, METADATA_HEADER_ORIGINAL_HASH_MD5, METADATA_HEADER_SERVER_SIDE_ENCRYPTION, serverSideEncryptionAlgorithm, storageClass

Fields inherited from class org.jets3t.service.model.BaseStorageItem

METADATA_HEADER_CONTENT_DISPOSITION, METADATA_HEADER_CONTENT_ENCODING, METADATA_HEADER_CONTENT_LANGUAGE, METADATA_HEADER_CONTENT_LENGTH, METADATA_HEADER_CONTENT_MD5, METADATA_HEADER_CONTENT_TYPE, METADATA_HEADER_CREATION_DATE, METADATA_HEADER_DATE, METADATA_HEADER_ETAG, METADATA_HEADER_LAST_MODIFIED_DATE

Constructor Summary

Constructors

Constructor and Description
S3Object() Create an object without any associated information whatsoever.
S3Object(java.io.File file) Create an object representing a file.
S3Object(S3Bucket bucket, java.io.File file) Create an object representing a file.
S3Object(S3Bucket bucket, java.lang.String key) Create an object without any associated data.
S3Object(S3Bucket bucket, java.lang.String key, java.lang.String dataString) Create an object representing text data.
S3Object(java.lang.String key) Create an object without any associated data, and no associated bucket.
S3Object(java.lang.String key, byte[] data) Create an object representing binary data.
S3Object(java.lang.String key, java.lang.String dataString) Create an object representing text data.

Method Summary

Modifier and Type	Method and Description
static S3Object[]	cast(StorageObject[] objects)
java.lang.Object	clone()
java.lang.String	getVersionId()
void	setAcl(AccessControlList acl) Set the object's ACL.
void	setSHA256Hash(byte[] hash)
java.lang.String	toString()

Methods inherited from class org.jets3t.service.model.StorageObject

addAllMetadata, addMetadata, closeDataInputStream, getAcl, getBucketName, getContentDisposition, getContentEncoding, getContentLanguage, getContentLength, getContentType, getDataInputFile, getDataInputStream, getETag, getKey, getLastModifiedDate, getMd5HashAsBase64, getMd5HashAsHex, getModifiableMetadata, getServerSideEncryptionAlgorithm, getStorageClass, isDirectoryPlaceholder, isMetadataComplete, setBucketName, setContentDisposition, setContentEncoding, setContentLanguage, setContentLength, setContentType, setDataInputFile, setDataInputStream, setETag, setKey, setLastModifiedDate, setMd5Hash, setMetadataComplete, setServerSideEncryptionAlgorithm, setStorageClass, verifyData, verifyData, verifyData

Methods inherited from class org.jets3t.service.model.BaseStorageItem

addMetadata, addMetadata, addMetadata, containsMetadata, getCompleteMetadataMap, getHttpMetadata, getHttpMetadataMap, getMetadata, getMetadataCaseInsensitiveFromMap, getMetadataMap, getName, getOwner, getServiceMetadata, getServiceMetadataMap, getUserMetadata, getUserMetadataMap, isMatchingMetadataName, lookupMetadataSubsetMap, removeMetadata, replaceAllMetadata, setName, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

STORAGE_CLASS_STANDARD

public static final java.lang.String STORAGE_CLASS_STANDARD

See Also:

Constant Field Values

STORAGE_CLASS_REDUCED_REDUNDANCY

public static final java.lang.String STORAGE_CLASS_REDUCED_REDUNDANCY

See Also:

Constant Field Values

STORAGE_CLASS_GLACIER

public static final java.lang.String STORAGE_CLASS_GLACIER

See Also:

Constant Field Values

SERVER_SIDE_ENCRYPTION__NONE

public static final java.lang.String SERVER_SIDE_ENCRYPTION__NONE

SERVER_SIDE_ENCRYPTION__AES256

public static final java.lang.String SERVER_SIDE_ENCRYPTION__AES256

See Also:

Constant Field Values

S3_VERSION_ID

public static final java.lang.String S3_VERSION_ID

See Also:

Constant Field Values

Constructor Detail

S3Object

public S3Object(S3Bucket bucket,
                java.io.File file)
         throws java.security.NoSuchAlgorithmException,
                java.io.IOException

Create an object representing a file. The object is initialised with the file's name as its key, the file's content as its data, a content type based on the file's extension (see Mimetypes), and a content length matching the file's size. The file's MD5 hash value is also calculated and provided to S3, so the service can verify that no data are corrupted in transit.

NOTE: The automatic calculation of a file's MD5 hash digest as performed by this constructor could take some time for large files, or for many small ones.

Parameters:

bucket - the bucket the object belongs to, or will be placed in.

file - the file the object will represent. This file must exist and be readable.

Throws:

java.io.IOException - when an i/o error occurred reading the file

java.security.NoSuchAlgorithmException - when this JRE doesn't support the MD5 hash algorithm

S3Object

public S3Object(java.io.File file)
         throws java.security.NoSuchAlgorithmException,
                java.io.IOException

Create an object representing a file. The object is initialised with the file's name as its key, the file's content as its data, a content type based on the file's extension (see Mimetypes), and a content length matching the file's size. The file's MD5 hash value is also calculated and provided to S3, so the service can verify that no data are corrupted in transit.

NOTE: The automatic calculation of a file's MD5 hash digest as performed by this constructor could take some time for large files, or for many small ones.

Parameters:

file - the file the object will represent. This file must exist and be readable.

Throws:

java.io.IOException - when an i/o error occurred reading the file

java.security.NoSuchAlgorithmException - when this JRE doesn't support the MD5 hash algorithm

S3Object

public S3Object(S3Bucket bucket,
                java.lang.String key,
                java.lang.String dataString)
         throws java.security.NoSuchAlgorithmException,
                java.io.IOException

Create an object representing text data. The object is initialized with the given key, the given string as its data content (encoded as UTF-8), a content type of text/plain; charset=utf-8, and a content length matching the string's length. The given string's MD5 hash value is also calculated and provided to S3, so the service can verify that no data are corrupted in transit.

NOTE: The automatic calculation of the MD5 hash digest as performed by this constructor could take some time for large strings, or for many small ones.

Parameters:

bucket - the bucket the object belongs to, or will be placed in.

key - the key name for the object.

dataString - the text data the object will contain. Text data will be encoded as UTF-8. This string cannot be null.

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException - when this JRE doesn't support the MD5 hash algorithm

S3Object

public S3Object(java.lang.String key,
                java.lang.String dataString)
         throws java.security.NoSuchAlgorithmException,
                java.io.IOException

Create an object representing text data. The object is initialized with the given key, the given string as its data content (encoded as UTF-8), a content type of text/plain; charset=utf-8, and a content length matching the string's length. The given string's MD5 hash value is also calculated and provided to S3, so the service can verify that no data are corrupted in transit.

NOTE: The automatic calculation of the MD5 hash digest as performed by this constructor could take some time for large strings, or for many small ones.

Parameters:

key - the key name for the object.

dataString - the text data the object will contain. Text data will be encoded as UTF-8. This string cannot be null.

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException - when this JRE doesn't support the MD5 hash algorithm

S3Object

public S3Object(java.lang.String key,
                byte[] data)
         throws java.security.NoSuchAlgorithmException,
                java.io.IOException

Create an object representing binary data. The object is initialized with the given key, the bytes as its data content, a content type of application/octet-stream, and a content length matching the byte array's length. The MD5 hash value of the byte data is also calculated and provided to the target service, so the service can verify that no data are corrupted in transit.

Parameters:

key - the key name for the object.

data - the byte data the object will contain, cannot be null.

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException - when this JRE doesn't support the MD5 hash algorithm

S3Object

public S3Object(java.lang.String key)

Create an object without any associated data, and no associated bucket.

Parameters:

key - the key name for the object.

S3Object

public S3Object(S3Bucket bucket,
                java.lang.String key)

Create an object without any associated data.

Parameters:

bucket - the bucket the object belongs to, or will be placed in.

key - the key name for the object.

S3Object

public S3Object()

Create an object without any associated information whatsoever.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class StorageObject

setSHA256Hash

public void setSHA256Hash(byte[] hash)

setAcl

public void setAcl(AccessControlList acl)

Set the object's ACL. If a pre-canned REST ACL is used, the plain-text representation of the canned ACL is also added as a metadata header x-amz-acl.

Overrides:

setAcl in class StorageObject

Parameters:

acl -

getVersionId

public java.lang.String getVersionId()

clone

public java.lang.Object clone()

Overrides:

clone in class StorageObject

cast

public static S3Object[] cast(StorageObject[] objects)