org.apache.chemistry.opencmis.commons.server

Class TempStoreOutputStream

java.lang.Object

java.io.OutputStream

org.apache.chemistry.opencmis.commons.server.TempStoreOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public abstract class TempStoreOutputStream
extends OutputStream

Subclasses of this class are used to store document content for a short period of time. The OpenCMIS server framework creates such a new stream when it needs to offload document content for a moment. That can happen when a document is created, new content is set for an existing document, or a new document version is created. How and where subclasses of this output stream store the content is not specified. The getInputStream() and getLength() methods are not called before all bytes have been written to this output stream and the OutputStream.close() method has been called. The destroy(Throwable) method can be called at any time and indicates that this stream is not needed anymore and attached resources can be cleaned up.

Constructor Summary

Constructors

Constructor and Description
TempStoreOutputStream()

Method Summary

Modifier and Type	Method and Description
abstract void	destroy(Throwable cause) This method is called if the stream has to be released before it is fully written or read.
abstract InputStream	getInputStream() Returns an InputStream that serves the content that has been provided to this TempStoreOutputStream instance.
abstract long	getLength() Returns the length of the stream in bytes.
abstract void	setFileName(String filename) Sets the file name.
abstract void	setMimeType(String mimeType) Sets the MIME type of the stream.

Methods inherited from class java.io.OutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TempStoreOutputStream

public TempStoreOutputStream()

Method Detail

setMimeType

public abstract void setMimeType(String mimeType)

Sets the MIME type of the stream. This method is usually be called once before getInputStream() is called. It might never be called if the MIME type is unknown or multiple times if previous MIME type detections were inaccurate.

Parameters:

mimeType - the MIME type or null if the MIME type is unknown or should be reset to unknown

setFileName

public abstract void setFileName(String filename)

Sets the file name. This method is usually be called once before getInputStream() is called. It might never be called if the file name is unknown.

Parameters:

filename - the file name or null if the file name is unknown or should be reset to unknown

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

Returns an InputStream that serves the content that has been provided to this TempStoreOutputStream instance. If this method is called multiple times, the same InputStream object must be returned. Implementations should clean up all attached resources when this stream is closed.

Returns:

the input stream

Throws:

IOException - if the input stream could not be created

getLength

public abstract long getLength()

Returns the length of the stream in bytes.

Returns:

the length of the stream

destroy

public abstract void destroy(Throwable cause)

This method is called if the stream has to be released before it is fully written or read. Implementations should clean up all attached resources.

Parameters:

cause - the throwable that caused the call of this method or null if no throwable object is available