com.saperion.operations.document

Class ReadContentStreamPart

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<byte[]>

com.saperion.operations.document.ReadContentStreamPart

All Implemented Interfaces:

Operation<byte[]>, Serializable

public class ReadContentStreamPart
extends AbstractOperation<byte[]>

An Operation that reads the next n bytes from a remote stream attached to a session.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReadContentStreamPart(SessionDataKey streamKey, int numberOfBytesToRead) This creates a new operation that reads the given number of bytes from the stream the current session has stored with the given key.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	invoke() The method that will be called on the server side.

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList, toString

Methods inherited from class com.saperion.operations.BaseOperation

beforeInvoke, getClientToken, mapException

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadContentStreamPart

public ReadContentStreamPart(SessionDataKey streamKey,
                     int numberOfBytesToRead)

This creates a new operation that reads the given number of bytes from the stream the current session has stored with the given key. Like InputStream.read(byte[], int, int) it is possible for various reasons that a number of bytes will be read that is less than the given number. The invoke method will return a array with exactly the bytes read, so its length will be the number of bytes read.

Parameters:

streamKey - The key with which the current session associates the stream to read from. Must not be null.

numberOfBytesToRead - the number of bytes to read from the stream. Must be greater than 0.

Method Detail

invoke

public byte[] invoke()
              throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation