com.bmc.arsys.apitransport.chunking

Class ARChunkReceiveProcessor

java.lang.Object

com.bmc.arsys.apitransport.chunking.ARChunkProcessorBase

com.bmc.arsys.apitransport.chunking.ARChunkReceiveProcessor

All Implemented Interfaces:

IARChunkable, IARChunkReceivable

Direct Known Subclasses:

ARChunkArrayBuffer, ARChunkGetListEntry, ARChunkGetMultipleEntries, ARChunkGetSupportFile

public abstract class ARChunkReceiveProcessor
extends ARChunkProcessorBase
implements IARChunkReceivable

Process the AR chunking data for Rpc receiving chunking calls. It also contains post process for decompression if needed on the chunking returned data.

Field Summary

Fields inherited from class com.bmc.arsys.apitransport.chunking.ARChunkProcessorBase

CHUNK_PROCESSOR_KEY

Constructor Summary

Constructors

Constructor and Description
ARChunkReceiveProcessor()

Method Summary

Modifier and Type	Method and Description
void	postProcess(com.bmc.arsys.arrpc.xdr.ArRpcXdrOut out) post process the data collected from all rounds.
void	retrieveChunkingData(com.bmc.arsys.arrpc.xdr.ArRpcXdrOut out) retrieve the current chunk from the rpc out, and append it to ones received before.

Methods inherited from class com.bmc.arsys.apitransport.chunking.ARChunkProcessorBase

end, getRoundNumber, hasNextRound, init, isFirstRound, nextRound, setRoundNumber, setServerCharSetName, shouldRetry

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bmc.arsys.apitransport.chunking.IARChunkable

end, getRoundNumber, hasNextRound, init, isFirstRound, nextRound, setRoundNumber

Constructor Detail

ARChunkReceiveProcessor

public ARChunkReceiveProcessor()

Method Detail

retrieveChunkingData

public void retrieveChunkingData(com.bmc.arsys.arrpc.xdr.ArRpcXdrOut out)
                          throws ARException

retrieve the current chunk from the rpc out, and append it to ones received before. The concrete sub class overrides this method to implement the composition logic unique to each chunking calls. If caller need reserve any object among chunking calls other than chunking process internal reserved objects, caller can use ApiThreadLocalStorageBlock.setInternalChunkingObj(), which is available among all chunks and thread safe.

Specified by:

retrieveChunkingData in interface IARChunkReceivable

Throws:

ARException

postProcess

public void postProcess(com.bmc.arsys.arrpc.xdr.ArRpcXdrOut out)
                 throws ARException

post process the data collected from all rounds. Concrete sub classes overrides this method to update its corresponding rpc out with the object composed from all trips of this chunking call. If inflation is required on the output bytes, we inflate the bytes here.

Specified by:

postProcess in interface IARChunkReceivable

Parameters:

out -

Throws:

ARException