cz.ues.platform.udds

Class UESStorageObject

java.lang.Object

cz.ues.platform.udds.UESStorageObject

public class UESStorageObject
extends java.lang.Object

UESStorageObject represents data stored in UESSharedStorage.

Usage constraints:

• Size of a single object is limited to 5 GB.
• Data in storage object is not encrypted - user of UESStorageService has to ensure data encryption if it is required.
• Only put / get / delete operations are supported. Random access is not supported, data cannot be appended. The object can be stored, replaced or deleted only as a whole.
• Objects cannot be nested. But pseudo-hierarchical structure can be simulated using properly chosen object identifiers.
• Object identifier must be unique within a particular bucket.
• The storage object must either specify a file or an input stream containing the data to be uploaded. Both cannot be specified.

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	inputFile File which is represented by this UES storage object.
private java.io.InputStream	inputStream Input stream which contains data represented by this UES storage object.
private UESMetadata	metadata Metadata associated with the storage object.
private java.lang.String	objectId Identifier of this instance of UES storage object.

Constructor Summary

Constructors

Constructor and Description
UESStorageObject(java.lang.String objectId, java.io.File file, long contentLength, java.lang.String contentType) Creates a new instance of UESStorageObject.
UESStorageObject(java.lang.String objectId, java.io.InputStream inputStream, long contentLength, java.lang.String contentType) Creates a new instance of UESStorageObject.

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getFile() Returns file with the storage object contents (if this instance was created with file parameter).
java.lang.String	getID() The ID under which this object is stored.
java.io.InputStream	getInputStream() Returns input stream with the storage object contents.
UESMetadata	getMetadata() Gets the metadata stored by UDDS for this object.
private void	setFile(java.io.File file) Sets file with the storage object contents.
void	setID(java.lang.String objectId) Sets the ID under which this object is stored.
private void	setInputStream(java.io.InputStream is) Sets input stream with the storage object contents.
void	setMetadata(UESMetadata metadata) For internal use only.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

objectId

private objectId

Identifier of this instance of UES storage object.

inputFile

private inputFile

File which is represented by this UES storage object.

inputStream

private inputStream

Input stream which contains data represented by this UES storage object.

metadata

private metadata

Metadata associated with the storage object.

Since:

UES6-06

Constructor Detail

UESStorageObject

public UESStorageObject(java.lang.String objectId,
java.io.File file,
long contentLength,
java.lang.String contentType)

Creates a new instance of UESStorageObject.

Parameters:

objectId - The ID under which this object is stored.

file - The file containing this object's contents.

contentLength - Size of the file contents in bytes.

contentType - Type of the file contents (can be null).

Since:

UES6-06

UESStorageObject

public UESStorageObject(java.lang.String objectId,
java.io.InputStream inputStream,
long contentLength,
java.lang.String contentType)

Creates a new instance of UESStorageObject.

Parameters:

objectId - The ID under which this object is stored.

inputStream - The input stream containing this object's contents.

contentLength - Size of the input stream contents in bytes.

contentType - Type of the input stream contents (can be null).

Since:

UES6-06

Method Detail

getID

public java.lang.String getID()

The ID under which this object is stored.

Returns:

The ID under which is this object stored.

Since:

UES6-06

setID

public void setID(java.lang.String objectId)

Sets the ID under which this object is stored.

Parameters:

objectId - The ID under which is this object stored. Valid characters for object ID are: small letters from english alphabet (a-z), digits (0-9), slash (/) and dash (-). Object ID cannot ends with dash.

Since:

UES6-06

getInputStream

public java.io.InputStream getInputStream()

Returns input stream with the storage object contents. If this UESStorageObject instance was created with file, an input stream is opened from that file.

Important: It is the caller's responsibility to close the object's data input stream. The data stream should be consumed and closed as soon as is practical as network connections may be held open until the streams are closed. Excessive unclosed streams can lead to connection starvation.

Returns:

Input stream for the data encapsulated by this UESStorageObject instance.

Since:

UES6-06

setInputStream

private void setInputStream(java.io.InputStream is)

Sets input stream with the storage object contents.

Parameters:

is - Input stream with the contents.

Since:

UES6-06

getFile

public java.io.File getFile()

Returns file with the storage object contents (if this instance was created with file parameter).

Returns:

The input file if this instance was created with file parameter, otherwise null.

Since:

UES6-06

setFile

private void setFile(java.io.File file)

Sets file with the storage object contents.

Parameters:

file - File with the contents.

Since:

UES6-06

getMetadata

public UESMetadata getMetadata()

Gets the metadata stored by UDDS for this object.

Returns:

The metadata stored by UDDS for this object.

Since:

UES6-06

setMetadata

public void setMetadata(UESMetadata metadata)
throws UESStorageServiceRTException

For internal use only. Sets metadata for this object.

Parameters:

metadata - The metadata.

Throws:

UESStorageServiceRTException - If the metadata parameter is null.

Since:

UES6-06

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

UES6-06

See Also:

Object.toString()