Uses of Interface
org.frankframework.core.IConfigurationAware
Package
Description
-
Uses of IConfigurationAware in org.frankframework.cache
Modifier and TypeClassDescriptionclass
Baseclass for caching.class
EhCache<V>
General Cache provider.class
Remove specified cache key from cache with specified name. -
Uses of IConfigurationAware in org.frankframework.collection
Modifier and TypeClassDescriptionclass
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 byAbstractCollectorPipe
withaction=OPEN
. -
Uses of IConfigurationAware in org.frankframework.compression
Modifier and TypeClassDescriptionclass
Sends a message to a Sender for each entry of its input, that must be an ZipInputStream.class
Pipe that creates a ZIP archive (on action close).class
Sender that writes an entry to a ZipStream, similar to ZipWriterPipe with action='write'. -
Uses of IConfigurationAware in org.frankframework.configuration
Modifier and TypeMethodDescriptionstatic void
ConfigurationWarnings.add
(IConfigurationAware source, org.apache.logging.log4j.Logger log, String message) Add a ConfigurationWarning with INamedObject prefixstatic void
ConfigurationWarnings.add
(IConfigurationAware source, org.apache.logging.log4j.Logger log, String message, Throwable t) Add a ConfigurationWarning with INamedObject prefix and log the exception stackstatic void
ConfigurationWarnings.add
(IConfigurationAware source, org.apache.logging.log4j.Logger log, String message, SuppressKeys suppressionKey) Add a (globally-)suppressible ConfigurationWarning with INamedObject prefixstatic void
ConfigurationWarnings.add
(IConfigurationAware source, org.apache.logging.log4j.Logger log, String message, SuppressKeys suppressionKey, Adapter adapter) Add a suppressible ConfigurationWarning with INamedObject prefixModifierConstructorDescriptionConfigurationMessageEvent
(IConfigurationAware source, String message) ConfigurationMessageEvent
(IConfigurationAware source, String message, Exception e) ConfigurationMessageEvent
(IConfigurationAware source, String message, MessageKeeper.MessageKeeperLevel level) -
Uses of IConfigurationAware in org.frankframework.core
Modifier and TypeInterfaceDescriptioninterface
interface
Allows to leverage sending messages in blocks.interface
interface
Additional behaviour for pulling listeners that are able to listen to a specific message, specified by a correlation ID.interface
Marker interface for correlated sender, used inReceiver
.interface
interface
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
Models starting and stopping of objects that support such behaviour.interface
PullingListener extension that checks for available messages to retrieve without starting a XA transaction.interface
A Pipe represents an action to take in aPipeLine
.interface
Interface extending IPushingListener for listeners which connect to a ListenerPort or other type of named endpoint, from which they receive their messages.interface
Deprecated, for removal: This API element is subject to removal in a future version.interface
Defines listening behaviour of pulling receivers.interface
Defines listening behaviour of message driven receivers.interface
interface
Marks an implementation as responsible for sending a message to some destination.interface
Allows Senders to declare that they accept and may useparameters
interface
Marker interface for Validatorsinterface
Marker interface for Wrappersinterface
interface
Modifier and TypeClassDescriptionclass
Wrapper for the response validator.class
The Adapter is the central manager in the framework.class
Required in eachAdapter
to transform incoming messages.Modifier and TypeMethodDescriptionio.micrometer.core.instrument.DistributionSummary
PipeLine.getPipeStatistics
(IConfigurationAware pipe) -
Uses of IConfigurationAware in org.frankframework.encryption
-
Uses of IConfigurationAware in org.frankframework.http
Modifier and TypeClassDescriptionclass
Sender for the HTTP protocol usingHttpMethod
.class
Note 1: Some certificates require the <java_home>/jre/lib/security/xxx_policy.jar files to be upgraded to unlimited strength.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Sender for the HTTP protocol usingHttpMethod
.class
Shared HTTPSession, implementsSharedResource
so it can be set in the Configuration.xmlclass
Deprecated, for removal: This API element is subject to removal in a future version.class
Baseclass of aIPushingListener
that enables aReceiver
to receive messages from Servlets.class
Listener that allows aReceiver
to receive messages as a REST webservice.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Listener that allows aReceiver
to receive messages as a SOAP webservice.class
Sender that sends a message via a WebService.ModifierConstructorDescriptionMicrometerHttpClientInterceptor
(MetricsInitializer configurationMetrics, IConfigurationAware parentFrankElement, Function<org.apache.http.HttpRequest, String> uriMapper, boolean exportTagsForRoute) Create aMicrometerHttpClientInterceptor
instance. -
Uses of IConfigurationAware in org.frankframework.http.rest
Modifier and TypeClassDescriptionclass
Listener that allows aReceiver
to receive messages as a REST webservice.class
Pipe to manage the ApiPrincipal handling -
Uses of IConfigurationAware in org.frankframework.jdbc
Modifier and TypeClassDescriptionclass
JDBC implementation ofIMessageBrowser
.class
This executes the query that is obtained from the (here still abstract) method getStatement.class
Base class for building JDBC-senders.class
Pipe that iterates over the lines in a BLOB.class
Pipe that iterates over the lines in a CLOB.class
QuerySender that interprets the input message as a query, possibly with attributes.class
DummyTransactionalStorage<S extends Serializable>
Deprecated, for removal: This API element is subject to removal in a future version.class
QuerySender that assumes a fixed query, possibly with attributes.class
Provides functions for JDBC connections.class
Base class for JDBC iterating pipes.protected class
class
JdbcListener<M>
JdbcListener base class.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Database Listener that operates on a table having at least a key and a status field.class
class
JdbcTransactionalStorage<S extends Serializable>
Implements a message log (JdbcMessageLog
) or error store (JdbcErrorStorage
) that uses database table IBISSTORE.class
abstract baseclass for Pipes that iterate over the lines in a lob.class
Read messages from the IBISSTORE database table previously stored by aMessageStoreSender
.class
Send messages to the IBISSTORE database table to have them processed exactly-once by another adapter which will read the messages using aMessageStoreListener
.class
QuerySender that writes each row in a ResultSet to a file.class
Pipe that iterates over rows in in ResultSet.class
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 is used to send stored procedure queries and retrieve the result.class
QuerySender that transforms the input message to a query. -
Uses of IConfigurationAware in org.frankframework.jdbc.migration
Modifier and TypeClassDescriptionclass
DatabaseMigration implementation for IAF.class
LiquiBase implementation for IAF -
Uses of IConfigurationAware in org.frankframework.jms
Modifier and TypeClassDescriptionclass
Common baseclass for Pulling and Pushing JMS Listeners.class
AbstractJmsMessageBrowser<M,
J extends jakarta.jms.Message> Basic browser of JMS Messages.class
JmsBrowser<M extends jakarta.jms.Message>
Basic browser of JMS Messages.class
Provides functions for jms connections, queues and topics and acts as a facade to hide for clients whether aQueue
orTopic
is used.class
A true multi-threadedListener
-class.class
This class sends messages with JMS.class
JmsTransactionalStorage<S extends Serializable>
Implements a message log (JmsMessageLog
) or error store (JmsErrorStorage
) that uses JMS technology.class
A true multi-threadedListener
-class.class
JMSListener re-implemented as a pushing listener rather than a pulling listener.class
Sender for browsing and removing queue messages (with input and output in a XML message). -
Uses of IConfigurationAware in org.frankframework.jndi
Modifier and TypeClassDescriptionclass
Provides all JNDI functions and is meant to act as a base class.class
Tomcat Resource Factory that looks up objects in a delegate JNDI. -
Uses of IConfigurationAware in org.frankframework.ldap
Modifier and TypeClassDescriptionclass
Base pipe for querying LDAP.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Pipe that returns the memberships of a userDN.class
Pipe that checks if a specified dn exists as 'member' in another specified dn in LDAP.class
Sender to obtain information from and write to an LDAP Directory. -
Uses of IConfigurationAware in org.frankframework.mongodb
Modifier and TypeClassDescriptionclass
Sender to perform action on a MongoDB database. -
Uses of IConfigurationAware in org.frankframework.monitoring
-
Uses of IConfigurationAware in org.frankframework.parameters
Modifier and TypeClassDescriptionclass
Generic parameter definition.class
class
class
class
Placeholder class to allow legacy configuration notations<param type='number' />
in the new Frank!class
-
Uses of IConfigurationAware in org.frankframework.pipes
Modifier and TypeClassDescriptionclass
Base class forPipe
.class
Pipe that validates the input message against a Schema.static class
Wrapper for the response validator.class
class
Pipe that performs base64 encoding and decoding.class
Output bytes as specified by the input XML.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Pipe that compares the two integer values.class
Pipe that lexicographically compares two strings, that must NOT be empty.class
Pipe to zip or unzip a message or file.class
Selects an exitState, based on the number of received messages by this pipe.class
Pipe to check the the CredentialFactory (for testing only).class
Pipe that reads a CRL from an input stream and transforms it to an XML.class
Reads a message in CSV format, and turns it into XML.class
Using.jsonnet
transformation files, the DataSonnetPipe uses JSonnet at it's core to transform files from and to different file formats specified by supportedoutputTypes
.class
Pipe that sleeps for a specified time, which defaults to 5000 msecs.class
Pipe that performs domain transforming on the basis of a database table.class
Returns simply the input message.class
Pipe that performs translations between special characters and their xml equivalents.class
Deprecated.class
Pipe that throws an exception, based on the input message.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Provides a base-class for a Pipe that always has the same forward.class
This Pipe opens and returns a file from the classpath.class
Sends a message to a Sender for each child element of the input XML.class
ForPipe is a wrapper to use another pipe a fixed number of times.class
Gets the contents of thepipeLineSession
by a key specified by
.sessionKey
class
Returns the name of the user executing the request.class
This pipe can be used to generate a hash for the given message using an algorithm.class
Selects a forward based on an expression.class
Pipe that increases the integer value of a session variable.class
Pipe that checks if the calling user has a specified role.class
Selects an exitState, based on if the input is a XML string.class
Base class to send a message to a Sender for each item returned by a configurable iterator.class
Pipe
that validates the XML or JSON input message against a XML Schema and returns either XML or JSON.class
JSON is not aware of the element order.class
Pipe that validates the input message against a JSON Schema.class
Pipe
that checks the well-formedness of the input message.class
Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, XML or text.class
Creates a JWT with a shared secret using the HmacSHA256 algorithm.class
Pipe that stores all its parameter values in the ThreadContext, formerly known as Mapped Diagnostic Context (MDC), to be used in logging.class
Pipe that sends a mail-message using aMailSender
as its sender.class
class
Generates a random password.class
Hash a password or validate a password against a hash using PasswordHash.java from https://crackstation.net/hashing-security.htm.class
Performs various PGP (Pretty Good Privacy) actions such as Encrypt, Sign, Decrypt, Verify.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Puts the input or the
in the PipeLineSession, under the key specified byvalue
.sessionKey
class
Deprecated, for removal: This API element is subject to removal in a future version.class
Puts the system date/time under a key in thepipeLineSession
.class
Tries to match the input against the provided regex.class
Removes a key specified by
from thesessionKey
pipeLineSession
.class
This Pipe is used to replace values in a few ways.class
Sends a message using ansender
and optionally receives a reply from the same sender.class
class
Returns the number of bytes or characters in the input.class
Skip a number of bytes or characters from the input message.class
Deprecated, for removal: This API element is subject to removal in a future version.not necessary when using Messages.class
Sends a message to a Sender for each line of its input, that must be an InputStream.class
Stream an input stream to an output stream.class
IteratingPipe that has Strings as items.class
Pipe for converting TEXT to XML.class
Breaks up the text input in blocks of a maximum length.class
Extension to FixedForwardPipe for interrupting processing when timeout is exceeded.class
Assumes input to be the file name of a ZIP archive, and unzips it to a directory and/or an XML message.class
Pipe that generates an UUID (Universally Unique Identifier).class
Generate WSDL of parent or specified adapter.class
XmlValidator that will read the XSD's to use from a WSDL.class
Deprecated.class
Deprecated, for removal: This API element is subject to removal in a future version.Please replace with ForEachChildElementPipe.class
Deprecated, for removal: This API element is subject to removal in a future version.please use theIfPipe
for if (else/then) behaviour.class
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
Pipe that validates the input message against an XML Schema.static class
Wrapper for the XML response validator.class
Pipe
that checks the well-formedness of the input message.class
Perform an XQuery.class
Perform an XSLT transformation with a specified stylesheet. -
Uses of IConfigurationAware in org.frankframework.receivers
Modifier and TypeInterfaceDescriptioninterface
When a listener implements this interface it will get a reference to it's parent receiver.Modifier and TypeClassDescriptionclass
Listener to receive messages sent by theFrankSender
, for situations where calling anAdapter
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 specificAdapter
. -
Uses of IConfigurationAware in org.frankframework.scheduler
Modifier and TypeClassDescriptionclass
Possible cron expressions:class
Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of IConfigurationAware in org.frankframework.scheduler.job
Modifier and TypeClassDescriptionclass
Job which can stop/start adapters and receivers.class
Frank!class
Frank!class
Frank!class
class
Scheduled job to execute JDBC Queries using aFixedQuerySender
.class
Deprecated, for removal: This API element is subject to removal in a future version.class
Deprecated.class
1.class
Frank!class
Scheduled job to send messages to aFrankListener
.static class
The sole purpose of this call is to prevent AOP wrapping around the sendMessage / sendMessageOrThrow methods. -
Uses of IConfigurationAware in org.frankframework.senders
Modifier and TypeClassDescriptionclass
class
class
Baseclass for senders.class
Provides a base class for senders with parameters.class
Baseclass for Wrappers for senders, that allows to get input from a session variable, and to store output in a session variable.class
Sender that executes either its input or a fixed line, with all parametervalues appended, as a command.class
Sender that sleeps for a specified time, which defaults to 5000 msecs.class
Echos input to output.class
FixedResultSender, same behaviour asFixedResultPipe
, but now as a ISender.class
Sender to send a message to another Frank!class
Posts a message to another Frank!class
Posts a message to another Frank!class
Sender used to run JavaScript code using `JavascriptEngine` implementations.class
Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, yielding JSON, XML or text.class
Sender that just logs its message.class
sender
that sends a mail specified by an XML message.class
Collection of Senders, that are executed all at the same time.class
Wrapper for senders, that opens the wrapped sender at runtime before each sender action, and closes it afterwards.class
Performs a reload on database configuration.class
Series of Senders, that are executed one after another.class
Wrapper for senders, that allows to get input from a session variable, and to store output in a session variable.class
Sender that sends a mail via SendGrid v3 (cloud-based SMTP provider).class
Collection of Senders, that are executed all at the same time.class
Sender that validates the input message against a XML Schema.class
Perform an XSLT transformation with a specified stylesheet or XPath-expression. -
Uses of IConfigurationAware in org.frankframework.soap
Modifier and TypeClassDescriptionclass
XmlValidator that will automatically add the SOAP envelope XSD to the set of XSD's used for validation.class
Pipe to wrap or unwrap a message from/into a SOAP Envelope. -
Uses of IConfigurationAware in org.frankframework.statistics
Modifier and TypeInterfaceDescriptioninterface
Interface to be implemented by objects like Pipes or Senders that maintain additional statistics themselves.Modifier and TypeMethodDescriptionio.micrometer.core.instrument.Counter
MetricsInitializer.createCounter
(IConfigurationAware frankElement, FrankMeterType type) io.micrometer.core.instrument.DistributionSummary
MetricsInitializer.createDistributionSummary
(IConfigurationAware frankElement, FrankMeterType type) io.micrometer.core.instrument.Gauge
MetricsInitializer.createGauge
(IConfigurationAware frankElement, FrankMeterType type, Supplier<Number> numberSupplier) io.micrometer.core.instrument.DistributionSummary
MetricsInitializer.createSubDistributionSummary
(IConfigurationAware parentFrankElement, String subFrankElement, FrankMeterType type) io.micrometer.core.instrument.DistributionSummary
MetricsInitializer.createSubDistributionSummary
(IConfigurationAware parentFrankElement, INamedObject subFrankElement, FrankMeterType type) This DistributionSummary is suffixed under a pipeio.micrometer.core.instrument.Timer.ResourceSample
MetricsInitializer.createTimerResource
(IConfigurationAware frankElement, FrankMeterType type, String... tags) -
Uses of IConfigurationAware in org.frankframework.util
Modifier and TypeMethodDescriptionstatic TransformerPool
TransformerPool.configureStyleSheetTransformer
(IConfigurationAware scopeProvider, String styleSheetName, int xsltVersion) static TransformerPool
TransformerPool.configureTransformer
(IConfigurationAware scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params) static TransformerPool
TransformerPool.configureTransformer
(IConfigurationAware scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params, boolean mandatory) static TransformerPool
TransformerPool.configureTransformer0
(IConfigurationAware scopeProvider, String namespaceDefs, String xPathExpression, String styleSheetName, TransformerPool.OutputType outputType, boolean includeXmlDeclaration, ParameterList params, int xsltVersion) -
Uses of IConfigurationAware in org.frankframework.validation
Modifier and TypeClassDescriptionclass
baseclass for validating input message against a XML Schema.class
Straightforward XML-validation based on javax.validation.class
Xerces based XML validator.Modifier and TypeMethodDescriptionvoid
RootValidation.check
(IConfigurationAware source, Set<IXSD> xsds) void
RootValidations.check
(IConfigurationAware source, Set<IXSD> xsds) void
AbstractXmlValidator.configure
(IConfigurationAware owner) Configure the XmlValidatorvoid
JavaxXmlValidator.configure
(IConfigurationAware owner) void
XercesXmlValidator.configure
(IConfigurationAware owner)
HashPipe