com.cloudant.sync.datastore

Class AttachmentStreamFactory

java.lang.Object

com.cloudant.sync.datastore.AttachmentStreamFactory

public class AttachmentStreamFactory
extends java.lang.Object

Class to manage returning appropriate streams to access on disk attachments. These may be encrypted and/or gzip encoded. This class handles returning an appropriate input/output stream chain to handle this. The input stream returned will contain the unencrypted, unzipped representation of the data from disk. The output stream returned should have unencrypted, unzipped data written to its write method.

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Constructor Summary

Constructors

Constructor and Description
AttachmentStreamFactory(KeyProvider keyProvider) Creates a factory Attachment objects can use to read/write attachments.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream(java.io.File file, Attachment.Encoding encoding) Return a stream to be used to read from the file on disk.
java.io.OutputStream	getOutputStream(java.io.File file, Attachment.Encoding encoding) Get stream for writing attachment data to disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachmentStreamFactory

public AttachmentStreamFactory(KeyProvider keyProvider)

Creates a factory Attachment objects can use to read/write attachments.

Parameters:

keyProvider - Datastore's key provider object. This object can cope with key providers that return null keys.

Method Detail

getInputStream

public java.io.InputStream getInputStream(java.io.File file,
                                          Attachment.Encoding encoding)
                                   throws java.io.IOException

Return a stream to be used to read from the file on disk. Stream's bytes will be unzipped, unencrypted attachment content.

Parameters:

file - File object to read from.

encoding - Encoding of attachment.

Returns:

Stream for reading attachment data.

Throws:

java.io.IOException - if there's a problem reading from disk, including issues with encryption (bad key length and other key issues).

getOutputStream

public java.io.OutputStream getOutputStream(java.io.File file,
                                            Attachment.Encoding encoding)
                                     throws java.io.IOException

Get stream for writing attachment data to disk. Opens the output stream using FileUtils.openOutputStream(File). Data should be written to the stream unencoded, unencrypted.

Parameters:

file - File to write to.

encoding - Encoding to use.

Returns:

Stream for writing.

Throws:

java.io.IOException - if there's a problem writing to disk, including issues with encryption (bad key length and other key issues).

See Also:

FileUtils.openOutputStream(File)