org.apache.synapse.message.processors.resequence

Class ResequencingProcessor

java.lang.Object

org.apache.synapse.message.processors.AbstractMessageProcessor

org.apache.synapse.message.processors.ScheduledMessageProcessor

org.apache.synapse.message.processors.resequence.ResequencingProcessor

All Implemented Interfaces:

ManagedLifecycle, MessageProcessor, Nameable, SynapseArtifact

public class ResequencingProcessor
extends ScheduledMessageProcessor

This class will be used as the processor of the resequencer and set up the necessary environment for the ResequencingJob. This should be run periodically after given time interval and for that this should be inherited from ScheduledMessageProcessor class

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.synapse.message.processors.ScheduledMessageProcessor

ScheduledMessageProcessor.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_DUPLICATES
static String	NEXT_SEQUENCE Sequence that the messages should be passed to
static String	REQ_INIT_MSGS Required initial number of messages
static String	REQ_INIT_MSGS_DELAY Delay until getting required number of messages receive
static String	SEQUENCE_NUMBER_XPATH xpath expression to extract the sequence number
static int	STARTING_NUMBER_INIT_DELAY Delay time period required for Resequencer processor while initializing starting sequence number
int	tried Number of times currently processor waited until required number of messages come Max value is determined by requiredInitMsgs variable value

Fields inherited from class org.apache.synapse.message.processors.ScheduledMessageProcessor

cronExpression, interval, PROCESSOR_INSTANCE, quartzConfig, SCHEDULED_MESSAGE_PROCESSOR_GROUP, scheduler, state

Fields inherited from class org.apache.synapse.message.processors.AbstractMessageProcessor

configuration, description, fileName, messageStore, name, parameters

Constructor Summary

Constructors

Constructor and Description
ResequencingProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activate the Resequencing processor Set the active value to true
void	deactivate() De-activate the resequencing processor Set the active value to false
void	destroy() Destroy the processor's resequencing job
boolean	getDeleteDuplicates() Check whether to delete duplicate messages or not
protected org.quartz.JobBuilder	getJobBuilder() Get the job details with Name and Job Class
protected org.quartz.JobDataMap	getJobDataMap() Get the map that contains parameters related to Resequencing job
int	getNextSeqNo() Returns the next sequence number
AtomicInteger	getRequiredInitMsgs() Get the number initial messages required before set starting sequence number
AtomicInteger	getRequiredInitMsgsDelay() Delay until requiredInitMsgs get set
void	incrementNextSeqNo() Increase the sequence number by one
void	init(SynapseEnvironment se) Initiate the processor with SynapseEnvironment
boolean	isActive() Check if the processor is active or not
AtomicBoolean	isInitSeqNo() Indicate whether the initial sequencer number is set
void	setDeleteDuplicates(AtomicBoolean deleteDuplicates) Set to delete duplicate messages
void	setInitSeqNo(AtomicBoolean initSeqNo) Set or clear the initSeqNo value
void	setNextSeqNo(int value) This method allow to change the value of nextSeqNo variable, which is used to determine the sequence number of the message next to go
void	setRequiredInitMsgs(AtomicInteger requiredInitMsgs) Set the number of messages required before set starting sequence number
void	setRequiredInitMsgsDelay(AtomicInteger requiredInitMsgsDelay) Set the delay until requiredInitMsgs get set

Methods inherited from class org.apache.synapse.message.processors.ScheduledMessageProcessor

setParameters, start, stop

Methods inherited from class org.apache.synapse.message.processors.AbstractMessageProcessor

getDescription, getFileName, getMessageStoreName, getName, getParameters, isStarted, setDescription, setFileName, setMessageStoreName, setName

Methods inherited from class java.lang.Object

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

Field Detail

SEQUENCE_NUMBER_XPATH

public static final String SEQUENCE_NUMBER_XPATH

xpath expression to extract the sequence number

See Also:

Constant Field Values

NEXT_SEQUENCE

public static final String NEXT_SEQUENCE

Sequence that the messages should be passed to

See Also:

Constant Field Values

REQ_INIT_MSGS

public static final String REQ_INIT_MSGS

Required initial number of messages

See Also:

Constant Field Values

REQ_INIT_MSGS_DELAY

public static final String REQ_INIT_MSGS_DELAY

Delay until getting required number of messages receive

See Also:

Constant Field Values

STARTING_NUMBER_INIT_DELAY

public static final int STARTING_NUMBER_INIT_DELAY

Delay time period required for Resequencer processor while initializing starting sequence number

See Also:

Constant Field Values

tried

public int tried

Number of times currently processor waited until required number of messages come Max value is determined by requiredInitMsgs variable value

DELETE_DUPLICATES

public static final String DELETE_DUPLICATES

See Also:

Constant Field Values

Constructor Detail

ResequencingProcessor

public ResequencingProcessor()

Method Detail

init

public void init(SynapseEnvironment se)

Initiate the processor with SynapseEnvironment

Specified by:

init in interface ManagedLifecycle

Overrides:

init in class ScheduledMessageProcessor

Parameters:

se - - SynapseEnvironment to be set

getJobBuilder

protected org.quartz.JobBuilder getJobBuilder()

Get the job details with Name and Job Class

Specified by:

getJobBuilder in class ScheduledMessageProcessor

Returns:

jobDetail - created JobDetail object with Name and JobClass

getJobDataMap

protected org.quartz.JobDataMap getJobDataMap()

Get the map that contains parameters related to Resequencing job

Overrides:

getJobDataMap in class ScheduledMessageProcessor

Returns:

jobDataMap - created Job Data Map along with the processor instance

destroy

public void destroy()

Destroy the processor's resequencing job

Specified by:

destroy in interface ManagedLifecycle

Overrides:

destroy in class ScheduledMessageProcessor

activate

public void activate()

Activate the Resequencing processor Set the active value to true

isActive

public boolean isActive()

Check if the processor is active or not

Returns:

active - boolean expression that tells the status of the processor

deactivate

public void deactivate()

De-activate the resequencing processor Set the active value to false

getNextSeqNo

public int getNextSeqNo()

Returns the next sequence number

Returns:

nextSeqNo - The sequence number of the message that to be send next

setNextSeqNo

public void setNextSeqNo(int value)

This method allow to change the value of nextSeqNo variable, which is used to determine the sequence number of the message next to go

Parameters:

value - - The value to set

incrementNextSeqNo

public void incrementNextSeqNo()

Increase the sequence number by one

isInitSeqNo

public AtomicBoolean isInitSeqNo()

Indicate whether the initial sequencer number is set

Returns:

initSeqNo - boolean value containing true or false

setInitSeqNo

public void setInitSeqNo(AtomicBoolean initSeqNo)

Set or clear the initSeqNo value

Parameters:

initSeqNo - - boolean value to set

getRequiredInitMsgs

public AtomicInteger getRequiredInitMsgs()

Get the number initial messages required before set starting sequence number

Returns:

requiredInitMsgs - int value of required messages

setRequiredInitMsgs

public void setRequiredInitMsgs(AtomicInteger requiredInitMsgs)

Set the number of messages required before set starting sequence number

Parameters:

requiredInitMsgs - - number of messages need to wait

getRequiredInitMsgsDelay

public AtomicInteger getRequiredInitMsgsDelay()

Delay until requiredInitMsgs get set

Returns:

requiredInitMessagesDelay delay value

setRequiredInitMsgsDelay

public void setRequiredInitMsgsDelay(AtomicInteger requiredInitMsgsDelay)

Set the delay until requiredInitMsgs get set

Parameters:

requiredInitMsgsDelay - - value for delay

getDeleteDuplicates

public boolean getDeleteDuplicates()

Check whether to delete duplicate messages or not

Returns:

value of deleteDuplicates

setDeleteDuplicates

public void setDeleteDuplicates(AtomicBoolean deleteDuplicates)

Set to delete duplicate messages

Parameters:

deleteDuplicates -