cz.ues.platform.udds

Class UESMetadata

java.lang.Object

cz.ues.platform.udds.UESMetadata

public class UESMetadata
extends java.lang.Object

Metadata for UESStorageObject - key-value pairs. The overall maximum size of metadata for any single storage object is limited to 2 kilobytes.

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
private long	contentLength Size of the associated object in bytes.
private java.lang.String	contentType Type of content stored in the associated object.
private java.util.Date	creationTime Time when the associated object was created.
private static int	DEFAULT_METADATA_ENTRIES_COUNT Default count of metadata entries.
private java.lang.String	logicalName Logical name of the associated object.
private UESOwner	owner Identification of user and service/application that put the associated object in the storage.
private java.util.Map<java.lang.String,java.lang.String>	userMetadata Custom user-metadata for the associated object.

Constructor Summary

Constructors

Constructor and Description
UESMetadata() Creates a new instance of UESMetadata.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserMetadata(java.lang.String key, java.lang.String value) Adds the key-value pair of custom user-metadata for the associated object.
long	getContentLength() Gets the size of the associated object in bytes.
java.lang.String	getContentType() Gets the type of content stored in the associated object.
java.util.Date	getCreationTime() Gets time when the associated object was created.
java.lang.String	getLogicalName() Gets the logical (human readable) name of the associated object.
UESOwner	getOwner() Gets identification of user and service/application that put the associated object in the storage.
java.util.Map<java.lang.String,java.lang.String>	getUserMetadata() Gets the custom user-metadata for the associated object.
private void	checkNotNullValues(java.util.Map<java.lang.String,java.lang.String> userMetadata) Test user metadata whether is some key or value null.
void	setContentLength(long length) Sets the size of the associated object in bytes.
void	setContentType(java.lang.String contentType) Sets the type of content stored in the associated object.
void	setCreationTime(java.util.Date time) For internal use only.
void	setLogicalName(java.lang.String name) Sets the logical (human readable) name of the associated object.
void	setOwner(UESOwner owner) For internal use only.
void	setUserMetadata(java.util.Map<java.lang.String,java.lang.String> userMetadata) Sets the custom user-metadata for the associated object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METADATA_ENTRIES_COUNT

private static final DEFAULT_METADATA_ENTRIES_COUNT

Default count of metadata entries.

See Also:

Constant Field Values

logicalName

private logicalName

Logical name of the associated object.

contentLength

private contentLength

Size of the associated object in bytes.

contentType

private contentType

Type of content stored in the associated object.

owner

private owner

Identification of user and service/application that put the associated object in the storage.

creationTime

private creationTime

Time when the associated object was created.

userMetadata

private userMetadata

Custom user-metadata for the associated object.

Constructor Detail

UESMetadata

public UESMetadata()

Creates a new instance of UESMetadata.

Since:

UES6-06

Method Detail

getLogicalName

public java.lang.String getLogicalName()

Gets the logical (human readable) name of the associated object.

Returns:

the logical name of the associated object. Returns null if it hasn't been set yet.

Since:

UES6-06

setLogicalName

public void setLogicalName(java.lang.String name)

Sets the logical (human readable) name of the associated object.

Parameters:

name - logical name.

Since:

UES6-06

getContentLength

public long getContentLength()

Gets the size of the associated object in bytes.

Returns:

the size of the associated object in bytes. Returns null if it hasn't been set yet.

Since:

UES6-06

setContentLength

public void setContentLength(long length)

Sets the size of the associated object in bytes.

Parameters:

length - size in bytes.

Since:

UES6-06

getContentType

public java.lang.String getContentType()

Gets the type of content stored in the associated object. The value of this header is a standard MIME type.

Returns:

the type of content stored in the associated object. Returns null if it hasn't been set.

Since:

UES6-06

setContentType

public void setContentType(java.lang.String contentType)

Sets the type of content stored in the associated object. The value of this header is a standard MIME type.

Parameters:

contentType - type of content stored in the associated object.

Since:

UES6-06

getOwner

public UESOwner getOwner()

Gets identification of user and service/application that put the associated object in the storage.

Returns:

Owner of the associated object.

Since:

UES6-06

setOwner

public void setOwner(UESOwner owner)

For internal use only. Sets identification of user and service/application that put the associated object in the storage.

Parameters:

owner - Owner of the associated object.

Since:

UES6-06

getCreationTime

public java.util.Date getCreationTime()

Gets time when the associated object was created.

Returns:

Time when the associated object was created.

Since:

UES6-06

setCreationTime

public void setCreationTime(java.util.Date time)

For internal use only. Sets time when the associated object was created.

Parameters:

time - Time when the associated object was created.

Since:

UES6-06

getUserMetadata

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

Gets the custom user-metadata for the associated object.

Returns:

the custom user metadata for the associated object.

Since:

UES6-06

addUserMetadata

public void addUserMetadata(java.lang.String key,
java.lang.String value)

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.

Parameters:

key - the key for the custom user metadata entry, must not be null.

value - the value for the custom user-metadata entry.

Since:

UES6-06

setUserMetadata

public void setUserMetadata(java.util.Map<java.lang.String,java.lang.String> userMetadata)

Sets the custom user-metadata for the associated object.

Parameters:

userMetadata - the custom user-metadata for the associated object.

Since:

UES6-06

checkNotNullValues

private void checkNotNullValues(java.util.Map<java.lang.String,java.lang.String> userMetadata)
throws UESStorageServiceRTException

Test user metadata whether is some key or value null.

Parameters:

userMetadata - Tested user metadata.

Throws:

UESStorageServiceRTException - When there is some key or value null.

Since:

UES6-06

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

UES6-06

See Also:

Object.toString()