com.saperion.operations.document

Class ReadContentStreamPart

java.lang.Object

com.lexmark.saperion.remote.common.operations.AbstractOperation<T,SaBasicException,LegacyConnection>

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

com.saperion.operations.document.ReadContentStreamPart

All Implemented Interfaces:

com.lexmark.saperion.remote.common.operations.Operation<byte[],SaBasicException,LegacyConnection>, Serializable

public class ReadContentStreamPart
extends LegacyOperation<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(com.lexmark.saperion.remote.common.session.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

Modifier and Type	Method and Description
byte[]	invoke()

Methods inherited from class com.saperion.operations.LegacyOperation

beforeInvoke, beforeInvoke, getClientToken, mapEcmException, mapException

Methods inherited from class com.lexmark.saperion.remote.common.operations.AbstractOperation

afterInvoke, getResult, toArrayList, toCaseInsensitiveMap, toHashMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lexmark.saperion.remote.common.operations.Operation

audit, dispatchEvent, isAuditable, isEventDispatcher

Constructor Detail

ReadContentStreamPart

public ReadContentStreamPart(com.lexmark.saperion.remote.common.session.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

Throws:

SaBasicException