Uses of Interface
org.frankframework.core.IPipe

Packages that use IPipe

Package	Description
org.frankframework.cache
org.frankframework.collection
org.frankframework.compression
org.frankframework.core
org.frankframework.http.rest
org.frankframework.jdbc
org.frankframework.ldap
org.frankframework.management.bus.endpoints
org.frankframework.pipes
org.frankframework.processors
org.frankframework.soap

Uses of IPipe in org.frankframework.cache

Classes in org.frankframework.cache that implement IPipe

Modifier and Type	Class	Description
class	RemoveCacheKeyPipe	Remove specified cache key from cache with specified name.

Uses of IPipe in org.frankframework.collection

Classes in org.frankframework.collection that implement IPipe

Modifier and Type	Class	Description
class	AbstractCollectorPipe<C extends ICollector<P>,P>	Base class for pipes that can collect items, such as multipart messages and zip archives.

Uses of IPipe in org.frankframework.compression

Classes in org.frankframework.compression that implement IPipe

Modifier and Type	Class	Description
class	ZipIteratorPipe	Sends a message to a Sender for each entry of its input, that must be an ZipInputStream.
class	ZipWriterPipe	Pipe that creates a ZIP archive (on action close).

Uses of IPipe in org.frankframework.core

Subinterfaces of IPipe in org.frankframework.core

Modifier and Type	Interface	Description
interface	IDualModeValidator
interface	IValidator	Marker interface for Validators
interface	IWrapperPipe	Marker interface for Wrappers
interface	IXmlValidator

Classes in org.frankframework.core that implement IPipe

Modifier and Type	Class	Description
class	AbstractResponseValidatorWrapper<V extends AbstractValidator>	Wrapper for the response validator.

Methods in org.frankframework.core that return IPipe

Modifier and Type	Method	Description
IPipe	PipeLine.getPipe(int index)
IPipe	PipeLine.getPipe(String pipeName)
IPipe	PipeRunException.getPipeInError()

Methods in org.frankframework.core that return types with arguments of type IPipe

Modifier and Type	Method	Description
List<IPipe>	PipeLine.getPipes()

Methods in org.frankframework.core with parameters of type IPipe

Modifier and Type	Method	Description
void	PipeLine.addPipe(IPipe pipe)	Register a Pipe at this pipeline.
void	PipeLine.configure(IPipe pipe)
io.micrometer.core.instrument.DistributionSummary	PipeLine.getPipeSizeInStatistics(IPipe pipe)
io.micrometer.core.instrument.DistributionSummary	PipeLine.getPipeSizeOutStatistics(IPipe pipe)
io.micrometer.core.instrument.DistributionSummary	PipeLine.getPipeWaitStatistics(IPipe pipe)
IForwardTarget	PipeLine.resolveForward(IPipe pipe, PipeForward forward)	Find the destination of the forward, i.e. the object (Pipe or PipeLineExit) where the forward points to.
protected void	PipeLine.startPipe(String type, IPipe pipe)
protected void	PipeLine.stopPipe(String type, IPipe pipe)

Constructors in org.frankframework.core with parameters of type IPipe

Modifier	Constructor	Description
	PipeRunException(IPipe pipe, String msg)
	PipeRunException(IPipe pipe, String msg, Throwable e)

Uses of IPipe in org.frankframework.http.rest

Classes in org.frankframework.http.rest that implement IPipe

Modifier and Type	Class	Description
class	ApiPrincipalPipe	Pipe to manage the ApiPrincipal handling

Uses of IPipe in org.frankframework.jdbc

Classes in org.frankframework.jdbc that implement IPipe

Modifier and Type	Class	Description
class	BlobLineIteratingPipe	Pipe that iterates over the lines in a BLOB.
class	ClobLineIteratingPipe	Pipe that iterates over the lines in a CLOB.
class	JdbcIteratingPipeBase	Base class for JDBC iterating pipes.
class	LobLineIteratingPipeBase	abstract baseclass for Pipes that iterate over the lines in a lob.
class	ResultSetIteratingPipe	Pipe that iterates over rows in in ResultSet.

Uses of IPipe in org.frankframework.ldap

Classes in org.frankframework.ldap that implement IPipe

Modifier and Type	Class	Description
class	AbstractLdapQueryPipe	Base pipe for querying LDAP.
class	LdapChallengePipe	Deprecated, for removal: This API element is subject to removal in a future version.
class	LdapFindGroupMembershipsPipe	Pipe that returns the memberships of a userDN.
class	LdapFindMemberPipe	Pipe that checks if a specified dn exists as 'member' in another specified dn in LDAP.

Uses of IPipe in org.frankframework.management.bus.endpoints

Methods in org.frankframework.management.bus.endpoints that return IPipe

Modifier and Type	Method	Description
protected IPipe	BusEndpointBase.getPipeByName(Adapter adapter, String pipeName)

Uses of IPipe in org.frankframework.pipes

Classes in org.frankframework.pipes that implement IPipe

Modifier and Type	Class	Description
class	AbstractPipe	Base class for Pipe.
class	AbstractValidator	Pipe that validates the input message against a Schema.
static class	AbstractValidator.ResponseValidatorWrapper	Wrapper for the response validator.
class	AsyncSenderWithListenerPipe<M>	Sends a message using an asynchronous sender and receives a reply from a listener.
class	Base64Pipe	Pipe that performs base64 encoding and decoding.
class	BytesOutputPipe	Output bytes as specified by the input XML.
class	ChecksumPipe	Deprecated, for removal: This API element is subject to removal in a future version. please use the HashPipe
class	CompareIntegerPipe	Pipe that compares the two integer values.
class	CompareStringPipe	Pipe that lexicographically compares two strings, that must NOT be empty.
class	CompressPipe	Pipe to zip or unzip a message or file.
class	CounterSwitchPipe	Selects an exitState, based on the number of received messages by this pipe.
class	CredentialCheckingPipe	Pipe to check the the CredentialFactory (for testing only).
class	CrlPipe	Pipe that reads a CRL from an input stream and transforms it to an XML.
class	CsvParserPipe	Reads a message in CSV format, and turns it into XML.
class	DataSonnetPipe	Using .jsonnet transformation files, the DataSonnetPipe uses JSonnet at it's core to transform files from and to different file formats specified by supported outputTypes.
class	DelayPipe	Pipe that sleeps for a specified time, which defaults to 5000 msecs.
class	DomainTransformerPipe	Pipe that performs domain transforming on the basis of a database table.
class	EchoPipe	Returns simply the input message.
class	EscapePipe	Pipe that performs translations between special characters and their xml equivalents.
class	EtagHandlerPipe	Deprecated.
class	ExceptionPipe	Pipe that throws an exception, based on the input message.
class	FileLineIteratorPipe	Deprecated, for removal: This API element is subject to removal in a future version.
class	FilenameSwitch	Deprecated, for removal: This API element is subject to removal in a future version.
class	FixedForwardPipe	Provides a base-class for a Pipe that always has the same forward.
class	FixedResultPipe	This Pipe opens and returns a file from the classpath.
class	ForEachChildElementPipe	Sends a message to a Sender for each child element of the input XML.
class	ForPipe	ForPipe is a wrapper to use another pipe a fixed number of times.
class	GetFromSession	Gets the contents of the pipeLineSession by a key specified by sessionKey.
class	GetPrincipalPipe	Returns the name of the user executing the request.
class	HashPipe	This pipe can be used to generate a hash for the given message using an algorithm.
class	IfPipe	Selects a forward based on an expression.
class	IncreaseIntegerPipe	Pipe that increases the integer value of a session variable.
class	IsUserInRolePipe	Pipe that checks if the calling user has a specified role.
class	IsXmlPipe	Selects an exitState, based on if the input is a XML string.
class	IteratingPipe<I>	Base class to send a message to a Sender for each item returned by a configurable iterator.
class	Json2XmlValidator	Pipe that validates the XML or JSON input message against a XML Schema and returns either XML or JSON.
class	JsonPipe	JSON is not aware of the element order.
class	JsonValidator	Pipe that validates the input message against a JSON Schema.
class	JsonWellFormedChecker	Pipe that checks the well-formedness of the input message.
class	JsonXsltPipe	Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, XML or text.
class	JwtPipe	Creates a JWT with a shared secret using the HmacSHA256 algorithm.
class	LogContextPipe	Pipe that stores all its parameter values in the ThreadContext, formerly known as Mapped Diagnostic Context (MDC), to be used in logging.
class	MailSenderPipe	Pipe that sends a mail-message using a MailSender as its sender.
class	MessageSendingPipe
class	PasswordGeneratorPipe	Generates a random password.
class	PasswordHashPipe	Hash a password or validate a password against a hash using PasswordHash.java from https://crackstation.net/hashing-security.htm.
class	PGPPipe	Performs various PGP (Pretty Good Privacy) actions such as Encrypt, Sign, Decrypt, Verify.
class	PostboxRetrieverPipe	Deprecated, for removal: This API element is subject to removal in a future version.
class	PutInSession	Puts the input or the value in the PipeLineSession, under the key specified by sessionKey.
class	PutParametersInSession	Deprecated, for removal: This API element is subject to removal in a future version.
class	PutSystemDateInSession	Puts the system date/time under a key in the pipeLineSession.
class	RegExPipe	Tries to match the input against the provided regex.
class	RemoveFromSession	Removes a key specified by sessionKey from the pipeLineSession.
class	ReplacerPipe	This Pipe is used to replace values in a few ways.
class	SenderPipe	Sends a message using an sender and optionally receives a reply from the same sender.
class	SignaturePipe
class	SizePipe	Returns the number of bytes or characters in the input.
class	SkipPipe	Skip a number of bytes or characters from the input message.
class	Stream2StringPipe	Deprecated, for removal: This API element is subject to removal in a future version. not necessary when using Messages.
class	StreamLineIteratorPipe	Sends a message to a Sender for each line of its input, that must be an InputStream.
class	StreamPipe	Stream an input stream to an output stream.
class	StringIteratorPipe	IteratingPipe that has Strings as items.
class	Text2XmlPipe	Pipe for converting TEXT to XML.
class	TextSplitterPipe	Breaks up the text input in blocks of a maximum length.
class	TimeoutGuardPipe	Extension to FixedForwardPipe for interrupting processing when timeout is exceeded.
class	UnzipPipe	Assumes input to be the file name of a ZIP archive, and unzips it to a directory and/or an XML message.
class	UUIDGeneratorPipe	Pipe that generates an UUID (Universally Unique Identifier).
class	WsdlGeneratorPipe	Generate WSDL of parent or specified adapter.
class	WsdlXmlValidator	XmlValidator that will read the XSD's to use from a WSDL.
class	XmlBuilderPipe	Deprecated.
class	XmlFileElementIteratorPipe	Deprecated, for removal: This API element is subject to removal in a future version. Please replace with ForEachChildElementPipe.
class	XmlIf	Deprecated, for removal: This API element is subject to removal in a future version. please use the IfPipe for if (else/then) behaviour.
class	XmlSwitch	Selects an exitState, based on either the content of the input message, by means of a XSLT-stylesheet, the content of a session variable or, by default, by returning the name of the root-element.
class	XmlValidator	Pipe that validates the input message against an XML Schema.
static class	XmlValidator.ResponseValidatorWrapper	Wrapper for the XML response validator.
class	XmlWellFormedChecker	Pipe that checks the well-formedness of the input message.
class	XQueryPipe	Perform an XQuery.
class	XsltPipe	Perform an XSLT transformation with a specified stylesheet.

Uses of IPipe in org.frankframework.processors

Methods in org.frankframework.processors with parameters of type IPipe

Modifier and Type	Method	Description
PipeRunResult	AbstractPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession)
protected abstract PipeRunResult	AbstractPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
protected PipeRunResult	CheckMessageSizePipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
PipeRunResult	CorePipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession)
protected PipeRunResult	ExceptionHandlingPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
PipeRunResult	InputOutputPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession)
protected PipeRunResult	InputOutputPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)	Processes the pipe in the pipeline.
PipeRunResult	LimitingParallelExecutionPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession)
protected PipeRunResult	LimitingParallelExecutionPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
protected PipeRunResult	LockerPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
protected PipeRunResult	MonitoringPipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
PipeRunResult	PipeProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession)
protected PipeRunResult	TrackPreviousPipeInMetadataProcessor.processPipe(PipeLine pipeLine, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)
protected PipeRunResult	TransactionAttributePipeProcessor.processPipe(PipeLine pipeline, IPipe pipe, Message message, PipeLineSession pipeLineSession, ThrowingFunction<Message,PipeRunResult,PipeRunException> chain)

Uses of IPipe in org.frankframework.soap

Classes in org.frankframework.soap that implement IPipe

Modifier and Type	Class	Description
class	SoapValidator	XmlValidator that will automatically add the SOAP envelope XSD to the set of XSD's used for validation.
class	SoapWrapperPipe	Pipe to wrap or unwrap a message from/into a SOAP Envelope.