org.apache.chemistry.opencmis.server.shared

Class ThresholdOutputStream

java.lang.Object

java.io.OutputStream

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

org.apache.chemistry.opencmis.server.shared.ThresholdOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ThresholdOutputStream
extends TempStoreOutputStream

An OutputStream that stores the data in main memory until it reaches a threshold. If the threshold is passed the data is written to a temporary file. It it is important to close this OutputStream before getInputStream() is called or call #destroy() if the InputStream isn't required!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ThresholdOutputStream.ThresholdInputStream Provides information about the input stream.

Constructor Summary

Constructors

Constructor and Description
ThresholdOutputStream(File tempDir, int memoryThreshold, long maxContentSize) Constructor.
ThresholdOutputStream(File tempDir, int memoryThreshold, long maxContentSize, boolean encrypt) Constructor.
ThresholdOutputStream(int initSize, File tempDir, int memoryThreshold, long maxContentSize, boolean encrypt) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	destroy(Throwable cause) Destroys the object before it has been read.
void	flush()
String	getFileName()
InputStream	getInputStream() Returns the data as an InputStream.
long	getLength() Returns the length of the stream in bytes.
String	getMimeType()
void	setFileName(String filename) Sets the file name.
void	setMimeType(String mimeType) Sets the MIME type of the stream.
void	write(byte[] buffer)
void	write(byte[] buffer, int offset, int len)
void	write(int oneByte)

Methods inherited from class java.lang.Object

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

Constructor Detail

ThresholdOutputStream

public ThresholdOutputStream(File tempDir,
                     int memoryThreshold,
                     long maxContentSize)

Constructor.

Parameters:

tempDir - temp directory or null for the default temp directory

memoryThreshold - memory threshold in bytes

maxContentSize - max size of the content in bytes (-1 to disable the check)

ThresholdOutputStream

public ThresholdOutputStream(File tempDir,
                     int memoryThreshold,
                     long maxContentSize,
                     boolean encrypt)

Constructor.

Parameters:

tempDir - temp directory or null for the default temp directory

memoryThreshold - memory threshold in bytes

maxContentSize - max size of the content in bytes (-1 to disable the check)

ThresholdOutputStream

public ThresholdOutputStream(int initSize,
                     File tempDir,
                     int memoryThreshold,
                     long maxContentSize,
                     boolean encrypt)

Constructor.

Parameters:

initSize - initial internal buffer size

tempDir - temp directory or null for the default temp directory

memoryThreshold - memory threshold in bytes

maxContentSize - max size of the content in bytes (-1 to disable the check)

encrypt - indicates if temporary files must be encrypted

Method Detail

setMimeType

public void setMimeType(String mimeType)

Description copied from class: TempStoreOutputStream

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

Specified by:

setMimeType in class TempStoreOutputStream

Parameters:

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

getMimeType

public String getMimeType()

setFileName

public void setFileName(String filename)

Description copied from class: TempStoreOutputStream

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

Specified by:

setFileName in class TempStoreOutputStream

Parameters:

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

getFileName

public String getFileName()

getLength

public long getLength()

Description copied from class: TempStoreOutputStream

Returns the length of the stream in bytes.

Specified by:

getLength in class TempStoreOutputStream

Returns:

the length of the stream

write

public void write(byte[] buffer)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] buffer,
         int offset,
         int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int oneByte)
           throws IOException

Specified by:

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

destroy

public void destroy(Throwable cause)

Destroys the object before it has been read.

Specified by:

destroy in class TempStoreOutputStream

Parameters:

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

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns the data as an InputStream.

Specified by:

getInputStream in class TempStoreOutputStream

Throws:

IOException