com.bmc.arsys.apitransport.chunking

Class ARChunkProcessorBase

java.lang.Object

com.bmc.arsys.apitransport.chunking.ARChunkProcessorBase

All Implemented Interfaces:

IARChunkable

Direct Known Subclasses:

ARChunkImport, ARChunkReceiveProcessor, ARChunkSendProcessor, ARChunkSetCreateSupportFile

public abstract class ARChunkProcessorBase
extends Object
implements IARChunkable

Base class for chunking processor 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHUNK_PROCESSOR_KEY

Constructor Summary

Constructors

Constructor and Description
ARChunkProcessorBase()

Method Summary

Modifier and Type	Method and Description
void	end() close any open resource
int	getRoundNumber()
boolean	hasNextRound()
void	init(Object input) initialize the chunk processor with the given argument
boolean	isFirstRound() Is current round is the first round of chunking
void	nextRound() Bump up the round count for next round of chunking,
void	setRoundNumber(int roundNumber)
void	setServerCharSetName(String serverCharSetName)
boolean	shouldRetry(int chunkingRound) retry can happen on different chunks even during the same API call.

Methods inherited from class java.lang.Object

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

Field Detail

CHUNK_PROCESSOR_KEY

public static String CHUNK_PROCESSOR_KEY

Constructor Detail

ARChunkProcessorBase

public ARChunkProcessorBase()

Method Detail

hasNextRound

public boolean hasNextRound()

Specified by:

hasNextRound in interface IARChunkable

Returns:

the chunkingDone

nextRound

public void nextRound()

Bump up the round count for next round of chunking,

Specified by:

nextRound in interface IARChunkable

isFirstRound

public boolean isFirstRound()

Is current round is the first round of chunking

Specified by:

isFirstRound in interface IARChunkable

getRoundNumber

public int getRoundNumber()

Specified by:

getRoundNumber in interface IARChunkable

Returns:

the printable round number starting from 1

setRoundNumber

public void setRoundNumber(int roundNumber)

Specified by:

setRoundNumber in interface IARChunkable

Parameters:

roundNumber - the round to set

setServerCharSetName

public void setServerCharSetName(String serverCharSetName)

Parameters:

serverCharSetName - the serverCharSetName to set

init

public void init(Object input)

initialize the chunk processor with the given argument

Specified by:

init in interface IARChunkable

end

public void end()

close any open resource

Specified by:

end in interface IARChunkable

shouldRetry

public boolean shouldRetry(int chunkingRound)

retry can happen on different chunks even during the same API call.

Parameters:

chunkingRound -

Returns: