nl.nn.adapterframework.pipes

Class ValidatorBase.ResponseValidatorWrapper

java.lang.Object

nl.nn.adapterframework.pipes.ValidatorBase.ResponseValidatorWrapper

All Implemented Interfaces:

IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IValidator, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Enclosing class:

ValidatorBase

public static class ValidatorBase.ResponseValidatorWrapper
extends Object
implements IValidator

Field Summary

Fields

Modifier and Type	Field and Description
protected ValidatorBase	owner

Constructor Summary

Constructors

Constructor and Description
ResponseValidatorWrapper(ValidatorBase owner)

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once after the PipeLine is registered at the Adapter.
boolean	consumesSessionVariable(String sessionKey) returns true if the pipe or one of its children use the named session variable.
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
org.springframework.context.ApplicationContext	getApplicationContext()
ClassLoader	getConfigurationClassLoader() This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
Map<String,PipeForward>	getForwards() Get pipe forwards.
int	getMaxThreads() Indicates the maximum number of threads that may call doPipe() simultaneously.
void	registerForward(PipeForward forward) Register a PipeForward object to this Pipe.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	start() Perform necessary action to start the pipe.
void	stop() Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.
PipeRunResult	validate(Message message, PipeLineSession session, String messageRoot)

Methods inherited from class java.lang.Object

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

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

setName

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

getName

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

getName

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

getName

Field Detail

owner

protected ValidatorBase owner

Constructor Detail

ResponseValidatorWrapper

public ResponseValidatorWrapper(ValidatorBase owner)

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IPipe

configure() is called once after the PipeLine is registered at the Adapter. Purpose of this method is to reduce creating connections to databases etc. in the doPipe() method. As much as possible class-instantiating should take place in the configure() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message message,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Throws:

PipeRunException

validate

public PipeRunResult validate(Message message,
                              PipeLineSession session,
                              String messageRoot)
                       throws PipeRunException

Specified by:

validate in interface IValidator

Throws:

PipeRunException

getMaxThreads

public int getMaxThreads()

Description copied from interface: IPipe

Indicates the maximum number of threads that may call doPipe() simultaneously. A value of 0 indicates an unlimited number of threads. Pipe implementations that are not thread-safe, i.e. where doPipe() may only be called by one thread at a time, should make sure getMaxThreads always returns a value of 1.

Specified by:

getMaxThreads in interface IPipe

getForwards

public Map<String,PipeForward> getForwards()

Description copied from interface: IPipe

Get pipe forwards.

Specified by:

getForwards in interface IPipe

registerForward

public void registerForward(PipeForward forward)

Description copied from interface: IPipe

Register a PipeForward object to this Pipe. Global Forwards are added by the PipeLine. If a forward is already registered, it logs a warning.

Specified by:

registerForward in interface IPipe

See Also:

PipeLine, PipeForward

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Throws:

PipeStartException

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface IConfigurationAware

getConfigurationClassLoader

public ClassLoader getConfigurationClassLoader()

Description copied from interface: IScopeProvider

This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.

Specified by:

getConfigurationClassLoader in interface IScopeProvider

Returns:

returns the ClassLoader created by the ClassLoaderManager.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: IPipe

returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface IPipe