```
public interface StoredFileHandler
```
Handler used to manage StoredFile entities and its content.

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`SKIP_LOCK`	This is used only in some main files to avoid lock issues
`static String`	`SKIP_LOCK_PROPERTY`	System property name for `SKIP_LOCK`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`copy(StoredFile source, StoredFile target)`	Copies the source's attributes and content to target.
`com.querydsl.core.types.dsl.BooleanExpression`	`customFieldEquals(com.querydsl.core.types.EntityPath<?> sf, CustomField<?,?,?> customField)`	Returns a query predicate that any property of type CustomField points to the given custom field
`<T extends StoredFile> T`	`find(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`
`byte[]`	`getBytes(StoredFile storedFile)`	Returns the content of the specified `StoredFile` as bytes
`SerializableInputStream`	`getContent(StoredFile storedFile)`	Opens an input stream to allow read the content of the specified `StoredFile`. It is caller's responsibility to close the stream after read.
`Set<String>`	`getStorageDirectories()`	Returns the set of directory names available for store an individual document or a custom field of type image/file configured in the cyclos.properties only if the underlying `StoredFileContentManager` implementation support store files in a specific directory other than the default.
`static Set<String>`	`getStorageDirectories(CyclosProperties cyclosProperties)`	Retrieves the storage directories list from the cyclos.proeprties file.
`String`	`getStorageDirectory(StoredFile storedFile)`	Returns the storage directory, if any, for those cases where a custom storage directory can be specified (individual documents, image/file custom fields).
`boolean`	`isStoredOnDB()`	Returns whether the underlying storage for files is database
`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.
`boolean`	`supportStorageDirectories()`	Returns true if the underlying `StoredFileContentManager` implementation support store files in a specific directory other than the default

- Field Detail
  - SKIP_LOCK_PROPERTY
```
static final String SKIP_LOCK_PROPERTY
```
    System property name for SKIP_LOCK
    
    See Also:
    
    Constant Field Values
  - SKIP_LOCK
```
static final boolean SKIP_LOCK
```
    This is used only in some main files to avoid lock issues
- Method Detail
  - getStorageDirectories
```
static Set<String> getStorageDirectories(CyclosProperties cyclosProperties)
```
    Retrieves the storage directories list from the cyclos.proeprties file.
  - copy
```
void copy(StoredFile source,
          StoredFile target)
   throws StoredFileException
```
    Copies the source's attributes and content to target.
    
    Throws:
    
    StoredFileException
  - customFieldEquals
```
com.querydsl.core.types.dsl.BooleanExpression customFieldEquals(com.querydsl.core.types.EntityPath<?> sf,
                                                                CustomField<?,?,?> customField)
```
    Returns a query predicate that any property of type CustomField points to the given custom field
  - find
```
<T extends StoredFile> T find(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
  - getBytes
```
byte[] getBytes(StoredFile storedFile)
         throws StoredFileException,
                EntityNotFoundException
```
    Returns the content of the specified StoredFile as bytes
    
    Throws:
    
    StoredFileException
    
    EntityNotFoundException
  - getContent
```
SerializableInputStream getContent(StoredFile storedFile)
                            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
  - getStorageDirectories
```
Set<String> getStorageDirectories()
```
    Returns the set of directory names available for store an individual document or a custom field of type image/file configured in the cyclos.properties only if the underlying StoredFileContentManager implementation support store files in a specific directory other than the default. Otherwise returns an empty Set.
  - getStorageDirectory
```
String getStorageDirectory(StoredFile storedFile)
```
    Returns the storage directory, if any, for those cases where a custom storage directory can be specified (individual documents, image/file custom fields). Otherwise it returns null.
  - isStoredOnDB
```
boolean isStoredOnDB()
```
    Returns whether the underlying storage for files is database
  - 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
  - supportStorageDirectories
```
boolean supportStorageDirectories()
```
    Returns true if the underlying StoredFileContentManager implementation support store files in a specific directory other than the default

Interface StoredFileHandler

Field Summary

Method Summary

Field Detail

SKIP_LOCK_PROPERTY

SKIP_LOCK

Method Detail

getStorageDirectories

copy

customFieldEquals

find

getBytes

getContent

getStorageDirectories

getStorageDirectory

isStoredOnDB

move

remove

save

supportStorageDirectories