com.saperion.document

Class SaperionStoreContentInputStream

java.lang.Object

java.io.InputStream

com.saperion.document.SaperionStoreContentInputStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class SaperionStoreContentInputStream
extends InputStream
implements Serializable

This InputStream is used to transport content to store in a saperion document. It does all the necessary operations on the content like zipping, length determination and serialization.

Author:

jschwarz

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_MD_5
static String	NAME_SHA_512
static long	UNKNOWN_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
DocumentElementContentHash	getHash() This method returns a hash over the content of the document.
long	getStreamSize() This method returns the number of bytes the stream holds.
void	mark(int readlimit)
boolean	markSupported()
static SaperionStoreContentInputStream	newInstance(InputStream content, int chunkSize, int inMemoryBytes, File tempFileDirectory) This factory returns a SaperionStoreContentInputStream for the given input stream.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_SIZE

public static final long UNKNOWN_SIZE

See Also:

Constant Field Values

NAME_SHA_512

public static final String NAME_SHA_512

See Also:

Constant Field Values

NAME_MD_5

public static final String NAME_MD_5

See Also:

Constant Field Values

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
       int off,
       int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

getStreamSize

public long getStreamSize()

This method returns the number of bytes the stream holds. If the size is not known it returns UNKNOWN_SIZE.

Returns:

the number of bytes already read

getHash

public DocumentElementContentHash getHash()

This method returns a hash over the content of the document. If the hash is not known null is returned.

Returns:

a hash over the content of the document

newInstance

public static SaperionStoreContentInputStream newInstance(InputStream content,
                                          int chunkSize,
                                          int inMemoryBytes,
                                          File tempFileDirectory)

This factory returns a SaperionStoreContentInputStream for the given input stream. If content is null, null is returned. If content is a SerializableInputStream its wrapped stream is used instead. If content already is a SaperionStoreContentInputStream no new instance will be created.

Parameters:

content - the stream to create a SaperionStoreContentInputStream for

chunkSize - the size of the chunks in which the underlying stream is to serialize

inMemoryBytes - the size of the largest stream that should be streamed to memory

tempFileDirectory - the directory to store the temporary files to

Returns:

a SaperionStoreContentInputStream for the given input stream