sirius.biz.jdbc.storage

Class VirtualObject

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<Long>

sirius.db.jdbc.SQLEntity

sirius.biz.jdbc.model.BizEntity

sirius.biz.jdbc.tenants.SQLTenantAware

sirius.biz.jdbc.storage.VirtualObject

All Implemented Interfaces:

StoredObject, TenantAware, sirius.kernel.di.transformers.Transformable

public class VirtualObject
extends SQLTenantAware
implements StoredObject

Stores the metadata for an object managed by the Storage.

Note that the externally visible methods are decalred by StoredObject which is the public interface.

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.db.mixing.Mapping	BUCKET Contains the bucket in which the object resides.
static sirius.db.mixing.Mapping	FILE_EXTENSION Contains the file extension used to determine the mime type.
static sirius.db.mixing.Mapping	FILE_SIZE Contains the size in bytes of this object.
static sirius.db.mixing.Mapping	MD5 Contains the MD5 checksum of the stored data.
static sirius.db.mixing.Mapping	OBJECT_KEY Contains the unique object key of this object.
static sirius.db.mixing.Mapping	PATH Contains the virtual path of the object.
static sirius.db.mixing.Mapping	PHYSICAL_KEY Contains the physical key, which points to the actual contents of this object.
static sirius.db.mixing.Mapping	REFERENCE Contains a reference to another entity, if this object was specifically created for a reference.
static sirius.db.mixing.Mapping	TEMPORARY Marks this object as temporary.

Fields inherited from class sirius.biz.jdbc.tenants.SQLTenantAware

TENANT

Fields inherited from class sirius.biz.jdbc.model.BizEntity

TRACE

Fields inherited from class sirius.db.jdbc.SQLEntity

fetchRow, id, ID, NON_PERSISTENT_ENTITY_ID, oma

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
VirtualObject()

Method Summary

Modifier and Type	Method and Description
protected void	ensureUniquenessOfPath()
protected void	fillObjectKey()
protected void	fixPath()
String	getBucket()
String	getFileExtension()
String	getFilename() Returns the filename of the object.
long	getFileSize() Returns the size of the object in bytes.
LocalDateTime	getLastModified() Returns the timestamp when the entity was last modified.
String	getMd5()
String	getObjectKey() Represents the unique id of the stored object.
String	getPath() Returns the path of the object.
String	getPhysicalKey()
String	getReference() Returns the reference to which this object belongs.
boolean	isImage()
boolean	isTemporary()
DownloadBuilder	prepareURL() Creates a builder to build a download URL for this object.
protected void	removeObjectFromCaches()
protected void	removePhysicalObject()
void	setBucket(String bucket)
void	setFileExtension(String fileExtension)
void	setFileSize(long fileSize)
void	setMd5(String md5)
void	setObjectKey(String objectKey)
void	setPath(String path)
void	setPhysicalKey(String physicalKey)
void	setReference(String reference)
void	setTemporary(boolean temporary)
String	toString()

Methods inherited from class sirius.biz.jdbc.tenants.SQLTenantAware

getTenant, getTenantAsString, setCurrentTenant

Methods inherited from class sirius.biz.jdbc.model.BizEntity

getTrace, isAnyColumnChangedExceptNoJournal

Methods inherited from class sirius.db.jdbc.SQLEntity

equals, getFetchRow, getId, getMapper, hashCode, isNew, isUnique, setId

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, isAnyMappingChanged, isChanged, setVersion

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface sirius.biz.web.TenantAware

assertSameTenant

Field Detail

BUCKET

public static final sirius.db.mixing.Mapping BUCKET

Contains the bucket in which the object resides.

OBJECT_KEY

public static final sirius.db.mixing.Mapping OBJECT_KEY

Contains the unique object key of this object.

PHYSICAL_KEY

public static final sirius.db.mixing.Mapping PHYSICAL_KEY

Contains the physical key, which points to the actual contents of this object.

FILE_SIZE

public static final sirius.db.mixing.Mapping FILE_SIZE

Contains the size in bytes of this object.

MD5

public static final sirius.db.mixing.Mapping MD5

Contains the MD5 checksum of the stored data.

PATH

public static final sirius.db.mixing.Mapping PATH

Contains the virtual path of the object.

The length is shorten than a UNIX path (255 chars) to permit proper indexing in the database (the max key length in MySQL is typically 767 bytes).

FILE_EXTENSION

public static final sirius.db.mixing.Mapping FILE_EXTENSION

Contains the file extension used to determine the mime type.

REFERENCE

public static final sirius.db.mixing.Mapping REFERENCE

Contains a reference to another entity, if this object was specifically created for a reference.

When an object is uploaded / created for a reference, the field name and object name is placed here. This makes the object invisible in the UI and also automatically deletes it if the referencing object is deleted.

TEMPORARY

public static final sirius.db.mixing.Mapping TEMPORARY

Marks this object as temporary.

If a new file is uploaded for a reference it is marked as temporary. If the referencing entity is saved and confirms the object key, this flag is removed. Otherwise, if the file is uploaded but the entity is never saved, the file will be eventually deleted by StorageCleanupLoop.

Constructor Detail

VirtualObject

public VirtualObject()

Method Detail

ensureUniquenessOfPath

protected void ensureUniquenessOfPath()

fillObjectKey

protected void fillObjectKey()

fixPath

protected void fixPath()

getLastModified

public LocalDateTime getLastModified()

Description copied from interface: StoredObject

Returns the timestamp when the entity was last modified.

Specified by:

getLastModified in interface StoredObject

Returns:

the last modification timestamp

removePhysicalObject

protected void removePhysicalObject()

removeObjectFromCaches

protected void removeObjectFromCaches()

prepareURL

public DownloadBuilder prepareURL()

Description copied from interface: StoredObject

Creates a builder to build a download URL for this object.

Specified by:

prepareURL in interface StoredObject

Returns:

a builder to create a download URL

getFilename

public String getFilename()

Description copied from interface: StoredObject

Returns the filename of the object.

Specified by:

getFilename in interface StoredObject

Returns:

the filename of the object

toString

public String toString()

Overrides:

toString in class sirius.db.mixing.BaseEntity<Long>

isImage

public boolean isImage()

getBucket

public String getBucket()

setBucket

public void setBucket(String bucket)

getObjectKey

public String getObjectKey()

Description copied from interface: StoredObject

Represents the unique id of the stored object.

Specified by:

getObjectKey in interface StoredObject

Returns:

the unique key of the object

setObjectKey

public void setObjectKey(String objectKey)

getPhysicalKey

public String getPhysicalKey()

setPhysicalKey

public void setPhysicalKey(String physicalKey)

getFileSize

public long getFileSize()

Description copied from interface: StoredObject

Returns the size of the object in bytes.

Specified by:

getFileSize in interface StoredObject

Returns:

the size in bytes

setFileSize

public void setFileSize(long fileSize)

getPath

public String getPath()

Description copied from interface: StoredObject

Returns the path of the object.

Specified by:

getPath in interface StoredObject

Returns:

the path of the object

setPath

public void setPath(String path)

getFileExtension

public String getFileExtension()

setFileExtension

public void setFileExtension(String fileExtension)

getReference

public String getReference()

Description copied from interface: StoredObject

Returns the reference to which this object belongs.

Specified by:

getReference in interface StoredObject

Returns:

the reference, preferable an sirius.db.mixing.Entity#getUniqueName() or null if there is no reference

setReference

public void setReference(String reference)

getMd5

public String getMd5()

setMd5

public void setMd5(String md5)

isTemporary

public boolean isTemporary()

setTemporary

public void setTemporary(boolean temporary)