org.cyclos.impl.storage

Interface StoredFileHandler

public interface StoredFileHandler

Handler used to manage StoredFile entities and its content.

Author:

ameyer

Method Summary

Modifier and Type	Method and Description
void	copy(StoredFile source, StoredFile target) Copies the source's attributes and content to target.
<T extends StoredFile> T	find(java.lang.Class<T> clazz, long id) Finds a StoredFile in the catalog, if found returns the StoredFile with the specified id. This method doesn't check if the related content is present through the StoredFileContentManager
SerializableInputStream	getContent(StoredFile target) Opens an input stream to allow read the content of the specified StoredFile. It is caller's responsibility to close the stream after read.
void	move(StoredFile source, StoredFile target) Moves the source's attributes and content to target REMOVING the source.
void	remove(long id) Remove the stored file and its content.
void	save(StoredFile storedFile, SerializableInputStream in) Saves (create/update) a stored file reading its content from the specified stream. This method closes the provided SerializableInputStream after the method has completed.

Method Detail

copy

void copy(StoredFile source,
          StoredFile target)
   throws StoredFileException

Copies the source's attributes and content to target.

Throws:

StoredFileException

find

<T extends StoredFile> T find(java.lang.Class<T> clazz,
                              long id)
                       throws StoredFileException,
                              EntityNotFoundException

Finds a StoredFile in the catalog, if found returns the StoredFile with the specified id.
This method doesn't check if the related content is present through the StoredFileContentManager

Throws:

EntityNotFoundException - if a stored file was not found.

StoredFileException

getContent

SerializableInputStream getContent(StoredFile target)
                            throws StoredFileException,
                                   EntityNotFoundException

Opens an input stream to allow read the content of the specified StoredFile.
It is caller's responsibility to close the stream after read.

Throws:

StoredFileException

EntityNotFoundException

move

void move(StoredFile source,
          StoredFile target)
   throws StoredFileException

Moves the source's attributes and content to target REMOVING the source.

Throws:

StoredFileException

remove

void remove(long id)
     throws StoredFileException,
            EntityNotFoundException

Remove the stored file and its content.

Throws:

StoredFileException

EntityNotFoundException

save

void save(StoredFile storedFile,
          SerializableInputStream in)
   throws StoredFileException

Saves (create/update) a stored file reading its content from the specified stream.
This method closes the provided SerializableInputStream after the method has completed.

Throws:

StoredFileException