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

java.lang.Object
- java.io.OutputStream
- - org.synchronoss.cloud.nio.stream.storage.StreamStorage
  - - org.synchronoss.cloud.nio.stream.storage.FileStreamStorage

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Disposable
```
public class FileStreamStorage
extends StreamStorage
```
A configurable StreamStorage that:
- Allows a a combination of memory and file to store the data. In fact a threshold can be set and if the data is smaller than the threshold the data is kept in memory, if the threshold is reached the bytes are flushed to disk.
- Allows to automatically delete the file after the object is disposed via the dispose() method
- Allows to automatically delete the file after the InputStream returned by the getInputStream() method is closed.
- Allows to append the data to the underlying file (useful for resuming writes).
- Allows to set a maximum capacity.
The FileStreamStorage has two distinct states:
- write: The StreamStorage is ONLY writable and NOT readable.
- read: The StreamStorage is ONLY readable and NOT writable.
A new instance will always start in a write state, ready to accept bytes and any call to the getInputStream() will fail. Once all the data has been written, the close() method needs to be called to close the write channel and switch the FileStreamStorage to the read state. At that point the data can be read via getInputStream().
Author:

Silvano Riz

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FileStreamStorage(File file, int threshold, boolean append)` Constructor that sets the threshold to the user specified value.
`protected`	`FileStreamStorage(File file, int threshold, boolean deleteFilesOnClose, boolean deleteFilesOnDispose, boolean append, long maxCapacity)` Constructor that sets the threshold to the user specified value.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`static FileStreamStorage`	`deferred(File file, int threshold)` Returns a reference to a `FileStreamStorage` where the data is written to a file when the data is greater in size than the threshold specified.
`FileStreamStorage`	`deleteFilesOnClose()` Configures the current `FileStreamStorage` to delete the underlying file after calling the `close()` method.
`FileStreamStorage`	`deleteFilesOnDispose()` Configures the current `FileStreamStorage` to delete the underlying file after calling the `dispose()` ()} method.
`static FileStreamStorage`	`directToFile(File file, boolean append)` Returns a reference to a `FileStreamStorage` where the data is always written to the file specified.
`boolean`	`dispose()` Dismisses the `DeferredFileStreamStorage` closing quietly the `OutputStream` and deleting the underlying file if it exists.
`void`	`flush()`
`InputStream`	`getInputStream()` Returns the `InputStream` to read back data from the store.
`boolean`	`isInMemory()` Returns if the data has been flushed to disk or if it's still in memory.
`FileStreamStorage`	`maxCapacity(long maxCapacity)` Configures the current `FileStreamStorage` to accept up to `maxCapacity` bytes.
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int len)`
`void`	`write(int b)`

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

- Constructor Detail
  - FileStreamStorage
```
protected FileStreamStorage(File file,
                 int threshold,
                 boolean deleteFilesOnClose,
                 boolean deleteFilesOnDispose,
                 boolean append,
                 long maxCapacity)
```
    Constructor that sets the threshold to the user specified value.
    
    Parameters:
    file - The file that will be used to store the data if the threshold is reached.
    threshold - The threshold in bytes. Data smaller than the threshold are kept in memory. If the threshold is reached, the data is flushed to disk.
    deleteFilesOnClose - boolean indicating whether the file should be deleted after been read.
    deleteFilesOnDispose - boolean indicating whether the file should be deleted after dismiss has been called.
    maxCapacity - The maximum amount of bytes that the storage can accept. A value of -1 indicates infinite, the value 0 or a value lower that -1 is not accepted.
  - FileStreamStorage
```
protected FileStreamStorage(File file,
                 int threshold,
                 boolean append)
```
    Constructor that sets the threshold to the user specified value.
    
    Parameters:
    file - The file that will be used to store the data if the threshold is reached.
    threshold - The threshold in bytes. Data smaller than the threshold are kept in memory. If the threshold is reached, the data is flushed to disk.
- Method Detail
  - deferred
```
public static FileStreamStorage deferred(File file,
                         int threshold)
```
    Returns a reference to a FileStreamStorage where the data is written to a file when the data is greater in size than the threshold specified.
    
    Parameters:
    file - The file that will be used to store the data if the threshold is reached.
    threshold - The threshold in bytes. Data smaller than the threshold are kept in memory. If the threshold is reached, the data is flushed to the file.
    
    Returns:
    FileStreamStorage
  - directToFile
```
public static FileStreamStorage directToFile(File file,
                             boolean append)
```
    Returns a reference to a FileStreamStorage where the data is always written to the file specified.
    
    Parameters:
    file - The file that will be used to store the data.
    append - boolean that indicates whether any existing data in the file is going to be appended to or overridden.
    
    Returns:
    FileStreamStorage
  - deleteFilesOnClose
```
public FileStreamStorage deleteFilesOnClose()
```
    Configures the current FileStreamStorage to delete the underlying file after calling the close() method.
    
    Returns:
    The current object
  - deleteFilesOnDispose
```
public FileStreamStorage deleteFilesOnDispose()
```
    Configures the current FileStreamStorage to delete the underlying file after calling the dispose() ()} method.
    
    Returns:
    The current object
  - maxCapacity
```
public FileStreamStorage maxCapacity(long maxCapacity)
```
    Configures the current FileStreamStorage to accept up to maxCapacity bytes. If the threshold is exceeded the storage will throw an IllegalStateException
    
    Parameters:
    maxCapacity - The max capacity in bytes accepted by this storage. A value of -1 indicates infinite, the value 0 or a value lower that -1 is not accepted.
    
    Returns:
    The current object
  - write
```
public void write(int b)
           throws IOException
```
    Specified by:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b,
         int off,
         int len)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException
  - getInputStream
```
public InputStream getInputStream()
```
    Returns the InputStream to read back data from the store.
    
    Specified by:
    
    getInputStream in class StreamStorage
    
    Returns:
    the InputStream to read back data from the store.
  - isInMemory
```
public boolean isInMemory()
```
    Returns if the data has been flushed to disk or if it's still in memory.
    
    Returns:
    true if the data is in memory, false otherwise
  - dispose
```
public boolean dispose()
```
    Dismisses the DeferredFileStreamStorage closing quietly the OutputStream and deleting the underlying file if it exists. This method is useful just in case of errors to free the resources and once called the DeferredFileStreamStorage is not usable anymore.
    
    Returns:
    true if and only if the file was created and it has been deleted successfully; false otherwise.

Class FileStreamStorage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileStreamStorage

FileStreamStorage

Method Detail

deferred

directToFile

deleteFilesOnClose

deleteFilesOnDispose

maxCapacity

write

write

write

flush

close

getInputStream

isInMemory

dispose