nl.nn.adapterframework.core

Interface IPipe

All Superinterfaces:

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

All Known Subinterfaces:

IDualModeValidator, IExtendedPipe, IValidator, IWrapperPipe, IXmlValidator

All Known Implementing Classes:

AbstractPipe, Adios2XmlPipe, AmountOfPagesPipe, ApiPrincipalPipe, ApiSoapWrapperPipe, ApiStreamPipe, ApiWsdlXmlValidator, Base64Pipe, BatchBlobTransformerPipe, BatchClobTransformerPipe, BatchFileTransformerPipe, BatchTransformerPipeBase, BisWrapperPipe, BlobLineIteratingPipe, BytesOutputPipe, ChecksumPipe, CleanupOldFilesPipe, ClobLineIteratingPipe, CollectorPipeBase, CompareIntegerPipe, CompareStringPipe, CompressPipe, CoolGenWrapperPipe, CounterSwitchPipe, CreateRestViewPipe, CredentialCheckingPipe, CrlPipe, CsvParserPipe, DelayPipe, DirectWrapperPipe, DomainTransformerPipe, EchoPipe, EsbSoapValidator, EsbSoapWrapperPipe, EscapePipe, EtagHandlerPipe, ExceptionPipe, FileLineIteratorPipe, FilenameSwitch, FilePipe, FileSystemPipe, FixedForwardPipe, FixedResult, FixedResultPipe, ForEachAttachmentPipe, ForEachChildElementPipe, FxfWrapperPipe, FxfXmlValidator, GenericMessageSendingPipe, GetFromSession, GetLtpaTokenPipe, GetPrincipalPipe, GetTibcoQueues, HashPipe, IfMultipart, IncreaseIntegerPipe, IsUserInRolePipe, IsXmlIfPipe, IsXmlPipe, IteratingPipe, JdbcIteratingPipeBase, Json2XmlValidator, JsonPipe, JsonValidator, JsonWellFormedChecker, JsonXsltPipe, LabelFormat, LadybugPipe, LarvaPipe, LdapChallengePipe, LdapFindGroupMembershipsPipe, LdapFindMemberPipe, LdapQueryPipeBase, LobLineIteratingPipeBase, LocalFileSystemPipe, LogContextPipe, MailSenderPipe, MdcPipe, MessageSendingPipe, MoveFilePipe, PasswordGeneratorPipe, PasswordHashPipe, PdfPipe, PGPPipe, PostboxRetrieverPipe, PutInSession, PutParametersInSession, PutSystemDateInSession, RekenBoxCaller, RemoveCacheKeyPipe, RemoveFromSession, ReplacerPipe, ResultSetIteratingPipe, RhinoPipe, Samba1Pipe, Samba2Pipe, SambaPipe, SapLUWManager, ScanTibcoSolutionPipe, SenderPipe, SendTibcoMessage, SignaturePipe, SizePipe, SkipPipe, SoapValidator, SoapWrapperPipe, Stream2StringPipe, StreamingPipe, StreamLineIteratorPipe, StreamPipe, StreamTransformerPipe, StringIteratorPipe, Text2XmlPipe, TextSplitterPipe, TimeoutGuardPipe, UnzipPipe, UploadFilePipe, UUIDGeneratorPipe, ValidatorBase, ValidatorBase.ResponseValidatorWrapper, WsdlGeneratorPipe, WsdlGeneratorPipe, WsdlXmlValidator, XmlBuilderPipe, XmlFileElementIteratorPipe, XmlIf, XmlSwitch, XmlValidator, XmlValidator.ResponseValidatorWrapper, XmlWellFormedChecker, XQueryPipe, XsltPipe, ZipIteratorPipe, ZipWriterPipe

@FrankDocGroup(order=10,
               name="Pipes")
public interface IPipe
extends IConfigurable, IForwardTarget

A Pipe represents an action to take in a PipeLine.

Author:

Johan Verrips

Default element

nl.nn.adapterframework.pipes.SenderPipe

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.
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	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.

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

getName, setName

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

getApplicationContext, getName

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.IForwardTarget

getName

Method Detail

configure

void configure()
        throws ConfigurationException

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

Throws:

ConfigurationException

doPipe

PipeRunResult doPipe(Message message,
                     PipeLineSession session)
              throws PipeRunException

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.

Throws:

PipeRunException

getMaxThreads

int getMaxThreads()

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.

getForwards

Map<String,PipeForward> getForwards()

Get pipe forwards.

registerForward

void registerForward(PipeForward forward)
              throws ConfigurationException

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

Throws:

ConfigurationException - If the forward target cannot be registered.

See Also:

PipeLine, PipeForward

start

void start()
    throws PipeStartException

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

Throws:

PipeStartException

stop

void stop()

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

consumesSessionVariable

boolean consumesSessionVariable(String sessionKey)

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.