eu.europeana.domain

Class ObjectMetadata

java.lang.Object

eu.europeana.domain.ObjectMetadata

All Implemented Interfaces:

Serializable, Cloneable

public class ObjectMetadata
extends Object
implements Cloneable, Serializable

Represents the object metadata that is stored. This includes the standard HTTP headers (Content-Length, ETag, Content-MD5, etc.).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectMetadata()
ObjectMetadata(Map<String,Object> metadata)

Method Summary

Modifier and Type	Method and Description
void	addMetaData(String key, Object value)
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.
Long[]	getContentRange() Returns the content range of the object if response contains the Content-Range header.
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.
long	getInstanceLength() Returns the physical length of the entire object stored in S3.
Date	getLastModified() Gets the value of the Last-Modified header, indicating the date and time at which ObjectStorageClient last recorded a modification to the associated object.
Map<String,Object>	getRawMetadata() Gets a map of the raw metadata/headers for the associated object.
Object	getRawMetadataValue(String key) Returns the raw value of the metadata/headers for the specified key.
void	setCacheControl(String cacheControl) Sets the optional Cache-Control HTTP header which allows the user to specify caching behavior along the HTTP request/reply chain.
void	setContentDisposition(String disposition) Sets the optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename for the object to be saved as.
void	setContentEncoding(String 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.
void	setContentLanguage(String contentLanguage) Sets the Content-Language HTTP header which describes the natural language(s) of the intended audience for the enclosed entity.
void	setContentLength(long contentLength) Sets the Content-Length HTTP header indicating the size of the associated object in bytes.
void	setContentMD5(String md5Base64) Sets the base64 encoded 128-bit MD5 digest of the associated object (content - not including headers) according to RFC 1864.
void	setContentType(String contentType) Sets the Content-Type HTTP header indicating the type of content stored in the associated object.
void	setETag(String ETag)
void	setHeader(String key, Object value) For internal use only.
void	setLastModified(Date lastModified) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMetadata

public ObjectMetadata()

ObjectMetadata

public ObjectMetadata(Map<String,Object> metadata)

Method Detail

setHeader

public void setHeader(String key,
                      Object value)

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.

getRawMetadata

public Map<String,Object> getRawMetadata()

Gets a map of the raw metadata/headers for the associated object.

Returns:

A map of the raw metadata/headers for the associated object.

getRawMetadataValue

public Object getRawMetadataValue(String key)

Returns the raw value of the metadata/headers for the specified key.

getLastModified

public Date getLastModified()

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

Returns:

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

setLastModified

public void setLastModified(Date lastModified)

For internal use only. Sets the Last-Modified header value indicating the date and time at which ObjectStorageClient last recorded a modification to the associated object.

Parameters:

lastModified - The date and time at which ObjectStorageClient 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 the storage provider, but the ObjectStorageClient 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 ObjectStorageClient.

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:

ObjectMetadata.setContentLength(long)

getInstanceLength

public long getInstanceLength()

Returns the physical length of the entire object stored in S3. This is useful during, for example, a range get operation.

setContentLength

public void setContentLength(long contentLength)

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 ObjectStorageClient 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 ObjectStorageClient.

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:

ObjectMetadata.getContentLength()

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 ObjectStorageClient 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 storage object. Returns null if it hasn't been set.

See Also:

ObjectMetadata.setContentType(String)

setContentType

public void setContentType(String contentType)

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 ObjectStorageClient 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 storage object.

See Also:

ObjectMetadata.getContentType()

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.

See Also:

ObjectMetadata.setContentLanguage(String)

setContentLanguage

public void setContentLanguage(String contentLanguage)

Sets 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

Parameters:

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

See Also:

ObjectMetadata.getContentLanguage()

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.

See Also:

ObjectMetadata.setContentType(String)

setContentEncoding

public void setContentEncoding(String 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

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, ObjectMetadata.getContentType()

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.

See Also:

ObjectMetadata.setCacheControl(String)

setCacheControl

public void setCacheControl(String cacheControl)

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:

ObjectMetadata.getCacheControl()

setContentMD5

public void setContentMD5(String md5Base64)

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 ObjectStorageClient 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 ObjectStorageClient Java client will attempt to calculate this field automatically when uploading files to ObjectStorageClient.

Parameters:

md5Base64 - The base64 encoded MD5 hash of the content for the object associated with this metadata.

See Also:

ObjectMetadata.getContentMD5()

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 ObjectStorageClient 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 ObjectStorageClient Java client will attempt to calculate this field automatically when uploading files to ObjectStorageClient.

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:

ObjectMetadata.setContentMD5(String)

setContentDisposition

public void setContentDisposition(String disposition)

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:

ObjectMetadata.getContentDisposition()

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, ObjectMetadata.setCacheControl(String)

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 ObjectStorageClient.

This field represents the hex encoded 128-bit MD5 digest of an object's content as calculated by ObjectStorageClient. 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 ObjectStorageClient. Returns null if it hasn't been set yet.

setETag

public void setETag(String ETag)

getContentRange

public Long[] getContentRange()

Returns the content range of the object if response contains the Content-Range header.

If the request specifies a range or part number, then response returns the Content-Range range header. Otherwise, the response does not return Content-Range header.

Returns:

Returns content range if the object is requested with specific range or part number, null otherwise.

addMetaData

public void addMetaData(String key,
                        Object value)