com.saperion.document.content.stream

Class RemoteDocumentContentInputStream

java.lang.Object

java.io.InputStream

com.saperion.document.content.stream.RemoteDocumentContentInputStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class RemoteDocumentContentInputStream
extends InputStream
implements Serializable

An InputStream that streams the content of a DocumentElementType remotely from the medium.

Author:

jschwarz

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static RemoteDocumentContentInputStream	newInstance(Connection connection, SessionDataKey remoteStreamKey)
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
static InputStream	readDocument(Connection connection, com.lexmark.saperion.document.DocumentReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId) For a given Connection and document element id this method creates an InputStream that streams the document elements content.

Methods inherited from class java.io.InputStream

available, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

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

readDocument

public static InputStream readDocument(Connection connection,
                       com.lexmark.saperion.document.DocumentReferenceType documentId,
                       com.lexmark.saperion.document.DocumentElementReferenceType documentElementId)
                                throws SaBasicException

For a given Connection and document element id this method creates an InputStream that streams the document elements content. It is assumed that the given document element id references an element of type content

Parameters:

connection - the connection to use for streaming

documentId - the id of the document the document element to read belongs to

documentElementId - the id of the document element with the content to stream

Returns:

an InputStream that streams the document elements content

Throws:

SaAuthenticationException

SaSystemException

SaBasicException

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

newInstance

public static RemoteDocumentContentInputStream newInstance(Connection connection,
                                           SessionDataKey remoteStreamKey)