org.jboss.soa.esb.actions.aggregator
Class AbstractAggregator

java.lang.Object
  org.jboss.soa.esb.actions.AbstractActionLifecycle
      org.jboss.soa.esb.actions.AbstractActionPipelineProcessor
          org.jboss.soa.esb.actions.aggregator.AbstractAggregator

All Implemented Interfaces:

ActionLifecycle, ActionPipelineProcessor

Direct Known Subclasses:

StreamingAggregator

public abstract class AbstractAggregator
extends AbstractActionPipelineProcessor

Abstract action class which defines how aggregation is processed but leaves abstract how messages are stored.

Author:

Kevin Conner

Field Summary

Fields inherited from interface org.jboss.soa.esb.actions.ActionPipelineProcessor

PROCESS_EXCEPTION_METHOD, PROCESS_METHOD, PROCESS_SUCCESS_METHOD

Constructor Summary

protected

AbstractAggregator(ConfigTree config)

Method Summary

protected abstract boolean	aggregateMessage(Message aggregatedMessage, java.lang.Integer messageSequence, Message currentMessage)
void	destroy() Destroy the action instance.
void	initialise() Initialise the action instance.
Message	process(Message message) Perform the action processing on the specified message.

Methods inherited from class org.jboss.soa.esb.actions.AbstractActionPipelineProcessor

processException, processSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAggregator

protected AbstractAggregator(ConfigTree config)
                      throws ConfigurationException

Throws:

ConfigurationException

Method Detail

initialise

public void initialise()
                throws ActionLifecycleException

Description copied from class: AbstractActionLifecycle

Initialise the action instance.

This method is called after the action instance has been instantiated so that configuration options can be validated.

Specified by:

initialise in interface ActionLifecycle

Overrides:

initialise in class AbstractActionLifecycle

Throws:

ActionLifecycleException - for errors during initialisation.

destroy

public void destroy()
             throws ActionLifecycleException

Description copied from class: AbstractActionLifecycle

Destroy the action instance.

This method is called prior to the release of the action instance. All resources associated with this action instance should be released as the instance will no longer be used.

Specified by:

destroy in interface ActionLifecycle

Overrides:

destroy in class AbstractActionLifecycle

Throws:

ActionLifecycleException

process

public Message process(Message message)
                throws ActionProcessingException

Description copied from interface: ActionPipelineProcessor

Perform the action processing on the specified message. This method is invoked for each message passing throught the pipeline.

Parameters:

message - The current message being processed.

Returns:

The message to be passed to the next stage of the pipeline.

Throws:

ActionProcessingException - for errors during processing.

aggregateMessage

protected abstract boolean aggregateMessage(Message aggregatedMessage,
                                            java.lang.Integer messageSequence,
                                            Message currentMessage)
                                     throws ActionProcessingException

Throws:

ActionProcessingException