com.sapportals.wcm.protocol.ice.protocol

Class InputOutputPipe

java.lang.Object
  extended by com.sapportals.wcm.protocol.ice.protocol.InputOutputPipe

public class InputOutputPipe
extends Object

InputOutputPipe is a helper class to convert an OutputStream to an InputStream. The pipe needs an IChunkedOutput writing its data in chunks to the OutputStream for correct operation.

Copyright 2004 SAP AG

See Also:
IChunkedOutput

Constructor Summary
InputOutputPipe(Object workUnit, boolean zip)
          Create a new InputOutputPipe.
 
Method Summary
 IAbortCondition getAbortCondition()
          Get the abort condition for the ICE item iterators.
 InputStream getInputStream(IChunkedOutput chunkedOutput)
          Get the InputStream of the pipe.
 OutputStream getOutputStream()
          Get the OutputStream of the pipe.
 void setAbortCondition(long maxBytes, Date expiration)
          Set the maximum number of bytes written to the pipe as well as an expiration date/time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputOutputPipe

public InputOutputPipe(Object workUnit,
                       boolean zip)
Create a new InputOutputPipe.

Parameters:
zip - true if the output should be compressed
Method Detail

setAbortCondition

public void setAbortCondition(long maxBytes,
                              Date expiration)
Set the maximum number of bytes written to the pipe as well as an expiration date/time.

Parameters:
maxBytes - The maximum number of bytes written to the pipe
expiration - The expiration date/time

getAbortCondition

public IAbortCondition getAbortCondition()
Get the abort condition for the ICE item iterators.

Returns:
The abort condition or null

getInputStream

public InputStream getInputStream(IChunkedOutput chunkedOutput)
Get the InputStream of the pipe. Note that the InputStream is the output of the pipe.

Parameters:
chunkedOutput - The IChunkedOutput which should be used to trigger the output of a chunk of data
Returns:
The IntputStream of the pipe

getOutputStream

public OutputStream getOutputStream()
Get the OutputStream of the pipe. Note that the OutputStream is the input of the pipe.

Returns:
The OutputStream of the pipe
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-CM [sap.com] tc/km/frwk api EP-KM-CM
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM


Copyright 2011 SAP AG Complete Copyright Notice