org.apache.chemistry.opencmis.client.runtime.util

Class AppendOutputStream

java.lang.Object

java.io.OutputStream

org.apache.chemistry.opencmis.client.runtime.util.AppendOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class AppendOutputStream
extends OutputStream

This OutputStream allows overwriting and appending to the content of a document. This class is a convenience layer on top of the CMIS setContentStream() and appendContentStream() operations. It provides the glue to other (legacy) interfaces that know how to work with standard streams. However, calling setContentStream() and appendContentStream() directly provides more control and may be more efficient than using this class. Data written to this stream is buffered. The default buffer size is 64 KiB. The data is send to the repository if the buffer is full, or flush() is called, or close() is called. Because sending data to the repository requires a HTTP call, this should be triggered only when necessary. Depending on the use case, the buffer size should be increased. If the overwrite mode is enabled, the first call is a setContentStream() call, which overwrites the existing content. All following calls are appendContentStream() calls. If the overwrite mode is not enabled, all calls are appendContentStream() calls. If the document is versioned, it's the responsibility of the caller to check it out and check it in. If the document is auto-versioned, each chunk of bytes may create a new version. If the repository supports change tokens and the provided document has a non-empty change token property (cmis:changeToken), change tokens are respected. This class is not thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationContext	DOCUMENT_OPERATION_CONTEXT

Constructor Summary

Constructors

Constructor and Description
AppendOutputStream(Session session, Document doc, boolean overwrite, String filename, String mimeType)
AppendOutputStream(Session session, Document doc, boolean overwrite, String filename, String mimeType, int bufferSize) Creates an OutputStream that appends content to a document.

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(boolean isLastChunk) Closes the stream.
void	flush()
void	flush(boolean isLastChunk) Appends (or sets) the current buffer to the document.
protected void	send(boolean isLastChunk) Updates the document content with the provided content stream.
protected void	send(byte[] extraBytes, int extraOff, int extraLen, boolean isLastChunk) Updates the document content with the provided content stream.
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

Field Detail

DOCUMENT_OPERATION_CONTEXT

public static final OperationContext DOCUMENT_OPERATION_CONTEXT

Constructor Detail

AppendOutputStream

public AppendOutputStream(Session session,
                          Document doc,
                          boolean overwrite,
                          String filename,
                          String mimeType)

AppendOutputStream

public AppendOutputStream(Session session,
                          Document doc,
                          boolean overwrite,
                          String filename,
                          String mimeType,
                          int bufferSize)

Creates an OutputStream that appends content to a document.

Parameters:

session - the session object, must not be null

doc - the document, must not be null

overwrite - if true the first call to repository sets a new content, if false the all calls append to the current content

filename - the file name, may be null

mimeType - the MIME type, may be null

bufferSize - buffer size

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

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

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

flush

public void flush(boolean isLastChunk)
           throws IOException

Appends (or sets) the current buffer to the document.

Parameters:

isLastChunk - indicates if this is the last chunk of the content

Throws:

IOException - if an error occurs

send

protected void send(boolean isLastChunk)
             throws IOException

Updates the document content with the provided content stream.

Throws:

IOException

send

protected void send(byte[] extraBytes,
                    int extraOff,
                    int extraLen,
                    boolean isLastChunk)
             throws IOException

Updates the document content with the provided content stream.

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

close

public void close(boolean isLastChunk)
           throws IOException

Closes the stream.

Parameters:

isLastChunk - indicates if this is the last chunk of the content

Throws:

IOException - if an error occurs