org.jets3t.service.model

Class StorageObject

java.lang.Object

org.jets3t.service.model.BaseStorageItem

org.jets3t.service.model.StorageObject

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

GSObject, MissingStorageObject, S3Object, ThrowableBearingStorageObject

public class StorageObject
extends BaseStorageItem
implements java.lang.Cloneable

A generic storage object.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessControlList	acl
protected java.lang.String	bucketName
protected java.io.File	dataInputFile Store references to files when the object's data comes from a file, to allow for lazy opening of the file's input streams.
protected java.io.InputStream	dataInputStream
protected boolean	isMetadataComplete
static java.lang.String	METADATA_HEADER_HASH_MD5
static java.lang.String	METADATA_HEADER_ORIGINAL_HASH_MD5
static java.lang.String	METADATA_HEADER_SERVER_SIDE_ENCRYPTION
protected java.lang.String	serverSideEncryptionAlgorithm
protected java.lang.String	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
StorageObject() Create an object without any associated information whatsoever.
StorageObject(java.io.File file) Create an object representing a file.
StorageObject(java.lang.String key) Create an object without any associated data.
StorageObject(java.lang.String key, byte[] data) Create an object representing binary data.
StorageObject(java.lang.String key, java.lang.String dataString) Create an object representing text data.

Method Summary

Modifier and Type	Method and Description
void	addAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata) Add all the metadata information to the object from the provided map.
void	addMetadata(java.lang.String name, java.lang.String value) Add metadata information to the object.
java.lang.Object	clone()
void	closeDataInputStream() Closes the object's data input stream if it exists.
AccessControlList	getAcl()
java.lang.String	getBucketName()
java.lang.String	getContentDisposition()
java.lang.String	getContentEncoding()
java.lang.String	getContentLanguage()
long	getContentLength()
java.lang.String	getContentType()
java.io.File	getDataInputFile()
java.io.InputStream	getDataInputStream() Returns an input stream containing this object's data, or null if there is no data associated with the object.
java.lang.String	getETag()
java.lang.String	getKey()
java.util.Date	getLastModifiedDate()
java.lang.String	getMd5HashAsBase64()
java.lang.String	getMd5HashAsHex()
java.util.Map<java.lang.String,java.lang.Object>	getModifiableMetadata() Returns only those object metadata items that can be modified in a service.
java.lang.String	getServerSideEncryptionAlgorithm()
java.lang.String	getStorageClass()
boolean	isDirectoryPlaceholder()
boolean	isMetadataComplete()
void	setAcl(AccessControlList acl) Set the object's ACL.
void	setBucketName(java.lang.String bucketName) Set the name of the bucket this object belongs to or will be placed into.
void	setContentDisposition(java.lang.String contentDisposition) Set the content disposition of the object.
void	setContentEncoding(java.lang.String contentEncoding) Set the content encoding of this object.
void	setContentLanguage(java.lang.String contentLanguage) Set the content language of the object.
void	setContentLength(long size) Set this object's content length.
void	setContentType(java.lang.String contentType) Set the content type of the object.
void	setDataInputFile(java.io.File dataInputFile) Sets the file containing the data content to associate with this object.
void	setDataInputStream(java.io.InputStream dataInputStream) Sets an input stream containing the data content to associate with this object.
void	setETag(java.lang.String etag) Set the ETag value of the object based on information returned from the service.
void	setKey(java.lang.String key) Set the key of this object.
void	setLastModifiedDate(java.util.Date lastModifiedDate) Set this object's last modified date based on information returned from the service.
void	setMd5Hash(byte[] md5Hash) Set the MD5 hash value of this object's data.
void	setMetadataComplete(boolean isMetadataComplete) Object metadata are only complete when it is populated with all values following a HEAD or GET request.
void	setServerSideEncryptionAlgorithm(java.lang.String serverSideEncryptionAlgorithm) Set the encryption algorithm to use for server-side encryption of this object (will be unencrypted if set to null)
void	setStorageClass(java.lang.String storageClass) Set the storage class for this object.
java.lang.String	toString()
boolean	verifyData(byte[] downloadedData) Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).
boolean	verifyData(java.io.File downloadedFile) Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).
boolean	verifyData(java.io.InputStream downloadedDataStream) Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).

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

METADATA_HEADER_HASH_MD5

public static final java.lang.String METADATA_HEADER_HASH_MD5

See Also:

Constant Field Values

METADATA_HEADER_ORIGINAL_HASH_MD5

public static final java.lang.String METADATA_HEADER_ORIGINAL_HASH_MD5

See Also:

Constant Field Values

METADATA_HEADER_SERVER_SIDE_ENCRYPTION

public static final java.lang.String METADATA_HEADER_SERVER_SIDE_ENCRYPTION

See Also:

Constant Field Values

acl

protected AccessControlList acl

dataInputStream

protected transient java.io.InputStream dataInputStream

isMetadataComplete

protected boolean isMetadataComplete

bucketName

protected java.lang.String bucketName

storageClass

protected java.lang.String storageClass

serverSideEncryptionAlgorithm

protected java.lang.String serverSideEncryptionAlgorithm

dataInputFile

protected java.io.File dataInputFile

Store references to files when the object's data comes from a file, to allow for lazy opening of the file's input streams.

Constructor Detail

StorageObject

public StorageObject(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 the destination service, 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

StorageObject

public StorageObject(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 the target service, 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

StorageObject

public StorageObject(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

StorageObject

public StorageObject(java.lang.String key)

Create an object without any associated data.

Parameters:

key - the key name for the object.

StorageObject

public StorageObject()

Create an object without any associated information whatsoever.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBucketName

public java.lang.String getBucketName()

Returns:

the name of the bucket this object belongs to or will be placed into, or null if none is set.

setBucketName

public void setBucketName(java.lang.String bucketName)

Set the name of the bucket this object belongs to or will be placed into.

Parameters:

bucketName - the name for the bucket.

getDataInputStream

public java.io.InputStream getDataInputStream()
                                       throws ServiceException

Returns an input stream containing this object's data, or null if there is no data associated with the object.

If you are downloading data from a service, you should consider verifying the integrity of the data you read from this stream using one of the verifyData(InputStream) methods.

Returns:

input stream containing the object's service-side data, or null if no data.

Throws:

ServiceException

setDataInputStream

public void setDataInputStream(java.io.InputStream dataInputStream)

Sets an input stream containing the data content to associate with this object.

Note: If the data content comes from a file, use the alternate method setDataInputFile(File) which allows objects to lazily open files and avoid any Operating System limits on the number of files that may be opened simultaneously.

Note 2: This method does not calculate an MD5 hash of the input data, which means the target service will not be able to recognize if data are corrupted in transit. To allow the target service to verify data you upload, you should set the MD5 hash value of your data using setMd5Hash(byte[]).

This method will set the object's file data reference to null.

Parameters:

dataInputStream - an input stream containing the object's data.

setDataInputFile

public void setDataInputFile(java.io.File dataInputFile)

Sets the file containing the data content to associate with this object. This file will be automatically opened as an input stream only when absolutely necessary, that is when getDataInputStream() is called.

Note 2: This method does not calculate an MD5 hash of the input data, which means the target service will not be able to recognize if data are corrupted in transit. To allow the target service to verify data you upload, you should set the MD5 hash value of your data using setMd5Hash(byte[]).

This method will set the object's input stream data reference to null.

Parameters:

dataInputFile - a file containing the object's data.

getDataInputFile

public java.io.File getDataInputFile()

Returns:

Return the file that contains this object's data, if such a file has been provided. Null otherwise.

closeDataInputStream

public void closeDataInputStream()
                          throws java.io.IOException

Closes the object's data input stream if it exists.

Throws:

java.io.IOException

getETag

public java.lang.String getETag()

Returns:

the ETag value of the object as returned by the service when an object is created. The ETag value does not include quote (") characters. This value will be null if the object's ETag value is not known, such as when an object has not yet been uploaded to the service.

setETag

public void setETag(java.lang.String etag)

Set the ETag value of the object based on information returned from the service. This method should only by used by code that reads service responses.

Parameters:

etag - the ETag value as provided by the service.

getMd5HashAsHex

public java.lang.String getMd5HashAsHex()

Returns:

the hex-encoded MD5 hash of an object's data contents as stored in the JEtS3t-specific metadata item md5-hash, or null if the hash value is not available.

getMd5HashAsBase64

public java.lang.String getMd5HashAsBase64()

Returns:

the Base64-encoded MD5 hash of an object's data contents as stored in the metadata item Content-MD5, or as derived from an ETag or md5-hash hex-encoded version of the hash. Returns null if the hash value is not available.

setMd5Hash

public void setMd5Hash(byte[] md5Hash)

Set the MD5 hash value of this object's data. The hash value is stored as metadata under Content-MD5 (Base64-encoded) and the JetS3t-specific md5-hash (Hex-encoded).

Parameters:

md5Hash - the MD5 hash value of the object's data.

getLastModifiedDate

public java.util.Date getLastModifiedDate()

Returns:

the last modified date of this object, as provided by the service. If the last modified date is not available (e.g. if the object has only just been created) the object's creation date is returned instead. If both last modified and creation dates are unavailable, null is returned.

setLastModifiedDate

public void setLastModifiedDate(java.util.Date lastModifiedDate)

Set this object's last modified date based on information returned from the service. This method should only by used internally by code that reads the last modified date from a service response; it must not be set prior to uploading data to the service.

Parameters:

lastModifiedDate -

getContentLength

public long getContentLength()

Returns:

the content length, or size, of this object's data, or 0 if it is unknown.

setContentLength

public void setContentLength(long size)

Set this object's content length. The content length is set internally by JetS3t for objects that are retrieved from a service. For objects that are uploaded, JetS3t automatically calculates the content length if the data is provided to the String- or File-based object constructor. If you manually provide data to this object via the setDataInputStream(InputStream) or setDataInputFile(File) methods, you must also set the content length value.

Parameters:

size -

getContentType

public java.lang.String getContentType()

Returns:

the content type of the object

setContentType

public void setContentType(java.lang.String contentType)

Set the content type of the object. JetS3t can help you determine the content type when the associated data is a File (see Mimetypes). You should set the content type for associated String or InputStream data.

Parameters:

contentType -

getContentLanguage

public java.lang.String getContentLanguage()

Returns:

the content language of this object, or null if it is unknown.

setContentLanguage

public void setContentLanguage(java.lang.String contentLanguage)

Set the content language of the object.

Parameters:

contentLanguage -

getContentDisposition

public java.lang.String getContentDisposition()

Returns:

the content disposition of this object, or null if it is unknown.

setContentDisposition

public void setContentDisposition(java.lang.String contentDisposition)

Set the content disposition of the object.

Parameters:

contentDisposition -

getContentEncoding

public java.lang.String getContentEncoding()

Returns:

the content encoding of this object, or null if it is unknown.

setContentEncoding

public void setContentEncoding(java.lang.String contentEncoding)

Set the content encoding of this object.

Parameters:

contentEncoding -

getKey

public java.lang.String getKey()

Returns:

the key of this object.

setKey

public void setKey(java.lang.String key)

Set the key of this object.

Parameters:

key - the key for this object.

getAcl

public AccessControlList getAcl()

Returns:

the object's ACL, or null if it is unknown.

setAcl

public void setAcl(AccessControlList acl)

Set the object's ACL.

Parameters:

acl -

getStorageClass

public java.lang.String getStorageClass()

Returns:

the storage class of the object.

setStorageClass

public void setStorageClass(java.lang.String storageClass)

Set the storage class for this object.

Parameters:

storageClass -

getServerSideEncryptionAlgorithm

public java.lang.String getServerSideEncryptionAlgorithm()

Returns:

the encryption algorithm used for server-side encryption (unencrypted if null).

setServerSideEncryptionAlgorithm

public void setServerSideEncryptionAlgorithm(java.lang.String serverSideEncryptionAlgorithm)

Set the encryption algorithm to use for server-side encryption of this object (will be unencrypted if set to null)

Parameters:

serverSideEncryptionAlgorithm -

isMetadataComplete

public boolean isMetadataComplete()

Returns:

true if the object's metadata are considered complete, such as when the object's metadata has been retrieved from the service by a HEAD request. If this value is not true, the metadata information in this object should not be considered authoritative.

setMetadataComplete

public void setMetadataComplete(boolean isMetadataComplete)

Object metadata are only complete when it is populated with all values following a HEAD or GET request. This method should only by used by code that reads service responses.

Parameters:

isMetadataComplete -

addMetadata

public void addMetadata(java.lang.String name,
                        java.lang.String value)

Add metadata information to the object. If date metadata items (as recognized by name) are added and the value is not a date the value is parsed as an RFC 822 or ISO 8601 string.

Overrides:

addMetadata in class BaseStorageItem

Parameters:

name -

value -

addAllMetadata

public void addAllMetadata(java.util.Map<java.lang.String,java.lang.Object> metadata)

Add all the metadata information to the object from the provided map.

Overrides:

addAllMetadata in class BaseStorageItem

Parameters:

metadata -

getModifiableMetadata

public java.util.Map<java.lang.String,java.lang.Object> getModifiableMetadata()

Returns only those object metadata items that can be modified in a service. This list excludes those that are set by the the service, and those that are specific to a particular HTTP request/response session (such as request identifiers).

Returns:

the limited set of metadata items that users can control.

isDirectoryPlaceholder

public boolean isDirectoryPlaceholder()

verifyData

public boolean verifyData(java.io.File downloadedFile)
                   throws java.security.NoSuchAlgorithmException,
                          java.io.FileNotFoundException,
                          java.io.IOException

Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).

Parameters:

downloadedFile -

Returns:

true if the calculated MD5 hash value of the file matches this object's hash value, false otherwise.

Throws:

java.lang.IllegalStateException - if the object's MD5 hash value is unavailable, e.g. for objects stored in S3 using multipart uploads (for which the service does not provide MD5 hash values for verification).

java.security.NoSuchAlgorithmException

java.io.FileNotFoundException

java.io.IOException

verifyData

public boolean verifyData(byte[] downloadedData)
                   throws java.security.NoSuchAlgorithmException,
                          java.io.FileNotFoundException,
                          java.io.IOException

Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).

Parameters:

downloadedData -

Returns:

true if the calculated MD5 hash value of the bytes matches this object's hash value, false otherwise.

Throws:

java.security.NoSuchAlgorithmException

java.io.FileNotFoundException

java.io.IOException

verifyData

public boolean verifyData(java.io.InputStream downloadedDataStream)
                   throws java.security.NoSuchAlgorithmException,
                          java.io.FileNotFoundException,
                          java.io.IOException

Calculates the MD5 hash value of the given data object, and compares it against this object's hash (as stored in the Content-MD5 header for uploads, or the ETag header for downloads).

Parameters:

downloadedDataStream - the input stream of a downloaded object.

Returns:

true if the calculated MD5 hash value of the input stream matches this object's hash value, false otherwise.

Throws:

java.security.NoSuchAlgorithmException

java.io.FileNotFoundException

java.io.IOException