ej.storage.fs

Class StorageFs

java.lang.Object

ej.storage.fs.StorageFs

All Implemented Interfaces:

ej.storage.Storage

public class StorageFs
extends java.lang.Object
implements ej.storage.Storage

Implementation of persistent storage on file system.

Constructor Summary

Constructors

Constructor and Description
StorageFs() Creates a storage on file system.
StorageFs(java.lang.String root) Creates a storage on file system specifying the root folder where the files will be created.

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	append(java.lang.String id)
boolean	exists(java.lang.String id)
protected java.io.File	getFile(java.lang.String id) Returns the file associated to the given storage id.
java.lang.String[]	getIds()
protected static java.lang.String	getRootFolderPropertyOrDefault() Gets the root folder set with ej.storage.fs.StorageFs.root or if none.
long	getSize(java.lang.String id)
java.io.InputStream	load(java.lang.String id)
java.io.OutputStream	modify(java.lang.String id, int offset)
void	move(java.lang.String sourceId, java.lang.String destinationId)
void	remove(java.lang.String id)
java.io.OutputStream	store(java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageFs

public StorageFs()
          throws java.io.IOException

Creates a storage on file system.

The root folder where the files will be created can be specified with the property ej.storage.fs.StorageFs.root. If not set, will be used.

Throws:

java.io.IOException - if the specified root already exists and is not a directory.

java.io.IOException - if the specified root cannot be created.

StorageFs

public StorageFs(java.lang.String root)
          throws java.io.IOException

Creates a storage on file system specifying the root folder where the files will be created.

Parameters:

root - the root.

Throws:

java.io.IOException - if the specified root already exists and is not a directory.

java.io.IOException - if the specified root cannot be created.

Method Detail

getRootFolderPropertyOrDefault

protected static java.lang.String getRootFolderPropertyOrDefault()

Gets the root folder set with ej.storage.fs.StorageFs.root or if none.

Returns:

the root folder.

store

public java.io.OutputStream store(java.lang.String id)
                           throws java.io.IOException

Specified by:

store in interface ej.storage.Storage

Throws:

java.io.IOException

modify

public java.io.OutputStream modify(java.lang.String id,
                                   int offset)
                            throws java.io.IOException

Specified by:

modify in interface ej.storage.Storage

Throws:

java.io.IOException

getFile

protected java.io.File getFile(java.lang.String id)

Returns the file associated to the given storage id.

Parameters:

id - the storage identifier.

Returns:

the file associated to the given storage id.

append

public java.io.OutputStream append(java.lang.String id)
                            throws java.io.IOException

Specified by:

append in interface ej.storage.Storage

Throws:

java.io.IOException

load

@Nullable
public java.io.InputStream load(java.lang.String id)
                                    throws java.io.IOException

Specified by:

load in interface ej.storage.Storage

Throws:

java.io.IOException

move

public void move(java.lang.String sourceId,
                 java.lang.String destinationId)
          throws java.io.IOException

Specified by:

move in interface ej.storage.Storage

Throws:

java.io.IOException

remove

public void remove(java.lang.String id)
            throws java.io.IOException

Specified by:

remove in interface ej.storage.Storage

Throws:

java.io.IOException

getSize

public long getSize(java.lang.String id)
             throws java.io.IOException

Specified by:

getSize in interface ej.storage.Storage

Throws:

java.io.IOException

exists

public boolean exists(java.lang.String id)
               throws java.io.IOException

Specified by:

exists in interface ej.storage.Storage

Throws:

java.io.IOException

getIds

public java.lang.String[] getIds()
                          throws java.io.IOException

Specified by:

getIds in interface ej.storage.Storage

Throws:

java.io.IOException