sirius.biz.jdbc.storage

Interface PhysicalStorageEngine

All Known Implementing Classes:

FSStorageEngine

public interface PhysicalStorageEngine

Represents the actual physical storage layer for objects within buckets.

Method Summary

Modifier and Type	Method and Description
String	createURL(DownloadBuilder downloadBuilder) Can provide a custom download URL for a given builder.
void	deletePhysicalObject(String bucket, String physicalKey) Deletes the physical object in the given bucket with the given id
void	deliver(sirius.web.http.WebContext ctx, String bucket, String physicalKey, String fileExtension) Delivers the requested object to the given request as response.
InputStream	getData(String bucket, String physicalKey) Downloads an provides the contents of the requested object.
void	storePhysicalObject(String bucket, String physicalKey, InputStream data, String md5, long size) Stores the given data for the given key in the given bucket.

Method Detail

storePhysicalObject

void storePhysicalObject(String bucket,
                         String physicalKey,
                         InputStream data,
                         String md5,
                         long size)
                  throws IOException

Stores the given data for the given key in the given bucket.

Parameters:

bucket - the bucket to store the object in

physicalKey - the physical storage key (a key is always only used once)

data - the data to store

md5 - the MD5 checksum of the data

size - the byte length of the data

Throws:

IOException - in case of an IO error

deletePhysicalObject

void deletePhysicalObject(String bucket,
                          String physicalKey)

Deletes the physical object in the given bucket with the given id

Parameters:

bucket - the bucket to delete the object from

physicalKey - the id of the object to delete

deliver

void deliver(sirius.web.http.WebContext ctx,
             String bucket,
             String physicalKey,
             String fileExtension)

Delivers the requested object to the given request as response.

Parameters:

ctx - the request to provide a response for

bucket - the bucket of the object to deliver

physicalKey - the id of the object to deliver

fileExtension - the file extension e.g. to setup a matching Content-Type

createURL

@Nullable
String createURL(DownloadBuilder downloadBuilder)

Can provide a custom download URL for a given builder.

Parameters:

downloadBuilder - the builder specifying the download parameters

Returns:

an URL to download the specified object or null to use a generic URL

getData

@Nullable
InputStream getData(String bucket,
                              String physicalKey)

Downloads an provides the contents of the requested object.

Parameters:

bucket - the bucket of the object

physicalKey - the id of the object

Returns:

a stream providing the contents of the object or null if the object doesn't exist