nl.nn.adapterframework.core

Class PipeLine

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.core.PipeLine

All Implemented Interfaces:

ICacheEnabled<String,String>, HasTransactionAttribute, IConfigurationAware, IScopeProvider, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(value="Basic")
public class PipeLine
extends TransactionAttributes
implements ICacheEnabled<String,String>, HasStatistics, IConfigurationAware

Required in each Adapter to transform incoming messages. A pipeline is a sequence of pipes. A pipeline also defines its allowed end states using the <Exits> tag.

The pipes in a PipeLine may not be executed in sequential order, see PipeForward.

A pipeline gathers statistics about the messages it processes.

In the AppConstants there may be a property named log.logIntermediaryResults (true/false) which indicates whether the intermediary results (between calling pipes) have to be logged.

Transaction control

THE FOLLOWING TO BE UPDATED, attribute 'transacted' replaced by 'transactionAttribute' If transacted is set to true, messages will be processed under transaction control. Processing by XA-compliant pipes (i.e. Pipes that implement the IXAEnabled-interface, set their transacted-attribute to true and use XA-compliant resources) will then either be committed or rolled back in one transaction. If transacted is set to true, either an existing transaction (started by a transactional receiver) is joined, or new one is created (if the message processing request is not initiated by a receiver under transaction control. Messages are only committed or rolled back by the Pipeline if it started the transaction itself. If the pipeline joined an existing transaction, the commit or rollback is left to the object that started the transaction, i.e. the receiver. In the latter case the pipeline can indicate to the receiver that the transaction should be rolled back (by calling UserTransaction.setRollBackOnly()). The choice whether to either commit (by Pipeline or Receiver) or rollback (by Pipeline or Receiver) is made as follows: If the processing of the message concluded without exceptions and the status of the transaction is STATUS_ACTIVE (i.e. normal) the transaction will be committed. Otherwise it will be rolled back, or marked for roll back by the calling party.

Author:

Johan Verrips

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipeLine.ExitState

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SUCCESS_EXIT_NAME
static String	INPUT_VALIDATOR_NAME
static String	INPUT_WRAPPER_NAME
static String	OUTPUT_VALIDATOR_NAME
static String	OUTPUT_WRAPPER_NAME
static String	PIPELINE_DURATION_STATS
static String	PIPELINE_SIZE_STATS
static String	PIPELINE_WAIT_STATS

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Constructor Summary

Constructors

Constructor and Description
PipeLine()

Method Summary

Modifier and Type	Method and Description
void	addPipe(IPipe pipe) Register an Pipe at this pipeline.
boolean	configurationSucceeded()
void	configure() Configures the pipes of this Pipeline and does some basic checks.
void	configure(IPipe pipe)
PipeLineExit	findExitByState(PipeLine.ExitState state)
long	getMessageSizeWarnNum()
String	getName()
IPipe	getPipe(int index)
IPipe	getPipe(String pipeName)
int	getPipeLineSize()
StatisticsKeeper	getPipeSizeStatistics(INamedObject no)
StatisticsKeeper	getPipeSizeStatistics(IPipe pipe)
StatisticsKeeper	getPipeStatistics(INamedObject pipe)
StatisticsKeeper	getPipeWaitingStatistics(IPipe pipe)
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
PipeLineResult	process(String messageId, Message message, PipeLineSession pipeLineSession) The process method does the processing of a message. It retrieves the first pipe to execute from the firstPipe
void	registerExitHandler(IPipeLineExitHandler exitHandler)
void	registerForward(PipeForward forward) Deprecated.
void	registerPipeLineExit(PipeLineExit exit) Deprecated.
IForwardTarget	resolveForward(IPipe pipe, PipeForward forward) Find the destination of the forward, i.e.
void	setAdapter(Adapter adapter) Register the adapterName of this Pipelineprocessor.
void	setAdapterToRunBeforeOnEmptyInput(String s) Deprecated.
void	setCache(ICache<String,String> cache) Cache of results
void	setFirstPipe(String pipeName) Name of the first pipe to execute when a message is to be processed
void	setGlobalForwards(PipeForwards forwards) Global forwards
void	setInputValidator(IValidator inputValidator) Request validator, or combined validator for request and response
void	setInputWrapper(IWrapperPipe inputWrapper) Optional pipe to extract the request message from its envelope
void	setLocker(Locker locker) Optional Locker, to avoid parallel execution of the PipeLine by multiple threads on multiple servers.
void	setMaxThreads(int newMaxThreads) Maximum number of threads that may execute this Pipeline simultaneously, use 0 to disable limit
void	setMessageSizeWarn(String s) If messageSizeWarn>=0 and the size of the input or result pipe message exceeds the value specified a warning message is logged.
void	setOutputValidator(IValidator outputValidator) Optional pipe to validate the response.
void	setOutputWrapper(IWrapperPipe outputWrapper) Optional pipe to wrap the response message in an envelope
void	setOwner(INamedObject owner)
void	setPipeLineExits(PipeLineExits exits) PipeLine exits.
void	setStoreOriginalMessageWithoutNamespaces(boolean b) If set true the original message without namespaces (and prefixes) is stored under the session key originalMessageWithoutNamespaces
void	setTransformNullMessage(String s) when specified and null is received as a message the message is changed to the specified value
void	start()
protected void	startPipe(String type, IPipe pipe)
void	stop() Close the pipeline.
protected void	stopPipe(String type, IPipe pipe)
String	toString()

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.cache.ICacheEnabled

getCache

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

INPUT_VALIDATOR_NAME

public static final String INPUT_VALIDATOR_NAME

See Also:

Constant Field Values

OUTPUT_VALIDATOR_NAME

public static final String OUTPUT_VALIDATOR_NAME

See Also:

Constant Field Values

INPUT_WRAPPER_NAME

public static final String INPUT_WRAPPER_NAME

See Also:

Constant Field Values

OUTPUT_WRAPPER_NAME

public static final String OUTPUT_WRAPPER_NAME

See Also:

Constant Field Values

PIPELINE_DURATION_STATS

public static final String PIPELINE_DURATION_STATS

See Also:

Constant Field Values

PIPELINE_WAIT_STATS

public static final String PIPELINE_WAIT_STATS

See Also:

Constant Field Values

PIPELINE_SIZE_STATS

public static final String PIPELINE_SIZE_STATS

See Also:

Constant Field Values

DEFAULT_SUCCESS_EXIT_NAME

public static final String DEFAULT_SUCCESS_EXIT_NAME

See Also:

Constant Field Values

Constructor Detail

PipeLine

public PipeLine()

Method Detail

getPipe

public IPipe getPipe(String pipeName)

getPipe

public IPipe getPipe(int index)

registerExitHandler

public void registerExitHandler(IPipeLineExitHandler exitHandler)

configure

public void configure()
               throws ConfigurationException

Configures the pipes of this Pipeline and does some basic checks. It also registers the PipeLineSession object at the pipes.

Overrides:

configure in class TransactionAttributes

Throws:

ConfigurationException

See Also:

IPipe

configure

public void configure(IPipe pipe)
               throws ConfigurationException

Throws:

ConfigurationException

configurationSucceeded

public boolean configurationSucceeded()

findExitByState

public PipeLineExit findExitByState(PipeLine.ExitState state)

getPipeLineSize

public int getPipeLineSize()

Returns:

the number of pipes in the pipeline

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Throws:

SenderException

getPipeStatistics

public StatisticsKeeper getPipeStatistics(INamedObject pipe)

getPipeWaitingStatistics

public StatisticsKeeper getPipeWaitingStatistics(IPipe pipe)

getPipeSizeStatistics

public StatisticsKeeper getPipeSizeStatistics(IPipe pipe)

getPipeSizeStatistics

public StatisticsKeeper getPipeSizeStatistics(INamedObject no)

process

public PipeLineResult process(String messageId,
                              Message message,
                              PipeLineSession pipeLineSession)
                       throws PipeRunException

The process method does the processing of a message.
It retrieves the first pipe to execute from the firstPipe

Parameters:

message - The message as received from the Listener

messageId - A unique id for this message, used for logging purposes.

Returns:

the result of the processing.

Throws:

PipeRunException - when something went wrong in the pipes.

resolveForward

public IForwardTarget resolveForward(IPipe pipe,
                                     PipeForward forward)
                              throws PipeRunException

Find the destination of the forward, i.e. the object (Pipe or PipeLineExit) where the forward points to.

Throws:

PipeRunException

setAdapter

public void setAdapter(Adapter adapter)

Register the adapterName of this Pipelineprocessor.

Parameters:

adapter -

setOwner

public void setOwner(INamedObject owner)

start

public void start()
           throws PipeStartException

Throws:

PipeStartException

startPipe

protected void startPipe(String type,
                         IPipe pipe)
                  throws PipeStartException

Throws:

PipeStartException

stop

public void stop()

Close the pipeline. This will call the stop() method of all registered Pipes

See Also:

IPipe.stop()

stopPipe

protected void stopPipe(String type,
                        IPipe pipe)

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

toString

public String toString()

Overrides:

toString in class Object

Returns:

an enumeration of all pipenames in the pipeline and the startpipe and endpath

See Also:

setFirstPipe(java.lang.String)

setInputValidator

public void setInputValidator(IValidator inputValidator)

Request validator, or combined validator for request and response

setOutputValidator

public void setOutputValidator(IValidator outputValidator)

Optional pipe to validate the response. Can be specified if the response cannot be validated by the request validator

setInputWrapper

public void setInputWrapper(IWrapperPipe inputWrapper)

Optional pipe to extract the request message from its envelope

setOutputWrapper

public void setOutputWrapper(IWrapperPipe outputWrapper)

Optional pipe to wrap the response message in an envelope

setPipeLineExits

public void setPipeLineExits(PipeLineExits exits)

PipeLine exits. If no exits are specified, a default one is created with name="READY" and state="SUCCESS"

registerPipeLineExit

@Deprecated
public void registerPipeLineExit(PipeLineExit exit)

Deprecated.

PipeLine exits.

setGlobalForwards

public void setGlobalForwards(PipeForwards forwards)

Global forwards

registerForward

@Deprecated
public void registerForward(PipeForward forward)

Deprecated.

setLocker

public void setLocker(Locker locker)

Optional Locker, to avoid parallel execution of the PipeLine by multiple threads on multiple servers. The Pipeline is NOT executed (and is considered to have ended successfully) when the lock cannot be obtained, e.g. in case another thread, may be in another server, holds the lock and does not release it in a timely manner. If only the number of threads executing this PipeLine needs to be limited, the attribute maxThreads can be set instead, avoiding the database overhead.

setCache

public void setCache(ICache<String,String> cache)

Cache of results

Specified by:

setCache in interface ICacheEnabled<String,String>

addPipe

public void addPipe(IPipe pipe)
             throws ConfigurationException

Register an Pipe at this pipeline. The name is also put in the globalForwards table (with forward-name=pipename and forward-path=pipename, so that pipe can look for a specific pipe-name. If already a globalForward exists under that name, the pipe is NOT added, allowing globalForwards to prevail.

Throws:

ConfigurationException

See Also:

AbstractPipe

setFirstPipe

public void setFirstPipe(String pipeName)

Name of the first pipe to execute when a message is to be processed

Default value

first pipe of the pipeline

setMaxThreads

public void setMaxThreads(int newMaxThreads)

Maximum number of threads that may execute this Pipeline simultaneously, use 0 to disable limit

Default value

0

setStoreOriginalMessageWithoutNamespaces

public void setStoreOriginalMessageWithoutNamespaces(boolean b)

If set true the original message without namespaces (and prefixes) is stored under the session key originalMessageWithoutNamespaces

Default value

false

setMessageSizeWarn

public void setMessageSizeWarn(String s)

If messageSizeWarn>=0 and the size of the input or result pipe message exceeds the value specified a warning message is logged. You can specify the value with the suffixes KB, MB or GB

Default value

application default (3MB)

getMessageSizeWarnNum

public long getMessageSizeWarnNum()

setTransformNullMessage

public void setTransformNullMessage(String s)

when specified and null is received as a message the message is changed to the specified value

setAdapterToRunBeforeOnEmptyInput

@Deprecated
 @ConfigurationWarning(value="Please use an XmlIf-pipe and call a sub-adapter to retrieve a new/different response")
public void setAdapterToRunBeforeOnEmptyInput(String s)

Deprecated.

when specified and an empty message is received the specified adapter is run before passing the message (response from specified adapter) to the pipeline