Uses of Interface
org.frankframework.core.FrankElement

Packages that use FrankElement

Package	Description
org.frankframework.cache
org.frankframework.collection
org.frankframework.compression
org.frankframework.configuration
org.frankframework.core
org.frankframework.http
org.frankframework.http.rest
org.frankframework.jdbc
org.frankframework.jms
org.frankframework.ldap
org.frankframework.mongodb
org.frankframework.monitoring
org.frankframework.parameters
org.frankframework.pipes
org.frankframework.receivers
org.frankframework.scheduler
org.frankframework.scheduler.job
org.frankframework.senders
org.frankframework.soap
org.frankframework.statistics
org.frankframework.util
org.frankframework.validation

Uses of FrankElement in org.frankframework.cache

Subinterfaces of FrankElement in org.frankframework.cache

Modifier and Type	Interface	Description
interface	ICache<K,V>	Interface to be implemented by cache-providers.

Classes in org.frankframework.cache that implement FrankElement

Modifier and Type	Class	Description
class	AbstractCacheAdapter<V>	Baseclass for caching.
class	EhCache<V>	General Cache provider.
class	RemoveCacheKeyPipe	Remove specified cache key from cache with specified name.

Uses of FrankElement in org.frankframework.collection

Classes in org.frankframework.collection that implement FrankElement

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.
class	AbstractCollectorSender<C extends ICollector<P>,P>	Sender that writes an item to a collection, created by AbstractCollectorPipe with action=OPEN.

Uses of FrankElement in org.frankframework.compression

Classes in org.frankframework.compression that implement FrankElement

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).
class	ZipWriterSender	Sender that writes an entry to a ZipStream, similar to ZipWriterPipe with action='write'.

Uses of FrankElement in org.frankframework.configuration

Classes in org.frankframework.configuration that implement FrankElement

Modifier and Type	Class	Description
class	Configuration	Container of Adapters that belong together.

Uses of FrankElement in org.frankframework.core

Subinterfaces of FrankElement in org.frankframework.core

Modifier and Type	Interface	Description
interface	CanUseSharedResource<T>
interface	IBlockEnabledSender<H>	Allows to leverage sending messages in blocks.
interface	ICorrelatedPullingListener<M>	Additional behaviour for pulling listeners that are able to listen to a specific message, specified by a correlation ID.
interface	ICorrelatedSender	Marker interface for correlated sender, used in Receiver.
interface	IDualModeValidator
interface	IKnowsDeliveryCount<M>	Interface to be implemented by Listeners that can find out the delivery count of the messages they receive.
interface	IListener<M>	Base-interface for IPullingListener and IPushingListener.
interface	IPeekableListener<M>	PullingListener extension that checks for available messages to retrieve without starting a XA transaction.
interface	IPipe	A Pipe represents an action to take in a PipeLine.
interface	IPortConnectedListener<M>	Interface extending IPushingListener for listeners which connect to a ListenerPort or other type of named endpoint, from which they receive their messages.
interface	IPullingListener<M>	Defines listening behaviour of pulling receivers.
interface	IPushingListener<M>	Defines listening behaviour of message driven receivers.
interface	IRedeliveringListener<M>
interface	ISender	Marks an implementation as responsible for sending a message to some destination.
interface	ISenderWithParameters	Allows Senders to declare that they accept and may use parameters
interface	IValidator	Marker interface for Validators
interface	IWrapperPipe	Marker interface for Wrappers
interface	IXmlValidator

Classes in org.frankframework.core that implement FrankElement

Modifier and Type	Class	Description
class	AbstractResponseValidatorWrapper<V extends AbstractValidator>	Wrapper for the response validator.
class	Adapter	The Adapter is the central manager in the framework.
class	PipeLine	Required in each Adapter to transform incoming messages.

Uses of FrankElement in org.frankframework.http

Classes in org.frankframework.http that implement FrankElement

Modifier and Type	Class	Description
class	AbstractHttpSender	Sender for the HTTP protocol using HttpMethod.
class	AbstractHttpSession	Note 1: Some certificates require the <java_home>/jre/lib/security/xxx_policy.jar files to be upgraded to unlimited strength.
class	HttpSender	Sender for the HTTP protocol using HttpMethod.
class	HttpSession	Shared HTTPSession, implements SharedResource so it can be set in the Configuration.xml
class	PushingListenerAdapter	Baseclass of a IPushingListener that enables a Receiver to receive messages from Servlets.
class	RestListener	Listener that allows a Receiver to receive messages as a REST webservice.
class	WebServiceListener	Listener that allows a Receiver to receive messages as a SOAP webservice.
class	WebServiceSender	Sender that sends a message via a WebService.

Constructors in org.frankframework.http with parameters of type FrankElement

Modifier	Constructor	Description
	MicrometerHttpClientInterceptor(MetricsInitializer configurationMetrics, FrankElement parentFrankElement, Function<org.apache.http.HttpRequest,String> uriMapper, boolean exportTagsForRoute)	Create a MicrometerHttpClientInterceptor instance.

Uses of FrankElement in org.frankframework.http.rest

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

Modifier and Type	Class	Description
class	ApiListener	Listener that allows a Receiver to receive messages as a REST webservice.
class	ApiPrincipalPipe	Pipe to manage the ApiPrincipal handling

Uses of FrankElement in org.frankframework.jdbc

Classes in org.frankframework.jdbc that implement FrankElement

Modifier and Type	Class	Description
class	AbstractJdbcQuerySender<H>	This executes the query that is obtained from the (here still abstract) method getStatement.
class	AbstractJdbcSender<H>	Base class for building JDBC-senders.
class	BlobLineIteratingPipe	Pipe that iterates over the lines in a BLOB.
class	ClobLineIteratingPipe	Pipe that iterates over the lines in a CLOB.
class	DirectQuerySender	QuerySender that interprets the input message as a query, possibly with attributes.
class	FixedQuerySender	QuerySender that assumes a fixed query, possibly with attributes.
class	JdbcIteratingPipeBase	Base class for JDBC iterating pipes.
protected class	JdbcIteratingPipeBase.MixedQuerySender
class	JdbcListener<M>	JdbcListener base class.
class	JdbcQueryListener	Deprecated, for removal: This API element is subject to removal in a future version.
class	JdbcTableListener<M>	Database Listener that operates on a table having at least a key and a status field.
class	LobLineIteratingPipeBase	abstract baseclass for Pipes that iterate over the lines in a lob.
class	MessageStoreListener	Read messages from the IBISSTORE database table previously stored by a MessageStoreSender.
class	MessageStoreSender	Send messages to the IBISSTORE database table to have them processed exactly-once by another adapter which will read the messages using a MessageStoreListener.
class	ResultSet2FileSender	QuerySender that writes each row in a ResultSet to a file.
class	ResultSetIteratingPipe	Pipe that iterates over rows in in ResultSet.
class	SimpleJdbcListener	Database Listener that returns a count of messages available, but does not perform any locking or other management of processing messages in parallel.
class	StoredProcedureQuerySender	StoredProcedureQuerySender is used to send stored procedure queries and retrieve the result.
class	XmlQuerySender	QuerySender that transforms the input message to a query.

Uses of FrankElement in org.frankframework.jms

Classes in org.frankframework.jms that implement FrankElement

Modifier and Type	Class	Description
class	AbstractJmsListener	Common baseclass for Pulling and Pushing JMS Listeners.
class	JmsListener	A true multi-threaded Listener-class.
class	JmsSender	This class sends messages with JMS.
class	PullingJmsListener	A true multi-threaded Listener-class.
class	PushingJmsListener	JMSListener re-implemented as a pushing listener rather than a pulling listener.
class	XmlJmsBrowserSender	Sender for browsing and removing queue messages (with input and output in a XML message).

Uses of FrankElement in org.frankframework.ldap

Classes in org.frankframework.ldap that implement FrankElement

Modifier and Type	Class	Description
class	AbstractLdapQueryPipe	Base pipe for querying LDAP.
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.
class	LdapSender	Sender to obtain information from and write to an LDAP Directory.

Uses of FrankElement in org.frankframework.mongodb

Classes in org.frankframework.mongodb that implement FrankElement

Modifier and Type	Class	Description
class	MongoDbSender	Sender to perform action on a MongoDB database.

Uses of FrankElement in org.frankframework.monitoring

Classes in org.frankframework.monitoring that implement FrankElement

Modifier and Type	Class	Description
class	Monitor	Example configuration:

Uses of FrankElement in org.frankframework.parameters

Subinterfaces of FrankElement in org.frankframework.parameters

Modifier and Type	Interface	Description
interface	IParameter

Classes in org.frankframework.parameters that implement FrankElement

Modifier and Type	Class	Description
class	AbstractParameter	Generic parameter definition.
class	BooleanParameter
class	DateParameter
class	NumberParameter
class	Parameter	Placeholder class to allow legacy configuration notations <param type='number' /> in the new Frank!
class	XmlParameter

Uses of FrankElement in org.frankframework.pipes

Classes in org.frankframework.pipes that implement FrankElement

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	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	PutInSession	Puts the input or the value in the PipeLineSession, under the key specified by sessionKey.
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	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	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 FrankElement in org.frankframework.receivers

Subinterfaces of FrankElement in org.frankframework.receivers

Modifier and Type	Interface	Description
interface	ReceiverAware<M>	When a listener implements this interface it will get a reference to it's parent receiver.

Classes in org.frankframework.receivers that implement FrankElement

Modifier and Type	Class	Description
class	FrankListener	Listener to receive messages sent by the FrankSender, for situations where calling an Adapter directly is not desired.
class	JavaListener<M>	Use this listener to receive messages from other adapters or a scheduler within the same Frank-application or from other components residing in the same JVM.
class	Receiver<M>	Wrapper for a listener that specifies a channel for the incoming messages of a specific Adapter.

Uses of FrankElement in org.frankframework.scheduler

Classes in org.frankframework.scheduler that implement FrankElement

Modifier and Type	Class	Description
class	AbstractJobDef	Possible cron expressions:
class	SchedulerSender	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of FrankElement in org.frankframework.scheduler.job

Subinterfaces of FrankElement in org.frankframework.scheduler.job

Modifier and Type	Interface	Description
interface	IJob

Classes in org.frankframework.scheduler.job that implement FrankElement

Modifier and Type	Class	Description
class	ActionJob	Job which can stop/start adapters and receivers.
class	CheckReloadJob	Frank!
class	CleanupDatabaseJob	Frank!
class	CleanupFileSystemJob	Frank!
class	DatabaseJob
class	ExecuteQueryJob	Scheduled job to execute JDBC Queries using a FixedQuerySender.
class	IbisActionJob	Deprecated, for removal: This API element is subject to removal in a future version.
class	Job	Deprecated.
class	LoadDatabaseSchedulesJob	1.
class	RecoverAdaptersJob	Frank!
class	SendMessageJob	Scheduled job to send messages to a FrankListener.
static class	SendMessageJob.SendMessageJobSender	The sole purpose of this call is to prevent AOP wrapping around the sendMessage / sendMessageOrThrow methods.

Uses of FrankElement in org.frankframework.senders

Classes in org.frankframework.senders that implement FrankElement

Modifier and Type	Class	Description
class	AbstractBlockEnabledSender<H>
class	AbstractMailSender
class	AbstractSender	Baseclass for senders.
class	AbstractSenderWithParameters	Provides a base class for senders with parameters.
class	AbstractSenderWrapper	Baseclass for Wrappers for senders, that allows to get input from a session variable, and to store output in a session variable.
class	CommandSender	Sender that executes either its input or a fixed line, with all parametervalues appended, as a command.
class	DelaySender	Sender that sleeps for a specified time, which defaults to 5000 msecs.
class	EchoSender	Echos input to output.
class	FixedResultSender	FixedResultSender, same behaviour as FixedResultPipe, but now as a ISender.
class	FrankSender	Sender to send a message to another Frank!
class	IbisJavaSender	Posts a message to another Frank!
class	IbisLocalSender	Posts a message to another Frank!
class	JavascriptSender	Sender used to run JavaScript code using `JavascriptEngine` implementations.
class	JsonXsltSender	Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, yielding JSON, XML or text.
class	LogSender	Sender that just logs its message.
class	MailSender	sender that sends a mail specified by an XML message.
class	ParallelSenders	Collection of Senders, that are executed all at the same time.
class	ReconnectSenderWrapper	Wrapper for senders, that opens the wrapped sender at runtime before each sender action, and closes it afterwards.
class	ReloadSender	Performs a reload on database configuration.
class	SenderSeries	Series of Senders, that are executed one after another.
class	SenderWrapper	Wrapper for senders, that allows to get input from a session variable, and to store output in a session variable.
class	SendGridSender	Sender that sends a mail via SendGrid v3 (cloud-based SMTP provider).
class	ShadowSender	Collection of Senders, that are executed all at the same time.
class	XmlValidatorSender	Sender that validates the input message against a XML Schema.
class	XsltSender	Perform an XSLT transformation with a specified stylesheet or XPath-expression.

Uses of FrankElement in org.frankframework.soap

Classes in org.frankframework.soap that implement FrankElement

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.

Uses of FrankElement in org.frankframework.statistics

Methods in org.frankframework.statistics with parameters of type FrankElement

Modifier and Type	Method	Description
io.micrometer.core.instrument.Counter	MetricsInitializer.createCounter(FrankElement frankElement, FrankMeterType type)
io.micrometer.core.instrument.DistributionSummary	MetricsInitializer.createDistributionSummary(FrankElement frankElement, FrankMeterType type)
io.micrometer.core.instrument.Gauge	MetricsInitializer.createGauge(FrankElement frankElement, FrankMeterType type, Supplier<Number> numberSupplier)
io.micrometer.core.instrument.DistributionSummary	MetricsInitializer.createSubDistributionSummary(FrankElement parentFrankElement, String subFrankElement, FrankMeterType type)
io.micrometer.core.instrument.DistributionSummary	MetricsInitializer.createSubDistributionSummary(FrankElement parentFrankElement, HasName subFrankElement, FrankMeterType type)	This DistributionSummary is suffixed under a pipe
io.micrometer.core.instrument.Timer.ResourceSample	MetricsInitializer.createTimerResource(FrankElement frankElement, FrankMeterType type, String... tags)

Uses of FrankElement in org.frankframework.util

Methods in org.frankframework.util with parameters of type FrankElement

Modifier and Type	Method	Description
static TransformerPool	TransformerPool.configureStyleSheetTransformer(FrankElement scopeProvider, String styleSheetName, int xsltVersion)
static TransformerPool	TransformerPool.configureTransformer(FrankElement scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params)
static TransformerPool	TransformerPool.configureTransformer(FrankElement scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params, boolean mandatory)
static TransformerPool	TransformerPool.configureTransformer0(FrankElement scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params, int xsltVersion)

Uses of FrankElement in org.frankframework.validation

Classes in org.frankframework.validation that implement FrankElement

Modifier and Type	Class	Description
class	AbstractXmlValidator	baseclass for validating input message against a XML Schema.
class	JavaxXmlValidator	Straightforward XML-validation based on javax.validation.
class	XercesXmlValidator	Xerces based XML validator.