sirius.biz.jdbc.storage

Class FSStorageEngine

java.lang.Object

sirius.biz.jdbc.storage.FSStorageEngine

All Implemented Interfaces:

PhysicalStorageEngine

public class FSStorageEngine
extends Object
implements PhysicalStorageEngine

Provides a PhysicalStorageEngine which operates on the local file system.

Constructor Summary

Constructors

Constructor and Description
FSStorageEngine()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSStorageEngine

public FSStorageEngine()

Method Detail

storePhysicalObject

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

Description copied from interface: PhysicalStorageEngine

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

Specified by:

storePhysicalObject in interface PhysicalStorageEngine

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

public void deletePhysicalObject(String bucket,
                                 String physicalKey)

Description copied from interface: PhysicalStorageEngine

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

Specified by:

deletePhysicalObject in interface PhysicalStorageEngine

Parameters:

bucket - the bucket to delete the object from

physicalKey - the id of the object to delete

getData

@Nullable
public InputStream getData(String bucket,
                                     String physicalKey)

Description copied from interface: PhysicalStorageEngine

Downloads an provides the contents of the requested object.

Specified by:

getData in interface PhysicalStorageEngine

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

deliver

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

Description copied from interface: PhysicalStorageEngine

Delivers the requested object to the given request as response.

Specified by:

deliver in interface PhysicalStorageEngine

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

public String createURL(DownloadBuilder downloadBuilder)

Description copied from interface: PhysicalStorageEngine

Can provide a custom download URL for a given builder.

Specified by:

createURL in interface PhysicalStorageEngine

Parameters:

downloadBuilder - the builder specifying the download parameters

Returns:

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