DeferredFileStreamStorageFactory (org.synchronoss.cloud:nio-stream-storage 1.1.3 API)

java.lang.Object
- org.synchronoss.cloud.nio.stream.storage.DeferredFileStreamStorageFactory

All Implemented Interfaces:

StreamStorageFactory
```
public class DeferredFileStreamStorageFactory
extends Object
implements StreamStorageFactory
```
Factory for creating FileStreamStorages. The factory can be configured to:
- Use a specific temporary folder where the temporary files generated by the created FileStreamStorages are stored
- Set a specific memory threshold that will be set to the created FileStreamStorages
- Create FileStreamStorages that will delete the underlying file after closing its InputStream
- Create FileStreamStorages that will delete the underlying file after disposing the FileStreamStorage itself
- Create FileStreamStorages with a maximum capacity

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_CAPACITY` Default maximum capacity to set to the new `StreamStorage`s.
`static int`	`DEFAULT_MAX_THRESHOLD` Default max threshold.
`static String`	`DEFAULT_ROOT_FOLDER` Default location where the data files are stored.

Constructor Summary

Constructors
Constructor and Description
`DeferredFileStreamStorageFactory()` Constructor that uses a default threshold of 10kb and a default folder ${java.io.tmpdir}/nio-stream-storage.
`DeferredFileStreamStorageFactory(int maxSizeThreshold)` Constructor that uses a default folder ${java.io.tmpdir}/nio-stream-storage.
`DeferredFileStreamStorageFactory(String tempFolderPath)` Constructor that uses the default threshold of 10kb.
`DeferredFileStreamStorageFactory(String rootFolderPath, int maxSizeThreshold)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`StreamStorage`	`create()` Creates a new `FileStreamStorage`.
`protected String`	`getFileName()` Generates an unique file name for the data file.
`void`	`setDeleteFilesOnClose(boolean deleteFilesOnClose)`
`void`	`setDeleteFilesOnDispose(boolean deleteFilesOnDispose)`
`void`	`setMaxCapacity(long maxCapacity)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_THRESHOLD
```
public static final int DEFAULT_MAX_THRESHOLD
```
    Default max threshold. 10Kb
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_CAPACITY
```
public static final int DEFAULT_MAX_CAPACITY
```
    Default maximum capacity to set to the new StreamStorages. The default is infinite and it can be changed via the setMaxCapacity(long) method.
    
    See Also:
    Constant Field Values
  - DEFAULT_ROOT_FOLDER
```
public static final String DEFAULT_ROOT_FOLDER
```
    Default location where the data files are stored.
- Constructor Detail
  - DeferredFileStreamStorageFactory
```
public DeferredFileStreamStorageFactory(String rootFolderPath,
                                int maxSizeThreshold)
```
    Constructor.
    
    Parameters:
    rootFolderPath - The path to the folder where data files will be stored if the max threshold is reached.
    maxSizeThreshold - The threshold in bytes. When the data in memory exceeds this threshold it will be written to a temporary file.
  - DeferredFileStreamStorageFactory
```
public DeferredFileStreamStorageFactory(String tempFolderPath)
```
    Constructor that uses the default threshold of 10kb.
    
    Parameters:
    tempFolderPath - The path to the folder were temporary data will be stored if the max threshold is reached.
  - DeferredFileStreamStorageFactory
```
public DeferredFileStreamStorageFactory(int maxSizeThreshold)
```
    Constructor that uses a default folder ${java.io.tmpdir}/nio-stream-storage.
    
    Parameters:
    maxSizeThreshold - The threshold in bytes. When the data in memory exceeds this threshold it will be written to a temporary file.
  - DeferredFileStreamStorageFactory
```
public DeferredFileStreamStorageFactory()
```
    Constructor that uses a default threshold of 10kb and a default folder ${java.io.tmpdir}/nio-stream-storage.
- Method Detail
  - setDeleteFilesOnClose
```
public void setDeleteFilesOnClose(boolean deleteFilesOnClose)
```
  - setDeleteFilesOnDispose
```
public void setDeleteFilesOnDispose(boolean deleteFilesOnDispose)
```
  - setMaxCapacity
```
public void setMaxCapacity(long maxCapacity)
```
  - create
```
public StreamStorage create()
```
    Creates a new FileStreamStorage.
    
    Specified by:
    
    create in interface StreamStorageFactory
    
    Returns:
    a StreamStorage to store bytes temporarily in-memory or on disk if over the configured threshold.
  - getFileName
```
protected String getFileName()
```
    Generates an unique file name for the data file.
    
    Returns:
    The unique file name.

Class DeferredFileStreamStorageFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_THRESHOLD

DEFAULT_MAX_CAPACITY

DEFAULT_ROOT_FOLDER

Constructor Detail

DeferredFileStreamStorageFactory

DeferredFileStreamStorageFactory

DeferredFileStreamStorageFactory

DeferredFileStreamStorageFactory

Method Detail

setDeleteFilesOnClose

setDeleteFilesOnDispose

setMaxCapacity

create

getFileName