com.logicaldoc.core.store

Class FSStorer

java.lang.Object

com.logicaldoc.core.store.FSStorer

All Implemented Interfaces:

Storer

public class FSStorer
extends Object
implements Storer

This class is an implementation of the Storer interface to persist documents in the filesystem. From the root of the documents storage, this implementation saves all document's files into a defined directory using the following logic. The document's id is tokenized by three chars tokens, than the doc/ dir is appended, so if the docId=12345, the document's path will be:123/45/doc.

Since:

4.5

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected ContextProperties	config
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
FSStorer()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	computeRelativePath(long docId) Computes the relative path of a document's folder inside the storage root.
void	delete(long docId) Deletes all resources of a document from the storage.
void	delete(long docId, String resource) Deletes a specific resource of a document from the storage.
boolean	exists(long docId, String resource) Checks if the passed resource exists in the document's container
byte[]	getBytes(long docId, String resource) Obtains the document's raw bytes for the specified version
ContextProperties	getConfig()
File	getContainer(long docId) Finds the container where all document's files are stored
String	getResourceName(Document doc, String fileVersion, String suffix) Computes the resource name inside the container
String	getResourceName(long docId, String fileVersion, String suffix) Computes the resource name inside the container
InputStream	getStream(long docId, String resource) Obtains the document's content for the specified version
long	getTotalSize() Computes the total size of the documents repository(in bytes)
List<String>	listResources(long docId, String fileVersion) Lists all resources in the document's container
void	setConfig(ContextProperties config)
long	size(long docId, String resource) Computed the size of a specific resource.
long	store(File file, long docId, String resource)
long	store(InputStream stream, long docId, String resource) This method has to store a resource in the document's container.
void	writeTo(long docId, String resource, File out) Writes the specified resource in a file

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

config

protected ContextProperties config

Constructor Detail

FSStorer

public FSStorer()

Method Detail

getConfig

public ContextProperties getConfig()

setConfig

public void setConfig(ContextProperties config)

delete

public void delete(long docId)

Description copied from interface: Storer

Deletes all resources of a document from the storage.

Specified by:

delete in interface Storer

Parameters:

docId - The document identifier

getContainer

public File getContainer(long docId)

Finds the container where all document's files are stored

Parameters:

docId - The document identifier

Returns:

The document's container

store

public long store(InputStream stream,
         long docId,
         String resource)

Description copied from interface: Storer

This method has to store a resource in the document's container. The location where (DBMS, Filesystem, other) the document should be stored is defined by the concrete implementation. It is possible to store a new document or a new version of an existing document.

Specified by:

store in interface Storer

Parameters:

stream - Document as InputStream

docId - The document identifier

resource - Name of the resource to be stored

Returns:

Size of the stored resource, or < 0 if the storage was not possible

store

public long store(File file,
         long docId,
         String resource)

Specified by:

store in interface Storer

See Also:

Storer.store(InputStream stream, long docId, String resource)

getResourceName

public String getResourceName(Document doc,
                     String fileVersion,
                     String suffix)

Description copied from interface: Storer

Computes the resource name inside the container

Specified by:

getResourceName in interface Storer

Parameters:

doc - The document representation

fileVersion - The file version (use null for the latest version)

suffix - The file suffix (use null if you want the exact document file)

Returns:

The document's resource name

getResourceName

public String getResourceName(long docId,
                     String fileVersion,
                     String suffix)

Description copied from interface: Storer

Computes the resource name inside the container

Specified by:

getResourceName in interface Storer

Parameters:

docId - The document identifier

fileVersion - The file version (use null for the latest version)

suffix - The file suffix (use null if you want the exact document file)

Returns:

The document's resource name

getStream

public InputStream getStream(long docId,
                    String resource)

Description copied from interface: Storer

Obtains the document's content for the specified version

Specified by:

getStream in interface Storer

Parameters:

docId - The document's identifier

resource - Name of the resource

Returns:

The document file's content

getTotalSize

public long getTotalSize()

Description copied from interface: Storer

Computes the total size of the documents repository(in bytes)

Specified by:

getTotalSize in interface Storer

getBytes

public byte[] getBytes(long docId,
              String resource)

Description copied from interface: Storer

Obtains the document's raw bytes for the specified version

Specified by:

getBytes in interface Storer

Parameters:

docId - The document's identifier

resource - Name of the resource

Returns:

The document file's bytes

delete

public void delete(long docId,
          String resource)

Description copied from interface: Storer

Deletes a specific resource of a document from the storage.

Specified by:

delete in interface Storer

Parameters:

docId - The document identifier

resource - Name of the resource to be deleted

listResources

public List<String> listResources(long docId,
                         String fileVersion)

Description copied from interface: Storer

Lists all resources in the document's container

Specified by:

listResources in interface Storer

Parameters:

docId - The document's identifier

fileVersion - If specified, lists the resources for that specific file version only

Returns:

size

public long size(long docId,
        String resource)

Description copied from interface: Storer

Computed the size of a specific resource.

Specified by:

size in interface Storer

Parameters:

docId - The document's identifier

resource - The resource

Returns:

the size in bytes

exists

public boolean exists(long docId,
             String resource)

Description copied from interface: Storer

Checks if the passed resource exists in the document's container

Specified by:

exists in interface Storer

Parameters:

docId - ID of the document

resource - Name of the resource

Returns:

true only if the resource already exists

computeRelativePath

protected String computeRelativePath(long docId)

Computes the relative path of a document's folder inside the storage root.

writeTo

public void writeTo(long docId,
           String resource,
           File out)

Description copied from interface: Storer

Writes the specified resource in a file

Specified by:

writeTo in interface Storer

Parameters:

docId - The document identifier

resource - Name of the resource