All Classes and Interfaces

Class
Description
 
 
 
 
 
Baseclass for caching.
Abstract base class for for IBIS Configuration ClassLoaders.
 
Base class for pipes that can collect items, such as multipart messages and zip archives.
 
Sender that writes an item to a collection, created by AbstractCollectorPipe with action=OPEN.
Baseclass for FileSystems that use a 'Connection' to connect to their storage.
DatabaseMigration implementation for IAF.
 
 
 
Baseclass for FileSystems.
listener that looks in a FileSystem for files.
 
 
Base class for Pipes that use a FileSystem.
Base class for Senders that use a FileSystem.
 
Sender for the HTTP protocol using HttpMethod.
 
Base class for @IbisInitializer capable servlets
Note 1: Some certificates require the <java_home>/jre/lib/security/xxx_policy.jar files to be upgraded to unlimited strength.
 
 
JDBC implementation of IMessageBrowser.
This executes the query that is obtained from the (here still abstract) method getStatement.
 
Base class for building JDBC-senders.
Base class for JMS Configurator implementations.
Basic browser of JMS Messages.
Possible cron expressions:
 
This class is used to create and manage the lifecycle of Larva actions.
Base pipe for querying LDAP.
Baseclass for MailFileSystems.
Implementation of a AbstractFileSystemListener that enables a Receiver to look in a folder for received mails.
 
 
Generic mail class
Generic mail attachment class
 
 
 
Base class for Monitor Destination implementations.
 
 
 
Generic parameter definition.
 
 
This is an abstraction of general pgp actions such as encryption, verification, etc.
Base class for Pipe.
Baseclass for PipelineProcessors.
Baseclass for PipeProcessors.
Property Configurer that adds additional properties to the Spring environment through a custom property-source.
 
Deprecated.
Warning: non-maintained functionality.
 
Runnable object for calling a request reply service.
 
Wrapper for the response validator.
Abstract class for resulthandlers (handler that handles the transformed record).
Baseclass for senders.
Provides a base class for senders with parameters.
Baseclass for Wrappers for senders, that allows to get input from a session variable, and to store output in a session variable.
Baseclass for SenderWrapperProcessor.
 
Base class for handling JAX-WS SOAP messages
This is a factory for objects to be used with the 'factory-create-rule' of the Apache Digester framework as a replacement for the 'object-create-rule'.
JtaTransactionManager-wrapper that enables to recover transaction logs produced by another instance.
 
 
Pipe that validates the input message against a schema.
Wrapper for the response validator.
 
baseclass for validating input message against a XML Schema.
 
The representation of a XSD.
 
Job which can stop/start adapters and receivers.
 
 
Authenticator for Microsoft Active Directory using LDAP.
The Adapter is the central manager in the framework.
Filter on Adapters, used by Triggers.
 
 
 
 
 
 
 
 
Interface to be implemented by framework-classes that provide extra property-resolving sources, such as credentials, which cannot be directly included of the StringResolver methods.
Transforms between ascii-ADIOS and an XML representation of ADIOS.
 
Domparser om AFM-XML berichten om te zetten in edifactberichten (voor de backoffice).
A Trigger that starts its life with type = ALARM.
Defines the supported algorithms which can be used in the HashPipe
Top of a stack of parsed elements, that represent the current position in the aligned document.
To avoid repeating this list of roles over and over again, use a default annotation Since you can't reference a static list of values, it has to be hard coded like this.
 
 
 
Sender to work with the Amazon S3 Filesystem.
 
Returns the amount of pages of a PDF file.
CredentialFactory implementation that uses an Ansible Vault to read secrets from.
Programmatic equivalent of <aop:config proxy-target-class="true" />.
 
 
 
 
 
Listener that allows a Receiver to receive messages as a REST webservice.
 
 
 
 
 
Pipe to manage the ApiPrincipal handling
This class registers dispatches requests to the proper registered ApiListeners.
Extension to SoapWrapperPipe for API Management.
Deprecated.
Extension to WsdlXmlValidator for API Management.
Singleton class that has the constant values for this application.
 
It's important this is loaded first, and before any programmatic listeners have been added to determine the Application Server type.
 
 
 
 
Sends a message using an asynchronous sender and receives a reply from a listener.
 
 
It is important that we register the correct (CMIS) CXF bus, or else JAX-RS (IAF-API / WebServiceListener) won't work properly
 
Base class for transforming SAX Attributes-lists.
 
 
 
 
 
 
 
 
 
Pipe that performs base64 encoding and decoding.
 
Deprecated.
Deprecated.
Deprecated.
Warning: non-maintained functionality.
Deprecated.
 
 
Deprecated.
Please use JmsListener combined with BisWrapperPipe
Deprecated.
Please use JmsSender combined with BisWrapperPipe
Deprecated.
Please use BisWrapperPipe
Deprecated.
Please replace with org.frankframework.extensions.esb.EsbSoapWrapperPipe (not 1:1)
Only show senders that communicate with another system
Pipe that iterates over the lines in a BLOB.
Wrapper around DBMS provided OutputStream for BLOB, that updates BLOB and ResultSet and closes them at stream.close().
XmlFilter that skips startDocument and endDocument, to be able to parse some additional body elements into and existing XML stream.
Parameter that resolves it's value to either true or false.
After each request the CallContext is removed.
 
 
 
 
 
 
 
 
Validates if the BuildInfo.properties file is present in the configuration (jar), and if the name and version properties are set correctly
 
 
 
Serialized and send as an ExceptionMessage over the Spring Bus
 
 
 
Output bytes as specified by the input XML.
Reference to an byte[].
 
 
 
 
PipelineProcessor that handles caching.
SenderWrapperProcessor that handles caching.
 
This is the reader of the Calcbox output.
 
Filter to canonicalize an XML by sorting the attributes on elements
 
 
 
 
 
Frank!
Deprecated, for removal: This API element is subject to removal in a future version.
Please use the HashPipe.
 
 
 
 
 
 
 
 
 
Exception thrown by ClassLoaderManager when it fails to create an IConfigurationClassLoader.
Loads a ClassLoader on a per Configuration basis.
Resolve URIs used in document(), xsl:import, and xsl:include.
 
 
A collection of class management utility methods.
Starts the singleton Cleaner thread of F!
Frank!
Frank!
A Trigger that starts its life with type = CLEARING.
 
 
 
Pipe that iterates over the lines in a CLOB.
Wrapper around DBMS provided Writer for CLOB, that updates CLOB and ResultSet and closes them at writer.close().
Subclass of CMIS SessionImpl that is closeable so it can clean up closeable items in the session binding map.
 
 
 
 
Cluster in this sense does not directly mean a Kubernetes or similar cluster, but a Hazelcast cluster.
 
 
 
 
 
 
 
 
 
Abstract class to prevent Frank!
Autowires the CMIS RepositoryConnectorFactory
Wraps the CMIS SecurityContext in an ISecurityHandler.
Sender to obtain information from and write to a CMIS application.
 
 
 
 
 
Aggregator which handles the collection of collector parts.
 
Sender that executes either its input or a fixed line, with all parametervalues appended, as a command.
 
SAX2 event handler to compact XML messages.
Pipe that compares the two integer values.
Pipe that lexicographically compares two strings, which must NOT be empty.
 
Pipe to zip or unzip a message or file.
 
 
 
 
Interface for Spring beans that require their Lifecycle to be managed by Spring.
Container of Adapters that belong together.
 
Similar to ApplicationContextAwareProcessor sets the Configuration class on the ConfigurationAware beans.
The configurationDigester reads the configuration.xml and the digester rules in XML format and factors a Configuration.
 
 
 
Exception thrown by ConfigurationDigester and configure()-methods, signaling the configuration did not succeed.
 
 
 
 
 
 
 
 
Functions to manipulate the configuration.
 
If the source implements NameAware it uses that as prefix, else it will use the ClassName.
Job, specified in Configuration.xml, for executing things to do with an adapter, like starting or stopping it.
This class is a custom implementation of the Spring DefaultLifecycleProcessor that adds support for ConfigurableLifecycle beans.
 
 
 
Contains the component annotation so it will be picked up by the core (SpringEnvironmentContext.xml).
 
Spring Boot entrypoint when running as a normal WAR application.
 
 
 
Convertor factory instantiates all convertor types and keeps them in a map.
 
 
 
 
 
 
 
 
Selects an exitState, based on the number of received messages by this pipe.
 
Pipe to check the the CredentialFactory (for testing only).
Singleton class that has the credential constant values for this application.
 
Provides user-id and password from the WebSphere authentication-alias repository.
Tomcat PropertySource that gets its data from the configured CredentialFactory.
Implementation of AdditionalStringResolver for resolving user credentials using the CredentialFactory.
 
Pipe that reads a CRL from an input stream and transforms it to an XML.
 
 
Reads a message in CSV format and turns it into XML.
 
 
 
 
 
 
 
 
Using .jsonnet transformation files, the DataSonnetPipe uses JSonnet at its core to transform files from and to different file formats specified by supported outputTypes.
 
Factory through which (TX-enabled) DataSources can be retrieved.
XAResourceRecoveryHelper implementation which gets XIDs, which needs to be recovered, from the database.
Utilities for formatting and parsing dates.
 
 
Support for DB2.
 
Transforms a java.sql.Resultset to a XML stream.
 
 
 
 
 
Used to determine whether the test tool is activated by using the testtool.enabled appConstants property.
 
 
 
 
Pipe that sleeps for a specified time, which defaults to 5000 msecs.
Sender that sleeps for a specified time, which defaults to 5000 msecs.
RestTemplate implementation for the Delinea Secret Server REST API.
Used to create a DelineaClient based on the given DelineaClientSettings.
Contains the settings for the SecretServer configuration.
CredentialFactory that reads its credentials from Delinea (formerly Thycotic) Secret Server.
 
Deprecated.
Warning: non-maintained functionality.
Deprecated.
Warning: non-maintained functionality.
 
Should only intercept Spring WEB MVC requests.
Retention annotation for the FF API to describe what an endpoint does
Helper class for managing a JCo destinations, in particular for obtaining transactional resources.
Callback interface for resource creation.
 
 
Java representation of a digester rule specified in the digester-rules.xml file.
List the contents of a directory as XML.
 
Cleans up a directory.
Listener that looks for files in a LocalFileSystem.
QuerySender that interprets the input message as a query, possibly with attributes.
Kind of extension to EsbSoapWrapperPipe for real time destinations.
 
 
 
 
Pipe that performs domain transforming on the basis of a database table.
 
Flow generator to create DOT files
Classloader which loads an empty Configuration.
Deprecated, for removal: This API element is subject to removal in a future version.
Allow us to change the IMessenger.
A Servlet registration wrapper to register Servlets in a Servlet 3.0+ container.
 
 
Returns simply the input message.
Echos input to output.
General Cache provider.
 
 
 
Reader that encapsulates a file within a prefix and a postfix.
 
 
 
 
 
Represents the value when setting a DocumentedEnum field, opposed to using the enumeration field it self.
 
 
 
 
Converter which (when used in combination with a PublishSubscribeChannel) retrieves the payload from the response message, logs the exception, and returns a sanitized exception message with status code 400/500.
This class wraps an error in an XML string.
 
ESB (Enterprise Service Bus) extension of JmsListener.
 
ESB (Enterprise Service Bus) extension of @{codeJmsSender}.
 
ESB (Enterprise Service Bus) extension of JmsTransactionalStorage.
XmlValidator that will automatically add the SOAP envelope XSD and the ESB XSD (e.g. a CommonMessageHeader.xsd) to the set of XSDs used for validation.
 
Extension to SoapWrapperPipe for separate modes.
 
 
Pipe that performs translations between special characters and their XML equivalents.
 
Deprecated.
 
A Monitoring Event with a map of potential Adapters that can throw events of this type.
 
Publisher to wrap the monitoring events and publish them to the Spring Context
Interface to be implemented by objects to be monitored; Is called by code that handles event.
Enumeration of Event Types for monitoring.
 
XMLFilter to reinsert exceptions into a XMLFilter chain.
Pipe that throws an exception based on the input message.
Implementation of a IBasicFileSystem of an Exchange Mailbox.
Implementation of a AbstractFileSystemSender that enables to manipulate messages in an Exchange folder.
Deprecated, for removal: This API element is subject to removal in a future version.
Microsoft Exchange Implementation of a mailbox based filesystem.
 
 
 
 
 
Scheduled job to execute JDBC Queries using a FixedQuerySender.
Deprecated.
Warning: non-maintained functionality.
 
 
 
File listener for the Test Tool.
 
Compares filenames, so directory listings appear in a kind of natural order.
 
File sender for the Test Tool.
 
CredentialFactory implementation that reads secrets from the file system.
 
 
Forwards for FileSystemException.
 
 
 
Deprecated.
 
Utilities for batch file handling.
 
 
 
Forwards incoming calls to a CMIS repository.
 
ErrorMessageFormatter that returns a fixed message with replacements.
Provides a base class for a Pipe that always has the same forward.
Deprecated.
Warning: non-maintained functionality.
QuerySender that assumes a fixed query, possibly with attributes.
This Pipe opens and returns a file from the classpath.
FixedResultSender, same behaviour as FixedResultPipe, but now as a ISender.
Utility class to generate the flow diagram for an adapter or a configuration.
FlowGenerationException when unable to generate a Flow Diagram
 
 
 
 
Sends a message to a Sender for each child element of the input XML.
SAXException thrown to signal that the consumer of a stream does not want to receive more of it.
SAXException thrown to signal that a timeout occurred in consuming the stream.
 
ForPipe is a wrapper to use another pipe a fixed number of times.
 
 
 
 
Spring WebApplicationInitializer that should start after the FrankEnvironmentInitializer has been configured.
 
Custom implementation that replaces the old digester-rules.xml file.
 
 
 
Digested FrankElements such as an IPipe/ISender or IListener.
Programmatically load the Frank!
Listener to receive messages sent by the FrankSender, for situations where calling an Adapter directly is not desired.
This ConfigurationFactory is loaded after the log4j2.properties file has been initialized.
 
 
 
Sender to send a message to another Frank!
Scope for FrankSender call: Another Frank!
Wrapper around a FTPFile to allow for relative path operations
Implementation of FTP and FTPs FileSystem
 
File listener for an FTP connection.
 
Base class for FTP(s) connections
 
 
 
 
 
Static utility class with helper functions for functional programming and using lambdas.
FxF extension of EsbJmsListener.
FxF wrapper to be used with FxF3.
FxF XML validator to be used with FxF3.
 
 
Generic factory for instantiating beans from the Digester framework.
Gets the contents of the pipeLineSession by a key specified by sessionKey.
Returns the name of the user executing the request.
 
Returns information about Tibco queues in a XML string.
Deprecated.
 
JavaScript engine wrapper for VizJs flow diagrams
Initialized through Spring.
Only show senders and pipelines (within these senders) (show only the pipeline checkpoints, not it's children)
Support for H2.
 
Handler that serves as a base for other SAP XML element handlers.
Beans that have an ApplicationContext.
An enum of the hash algorithms.
HashGenerator interface and different implementations to work with.
This pipe can be used to generate a hash for the given message using an algorithm.
 
 
 
Allows objects to declare that they have a physical destination.
Allows objects to declare that they have a Sender.
Interface to be implemented when a class has one or more special default values (i.e. a default value of attribute X depends on the value of attribute Y).
The HasTransactionAttribute allows Pipes to declare transaction and isolation behavior.
 
 
 
 
 
 
Hide the same data as is hidden in the Ibis logfiles based on the log.hideRegex property in log4j4ibis.properties and IPipe.setHideRegex(String).
Make the hostname property available to the Ibis configuration and the Spring configuration.
The HtmlScenarioOutputRenderer class is responsible for rendering HTML output during the execution of tests in the Larva test tool.
 
A reusable, thread-safe factory for any type of HTTP Entity as specified by HttpEntityType.
Builder for the HttpEntityFactory.
 
 
Custom implementation of an HttpEntity which deals with HttpMessageEntity.isRepeatable(), HttpMessageEntity.isStreaming(), Message.getCharset() and Message.size().
 
 
 
Only retries if no HttpEntity is present, or if the HttpEntity is repeatable.
 
The default SecurityFilterChain will be added by SecurityFilterChainConfigurer.
Shared HTTPSession, implements SharedResource so it can be set in the Configuration.xml
Some utilities for working with HTTP.
Etag (key-value) Cache interface, allows RestListeners and ApiListeners to save and retrieve etags.
 
SecurityContextHolder.getContext().getAuthentication(); can be used to retrieve the username (when available)
Interface to represent a basic filesystem, in which files can be listed, read, deleted or moved to a folder.
Deprecated, for removal: This API element is subject to removal in a future version.
Creates and maintains the (Spring) Application Context.
 
Common manager for caching.
Main entry point for creating and starting Ibis instances from the configuration file.
 
 
 
Wrapper that delegates when a matching CmisEvent is present.
Base Exception with compact but informative getMessage().
 
ExeceptionListener-class to signal exceptions to other objects, for instance MessagePushers to PushingReceivers.
 
Posts a message to another Frank!
 
 
 
Posts a message to another Frank!
Implementation of IbisManager which does not use EJB for managing IBIS Adapters.
This is a wrapper for Log4j2 layouts.
Interface overrides AutoCloseable.close() to remove the exception so this can be used in a try-with-resources without having to handle any exceptions, however does not need to add any extra methods.
Extend the DefaultMessageListenerContainer from Spring to add trace logging and make it possible to monitor the last poll finished time.
Wrapper that delegates when a matching CmisEvent is present.
 
Wrapper that delegates when a matching CmisEvent is present.
Implementation of IbisMaskingLayout to serialize given log events according to the given pattern.
Wrapper that delegates when a matching CmisEvent is present.
 
 
 
 
Extension of StringMatchFilter with the facility of executing a regular expression on the name of the current thread.
 
Class which generates extra logging when starting and committing transactions.
Allows to leverage sending messages in blocks.
Interface to be implemented by cache-providers.
Interface to be implemented by classes that could use a cache.
Implementations should convert their input to a 'usable' part.
To be replaced with ConfigurableLifecycle.
Interface for IBIS Configuration ClassLoaders.
 
 
Additional behaviour for pulling listeners that are able to listen to a specific message, specified by a correlation ID.
Marker interface for correlated sender, used in Receiver.
Interface for a CredentialFactory.
 
Interface to handle generic iterations.
 
Interface to define DBMS specific SQL implementations.
 
Requires the net.bankid.merchant.library V1.2.9
 
Deprecated, for removal: This API element is subject to removal in a future version.
Implementation of sender that sends an IDoc to SAP.
 
DefaultHandler extension to parse SAP Idocs in XML format into JCoIDoc format.
 
An errorMessageFormatter is responsible for returning a string describing the error at hand in a format that the receiver expects.
Used by the FlowDiagramManager to turn a dot file into an image.
IForwardTarget represents the destination of a PipeForward, so a IPipe or PipeLineExit.
Selects a forward based on an expression.
 
Interface that can be implemented by Listeners that provide their own management of messages processed and in error.
Ugly hack to keep the WSDL generator working without changing any code.
 
Interface to be implemented by Listeners that can find out the delivery count of the messages they receive.
Base-interface for IPullingListener and IPushingListener.
Interface specifying method to configure a JMS receiver of some sort.
 
 
 
 
 
 
 
 
 
Interface for helper class for MessageBrowsers.
Iterator item for messagebrowsers.
Interface that PushingListeners can use to handle the messages they receive.
 
Interface to monitoring service.
JMS sender which will add an IMS header to the message and call the MQ specific logic.
Allows the creation of inbound integration gateways.
 
 
Pipe that increases the integer value of a session variable.
 
 
 
 
 
 
Authenticator for in-memory authentication.
 
 
 
The InputOutputPipeProcessor class is a subclass of PipeProcessorBase and is responsible for processing pipes in a pipeline.
 
 
 
Basic InputStreamReaderFactory.
EntityResolver for XercesXmlValidator to resolve imported schema documents to other schemas used to populate the grammar pool.
 
 
 
 
PullingListener extension that checks for available messages to retrieve without starting a XA transaction.
A Pipe represents an action to take in a PipeLine.
Interface extending IPushingListener for listeners which connect to a ListenerPort or other type of named endpoint, from which they receive their messages.
Interface that can be implemented by Listeners that provide their own management of messages processed and in error.
Defines listening behaviour of pulling receivers.
Defines listening behaviour of message driven receivers.
 
Interface for transforming a record (= structured ASCII line).
Interface for handling a transformed record.
 
Interface for handling a transformed record.
Common interface to be implemented by SapListeners
Common interface to be implemented by SapListener implementations.
Common interface to be implemented by SapSender implementations.
 
Common interface to be implemented by SapSystem implementations.
 
Defines behaviour that can be used to assert identity of callers of a pipeline.
Marks an implementation as responsible for sending a message to some destination.
Allows Senders to declare that they accept and may use parameters
Helper class for IbisLocalSender that wraps around ServiceClient implementation to make calls to a local Ibis adapter in a separate thread.
 
 
An interface indicating that a filesystem supports adding custom (user-defined) file attributes.
Pipe that checks if the calling user has a specified role.
Selects an exitState, based on whether the input is an XML string.
Base class to send a message to a Sender for each item returned by a configurable iterator.
 
 
Interface to be implemented by classes of which the number of threads can be controlled at runtime.
Classes that create sub-threads during the processing of messages in adapters should implement this interface, to set the callback for thread lifecycle events.
Marks an implementation as responsible for storing and retrieving-back messages under transaction control.
 
 
 
Marker interface for Validators
Base interface to allow objects to declare that they accept parameters.
Marker interface for Wrappers
 
Extension to IBasicFileSystem that can be implemented to allow creation of files and folders.
Indicates a Pipe, Sender or Listener to be capable of supporting XA-transactions.
Utility interface to allow the debugger to inspect XML in the middle of a streaming execution.
 
The representation of a XSD.
 
 
 
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.
Javascript engine interface, allows the use of a javascript engine to execute javascript code functions.
 
Sender used to run JavaScript code using `JavascriptEngine` implementations.
 
Straightforward XML-validation based on javax.validation.
Connection holder, wrapping a Jco destination.
Wrapper for JDBC related exceptions.
Provides functions for JDBC connections.
Base class for JDBC iterating pipes.
JdbcListener base class.
 
 
See Spring's native PropertySourceFactory TODO use PropertySources (PropertiesPropertySource)
Deprecated, for removal: This API element is subject to removal in a future version.
Database Listener that operates on a table having at least a key and a status field.
 
Implements a message log (JdbcMessageLog) or error store (JdbcErrorStorage) that uses database table IBISSTORE.
Database-oriented utility functions.
Authenticator for J2EE authentication.
 
 
A factory for creating JMS ConnectionFactory objects.
JMS related exception.
Provides functions for jms connections, queues and topics and acts as a facade to hide for clients whether a Queue or Topic is used.
 
 
 
The JMS Message class for the outgoing message.
 
A true multi-threaded Listener-class.
 
MessagingSource for JMS connections.
Factory for MessagingSources, to share them for JMS Objects that can use the same.
 
Helper class for browsing queues.
A JmsRealm is a definition of a JMS provider, and is kind of a utility class to prevent the tedious work of repeatedly defining all parameters to connect to a queue or topic.
Singleton that has the different jmsRealms.
Typical use: JmsRealmFactory.getInstance().<method to execute>
Factory for the JMS Realms instance, which holds all JMS Realm definitions found in the Configuration File.
 
Implements a message log (JmsMessageLog) or error store (JmsErrorStorage) that uses JMS technology.
XAResourceRecoveryHelper implementation which gets XIDs, which needs to be recovered.
Provides all JNDI functions and is meant to act as a base class.
 
MongoClientFactory that retrieves its configuration from JNDI.
Class that does the actual JDNI lookup.
Deprecated.
 
Exception thrown by JobDefinitions when it is unable to successfully execute the job.
Factory for instantiating Schedules Jobs from the Digester framework.
XML Schema guided JSON to XML converter;
 
Pipe that validates the XML or JSON input message against a XML Schema and returns either XML or JSON.
 
 
 
Helper class to construct JSON from XML events.
BSON writer to write to FF DocumentBuilder, to generate JSON or XML.
Helper class to construct JSON from XML events.
 
 
 
 
A parameter which represents its value as a Message with mimetype application/json.
JSON is not aware of the element order.
 
 
Pipe that validates the input message against a JSON Schema.
Pipe that checks the well-formedness of the input message.
 
 
 
Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, XML or text.
Perform an XSLT transformation with a specified stylesheet on a JSON input, yielding JSON, yielding JSON, XML or text.
Utility functions for JTA
 
 
 
Creates a JWT with a shared secret using the HmacSHA256 algorithm.
 
 
 
 
Deprecated.
Deprecated.
 
 
 
CredentialFactory for Kubernetes Credentials.
Marker Annotation for Label annotations.
Transforms between ascii and an XML representation.
 
 
 
 
Call Ladybug Test Tool to rerun the reports present in test storage (see Test tab in Ladybug)
Interface between the AOP config and the Ladybug.
Enables WebSecurity, still depends on the existence of the AbstractSecurityWebApplicationInitializer.DEFAULT_FILTER_NAME.
Adds the IAuthenticator, so the LadybugSecurityChainConfigurer can use it to secure the ladybug in a traditional WAR deployment.
 
Spring Boot entrypoint when running as a normal WAR application.
 
 
This class is used to create and manage the lifecycle of Larva actions.
Reflection helper to create Larva Actions When a class is created it will attempt to set the name and disable HTTP SSL capabilities by default When setting the bean properties it loops through the available setter methods and looks for a matching property.
Custom Larva SpringContext, used to load the Larva scenario actions.
Larva Configuration options to control Larva behaviour.
 
Larva extra configuration options for HTML output and will parse all the LarvaConfig options from the HTTP Servlet Request.
Writer for Larva output that has HTML specific features and encodes output for HTML when it's not marked HTML already.
 
 
Call Larva Test Tool
 
 
 
 
 
 
 
Output specific for Larva.
During the ApplicationContext refresh Spring will try and automatically create and register all EventListeners EventListeners which implement this interface will be exempt from this behaviour but in turn will need to be registered manually in the required org.springframework.context.ConfigurableApplicationContext.
 
Client for LDAP.
consider setting the following properties:
- java.naming.provider.url
- com.sun.jndi.ldap.connect.pool
- java.naming.referral = follow
- nl.nn.iuf.LdapClient.groupAttributeCache.name
- nl.nn.iuf.LdapClient.groupAttributeCache.timeToLive

Connection Pooling:
To set connection pool properties that are set as custom properties, create a properties file named Ldap.properties with the attributes and place in the classpath.
Pipe that returns the memberships of a userDN.
Pipe that checks if a specified dn exists as 'member' in another specified dn in LDAP.
Sender to obtain information from and write to an LDAP Directory.
 
 
Old style of finding Modules, instead of self-registering, the code attempts to locate the module on the classpath.
 
RuntimeException to use when starting the lifecycle
Processor that limits the number of parallel pipeline threads.
Processor that limits the number of parallel pipe threads.
It is important that we're wrapping the Log4j2 Logger and are directly calling logIfEnabled.
 
LiquiBase implementation for IAF
Liquibase ResourceAccessor that can return a resource supplied at construction time.
 
 
 
Exception thrown by implementations of methods of listeners.
Factory for instantiating listeners from the Digester framework.
 
Message handler for JavaListener and WebServiceListener.
 
1.
abstract baseclass for Pipes that iterate over the lines in a lob.
 
FileSystem representation of the local filesystem.
Pipe to work with the server local filesystem.
Sender to work with the server local filesystem.
A Spring Integration Gateway in it's most simplistic form.
Set management.metrics.export.local=false to disable
 
Locker of scheduler jobs and pipes.
 
 
 
Pipe that stores all its parameter values in the ThreadContext, formerly known as Mapped Diagnostic Context (MDC), to be used in logging.
 
 
Logs the pipe name and the message before calling the pipe.
Should be called directly after the Environment has been initialized.
Sender that just logs its message.
Log4j can now be started from any LogManager.getLogger() call
Make a lower case variant of the instance.name property (instance.name.lc) available to the Ibis configuration and the Spring configuration.
 
 
 
 
 
 
 
 
 
sender that sends a mail specified by an XML message.
Pipe that sends a mail-message using a MailSender as its sender.
Models starting and stopping of objects that support such behaviour.
Exception thrown if a ManagedObject like an Adapter or Receiver is in an unexpected or illegal state.
 
 
 
 
 
Support for MariaDB.
 
Flow generator to create MERMAID files
 
 
 
Represents a field from the message browser item.
 
 
 
 
 
 
 
 
 
 
 
Keeps a list of MessageKeeperMessages.
 
A message for the MessageKeeper.
A JAX-WS wired message provider for handling soap messages
 
 
Read messages from the IBISSTORE database table previously stored by a 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.
 
 
Wrapper for messages that are not serializable.
Message will be closed after it's been read.
 
Generic Source for JMS connection, to be shared for JMS Objects that can use the same.
 
Singleton bean that keeps track of a Spring Application's uptime.
Based on MicrometerHttpClientInterceptor in `micrometer-metrics` repository on github.
Miscellaneous conversion functions.
Interface for Frank!
 
Sender to perform action on a MongoDB database.
 
Example configuration:
IMonitorAdapter that uses a sender to send its message.
 
 
 
 
Factory for the MonitorManagers, returns the context's manager This bean is a singleton, not a prototype, which is why the GenericFactory can not be used.
 
Manager for Monitoring.
 
 
 
 
 
 
JMS sender which will call IBM WebSphere MQ specific setTargetClient(JMSC.MQJMS_CLIENT_NONJMS_MQ) on the destination prior to sending a message.
 
 
Requires a resource to be configured.
MQTT listener which will connect to a broker and subscribe to a topic.
MQTT listener which will connect to a broker and subscribe to a topic.
This class ensures that Microsoft Authentication Library (MSAL) requests are sent through the configured proxy and the correct SSLSocketFactory.
Silly wrapper to create a clean SDK
 
 
Deprecated, for removal: This API element is subject to removal in a future version.
 
 
 
Builder for (mtom-)multipart HttpEntitys.
HttpMultipart represents a collection of MIME multipart encoded content bodies.
 
 
 
Support for MySql/MariaDB.
The NameAware is implemented by all objects where you can set a name.
 
This writer simply filters an other writer.
AttributesWrapper that removes all attributes that have a namespace, or are of a specific namespace
Filter that removes all Elements and attributes that are in a namespace, retaining only non-namespaced content.
AttributesWrapper that removes all namespaces, retaining only local names.
 
Soap Provider that accepts any message and routes it to a listener with a corresponding TargetObjectNamespacURI.
This bean creates an (CXF) endpoint with the /rpcrouter mapping for older SOAP based requests.
 
 
DataSource implementation wrapping XADataSource because Narayana doesn't provide their own DataSource.
 
 
 
The NetStorageCMSv35Signer is responsible for brokering the communication between the software layer and the API.
Currently only 3 signing hash types are supported.
Translates the request, adds required headers per action, creates a hash and signs the message.
Sender for Akamai NetStorage (HTTP based).
 
General utility functions needed to implement the HTTP SDK.
An enum of the keyed-hash algorithms supported by NetStorageUtils.computeKeyedHash(byte[], String, NetStorageUtils.KeyedHashAlgorithm) Currently supported hashes include HMAC-MD5; HMAC-SHA1; HMAC-SHA256 The string representation matches the java Mac.getInstance(String) cononical names.
Filter that copies only a single element type, and/or its contents.
Entity resolver which resolves external entities to an empty string.
Entity resolver which resolves external entities to an empty string.
NoOp authenticator, all requests are allowed.
Since Spring 6, the `@EnableWebSecurity` annotation seems to be adding a default SecurityFilterChain, if not exist yet.
 
OAuth2 Authentication provider which contains 4 defaults (Google, GitHub, Facebook and Okta), as well as a custom setting which allows users to use their own IDP.
HttpClient AuthScheme that uses OAuthAccessTokenManager to obtain an access token (via Client Credentials flow).
OAuth prefering AuthenticationStrategy.
 
Pipe that performs obfuscation on a message, using the tibcrypt library.
 
Uses a Cipher algorithm similar to the one used in com.tibco.security.ObfuscationEngine used before.
 
 
Baseclass for Object lookups.
 
 
 
 
Extension of ManagedDataSource that exposes an extra method to fetch pool statistics.
Extension of PoolingDataSource that exposes an extra method to fetch pool statistics.
 
 
 
 
 
Allows the creation of outbound integration gateways.
 
Writes to an in-memory buffer until it 'overflows', after which a file on disk will be created and the in-memory buffer will be flushed to it.
 
Overwrite a property available to the Ibis configuration and the Spring configuration.
 
 
Collection of Senders, that are executed all at the same time.
Placeholder class to allow legacy configuration notations <param type='number' /> in the new Frank!
Exception thrown by the ISender (implementation) to notify that the sending did not succeed.
Factory for instantiating Parameters from the Digester framework.
List of parameters.
Handler for parameter list xml elements like:
 
 
 
Generates a random password.
PBKDF2 salted password hashing.
Hash a password or validate a password against a hash using PasswordHash.java from https://crackstation.net/hashing-security.htm.
 
This class will combine seperate pdf files to a single pdf with attachments.
Converts the files which are required and supported by the Aspose pdf library.
Converts the files which are required and supported by the Aspose image library.
Converts files to pdf type.
 
Convertor for a pdf file (no conversion required).
Wrapper for IDataIterator, that allows to peek the object that will be returned by next().
Performs various PGP (Pretty Good Privacy) actions such as Encrypt, Sign, Decrypt, Verify.
 
Description of a pipe.
Get a description of a specified pipe.
Appears inside a pipe and defines what pipe or exit to execute next.
Optional element in a pipeline.
Required in each Adapter to transform incoming messages.
 
The Exit of a Pipeline that specifies the end state of a PipeLine.
Pipeline exit container in which all (required) Exits must be defined.
 
The PipeLineResult is a type to store both the result of the PipeLine processing as well as an exit state.
Basic implementation of PipeLineSession.
Wrapper class for PipeLineSession to be able to debug storing values in session keys.
 
Exception thrown when the doPipe() method of a Pipe runs in error.
The PipeRunResult is a type to store both the result of the processing of a message in doPipe() as well as the exitState.
 
 
 
Factory through which (TX-enabled) Pooling DataSources can be retrieved.
Alternative to DataSourceJDBCAccess that adds connection pooling, instead of doing a JNDI lookup each time a connection is called.
Support for PostgreSQL.
 
 
Utility class to report process parameters like memory usage as an xml-element.
 
 
Process execution utilities.
 
 
CredentialFactory that reads its credentials from a plain (unencrypted) .properties file.
 
Ensures that the setter cannot be called when parsing a Frank Configuration.
A true multi-threaded Listener-class.
 
Container that provides threads to execute pulling listeners.
JMSListener re-implemented as a pushing listener rather than a pulling listener.
Baseclass of a IPushingListener that enables a Receiver to receive messages from Servlets.
Puts the input or the value in the PipeLineSession, under the key specified by sessionKey.
Puts the system date/time under a key in the pipeLineSession.
 
 
 
 
 
Iterator that iterates over all lines in a Reader.
Wrapper for a listener that specifies a channel for the incoming messages of a specific Adapter.
 
 
 
When a listener implements this interface it will get a reference to it's parent receiver.
Wrapper for senders, that opens the wrapped sender at runtime before each sender action, and closes it afterwards.
Generic handler to be extended by other handlers.
Deprecated.
Warning: non-maintained functionality.
Deprecated.
Warning: non-maintained functionality.
Deprecated.
Warning: non-maintained functionality.
Sends a fixed value to the output
Each function must implement this interface
Deprecated.
Warning: non-maintained functionality.
Deprecated.
Warning: non-maintained functionality.
Frank!
 
 
Tries to match the input against the provided regex.
 
 
 
Configuration class (without annotation so it's not picked up automatically) to register all Filters.
If set on attribute setter or config child setter, forces attribute or config child to be declared explicitly with the child.
Perform a call to a RekenBox.
Retention annotation to specify the relation between two or more resources
First searches to the Scenario root directory Then attempts relative paths (to the scenario root directory) Then delegates to it's parent
 
Performs a reload on database configuration.
Remove specified cache key from cache with specified name.
Removes a key specified by sessionKey from the pipeLineSession.
 
This Pipe is used to replace values in a few ways.
Copyright 2019-2024 WeAreFrank!
Copyright 2019-2024 WeAreFrank!
Implementation of a repository factory that proxies all requests to a CmisEventListener When no EventListeners have been defined, all requests will be blocked.
 
 
Reference to a resource, for instance on the classpath.
 
ResourceLimiter for limiting the number of resources that can be used in parallel.
Class that look up a given resource in the resource file.
 
 
XSD based on a reference to a resource on the classPath.
 
Listener that allows a Receiver to receive messages as a REST webservice.
 
Servlet that listens for REST requests, and handles them over to the RestServiceDispatcher.
Some utilities for working with RestListener.
Restore moved elements from pipelineSession.
 
Singleton class that knows about the RestListeners that are active.
ResultHandler that writes the transformed record to a BLOB.
ResultHandler that writes the transformed record to a CLOB.
Deprecated.
Warning: non-maintained functionality.
Baseclass for batch resultHandler that writes the transformed record to a LOB.
Deprecated.
Warning: non-maintained functionality.
Deprecated.
Warning: non-maintained functionality.
 
QuerySender that writes each row in a ResultSet to a file.
Pipe that iterates over rows in in ResultSet.
Baseclass for resulthandlers that write the transformed record to a writer.
 
 
Extension of JNDIRealm where we take care of the role to ldap group mapping
 
 
Handler for xml root element containing INPUT, OUTPUT and TABLES (parameter lists).
 
 
Enumeration of states for ManagableLifecycle
Interface to support enquiries about the run state.
Interface to support enquiries about the run state.
Utility class to support run-state management.
Object to hold information about an object stored in Amazon S3.
Uses the (old) SMB 1 protocol.
 
Deprecated, for removal: This API element is subject to removal in a future version.
Uses the (old) SMB 1 protocol.
Uses the (newer) SMB 2 and 3 protocol.
 
 
File listener for an SMB2 or SMB3 share.
 
Uses the (newer) SMB 2 and 3 protocol.
 
Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
 
Exception thrown by classes in the sap-package (implementation) to notify various problems.
Wrapper round SAP-functions, either SAP calling Ibis, or Ibis calling SAP.
Deprecated, for removal: This API element is subject to removal in a future version.
Implementation of a IPushingListener, that enables a Receiver to receive messages from SAP-systems.
Wrapper for SAP sessions, used to control Logical Units of Work (LUWs).
Manager for SAP Logical Units of Work (LUWs).
Deprecated, for removal: This API element is subject to removal in a future version.
Base class for functions that call SAP.
Implementation of sender that calls a SAP RFC-function.
 
Deprecated, for removal: This API element is subject to removal in a future version.
 
Singleton that has the different sapSystems.
A SapSystem is a provider of repository information and connections to a SAP-system.
Base class for items of global lists.
 
 
 
 
 
Actively scans the configuration directory for file changes.
Pipe which scans TIBCO sources in Subversion and creates a report in xml.
Data class to hold scenario data.
 
Load scenario data for a given scenario file.
 
 
 
Container for jobs that are scheduled for periodic execution.
 
 
 
 
Extending the Spring SchedulerFactoryBean because it starts the Quartz scheduler instance.
The SchedulerHelper encapsulates the Quartz scheduler.
 
 
 
Sealed authenticator, all requests are blocked.
Java representation of a Secret retrieved from Delinea Secret Server.
Java representation of an Item of a Secret.
Response POJO for listing all secrets.
 
Add the SpringSecurity filter to enable authentication.
 
 
 
 
 
 
 
Exception thrown by the ISender (implementation) to notify that the sending did not succeed.
Deprecated.
Sends a message using an sender and optionally receives a reply from the same sender.
The SenderResult is a type to store both the result of the processing of a message by a Sender, as well as the exitState.
Series of Senders, that are executed one after another.
 
Wrapper for senders, that allows to get input from a session variable, and to store output in a session variable.
Interface for handlers in SenderWrapper processor chain.
Sender that sends a mail via SendGrid v3 (cloud-based SMTP provider).
 
 
 
Scheduled job to send messages to a FrankListener.
The sole purpose of this call is to prevent AOP wrapping around the sendMessage / sendMessageOrThrow methods.
Sends a message to a Tibco queue.
 
A reference to a file Path that can be serialized.
InputStream wrapper to allow streams to be serialized and deserialized so the (raw) binary data can be sent using Hazelcast.
 
 
The interface clients (users) of a service may use.
Singleton class that knows about the ServiceListeners that are active.
 
Yaml config example:
Enables the use of programmatically adding servlets to the given ServletContext.
Run during the ApplicationServers contextInitialized phase, before starting servlets.
 
 
Enumeration of Severities for monitoring.
Wrapper around a FTPFile to allow for relative path operations
Implementation of SFTP FileSystem
 
File listener for an SFTP connection.
 
Helper class for sftp.
 
Collection of Senders, that are executed all at the same time.
 
Registers the newly created bean directly in Spring, which will manage it's Lifecycle.
 
This exists because WSDL Definitions can grow dramatically in size when they include a few xsd's.
Logging should work even when the application failed to start which is why it's not wired through the MessageDispatcher.
 
 
 
Database Listener that returns a count of messages available, but does not perform any locking or other management of processing messages in parallel.
Stores a maximum number of elements in a Vector.
Returns the number of bytes or characters in the input.
This class omits XML elements from Frank configs that are meaningless containers.
 
Skip a number of bytes or characters from the input message.
Converts the files which are required and supported by the aspose slides library.
 
ErrorMessageFormatter that returns a soap fault message.
 
 
XmlValidator that will automatically add the SOAP envelope XSD to the set of XSD's used for validation.
 
Utility class that wraps and unwraps messages from (and into) a SOAP Envelope.
Pipe to wrap or unwrap a message from/into a SOAP Envelope.
 
Enumeration of SourceTypes for trigger filters.
 
 
 
 
Generate a flow over the digested Adapter or Configuration.
 
Implementation of Spring error handler that logs errors.
Configure a Spring JMS Container from a PushingJmsListener.
ISecurityHandler implementation that uses Spring Security's SecurityContextHolder to retrieve the user information.
proxy class for transaction manager.
 
Sql syntax translator to translate queries for different database management systems (e.g.
Starts up a configuration in a plain JVM.
 
Descendant of Woodstox XMLInputFactory, that accepts XML 1.1 compliant content in XML 1.0 documents too.
 
 
StoredProcedureQuerySender is used to send stored procedure queries and retrieve the result.
 
 
Sends a message to a Sender for each line of its input, that must be an InputStream.
Stream an input stream to an output stream.
Deprecated.
Warning: non-maintained functionality.
Functions to read and write from one stream to another.
StrictJsonWriter to write to FF DocumentBuilder, to generate JSON or XML.
IteratingPipe that has Strings as items.
 
Provide functionality to resolve ${property.key} to the value of the property key, recursively.
 
XSD implementation of an internally created schema, used as result of SchemaUtils.mergeXsdsGroupedByNamespaceToSchemasWithoutIncludes().
 
Handler for structure xml elements like:
 
 
Enumeration class for suppressing configuration warnings.
Some utilities for working with SVN.
Exception thrown when a synchronized local transaction failed to complete (after the main transaction has already completed).
Handler for table xml elements like:
 
Interface to allow an observer to act on events during the execution of Larva tests.
 
 
 
 
 
Keep track of the status of a test-run.
 
 
 
Pipe for converting TEXT to XML.
Breaks up the text input in blocks of a maximum length.
 
 
 
Connect a parent thread and a child thread to carry over important state from the parent thread to the child thread, such as ThreadContext, thread-local hide-regexes for masking sensitive information from logs (See IbisMaskingLayout, and transaction state via a TransactionConnector.
Interface for classes that need to be aware of when child-threads are created and terminated.
 
 
 
 
 
 
TibcoProperties are read as a property file, and must be converted (not cast) to the appropriate type.
Some utilities for working with TIBCO.
 
 
 
Exception thrown to signal that a timeout occurred.
TimeoutGuard interrupts running thread when timeout is exceeded.
Extension to FixedForwardPipe for interrupting processing when timeout is exceeded.
SaxException thrown to signal that a timeout occurred.
Tomcat Resource Factory that looks up objects in a delegate JNDI.
 
Adds the current pipe to the message context / metadata to be able to use it as a param.
DataSource that is aware of the database metadata.
 
 
 
 
 
 
 
 
 
This TransactionConnector suspends the transaction in the main thread, and resumes it in the child thread, for as long as it runs.
 
Wrapper for numerous transaction handling related exceptions.
Generic Transformer ErrorListener.
 
A TransformerHandler listens for SAX ContentHandler parse events and transforms them to a Result.
Pool of transformers.
 
A Trigger that has its type configured at startup.
 
 
 
Assumes input to be the file name of a ZIP archive, and unzips it to a directory and/or an XML message.
 
 
 
 
 
 
 
 
 
Reference to a resource, within the Configuration scope.
 
 
 
Pipe that generates an UUID (Universally Unique Identifier).
 
 
 
 
Created by mrwho on 03/06/15.
 
 
Verifies if a (valid) connection can be made.
 
Generate an ETag identifier for each request so the client knows that the contents are not modified if they match
Default IBIS Configuration ClassLoader.
This class is found by the `FrankFrameworkApiContext.xml` file, is loaded after the xml has been loaded/wired.
This servlet allows the use of WebContent served from Configurations.
Listener that allows a Receiver to receive messages as a SOAP webservice.
Deprecated, for removal: This API element is subject to removal in a future version.
 
 
 
 
 
 
Sender that sends a message via a WebService.
It is important that we register the correct CXF bus, or else JAX-RS (IAF-API / WebServiceListener) won't work properly
This class is found by classpath scanning in the `FrankFrameworkApiContext.xml` file.
Implementation of a FilenameFilter to support wildcards.
This CredentialFactory implementation uses the WildFly Credential Store to retrieve credentials.
 
 
 
Utility class to generate the WSDL.
 
 
 
Generate WSDL of parent or specified adapter.
 
XmlValidator that will read the XSD's to use from a WSDL.
Extension of ResourceXsd, where the schema is retrieved from a WSDL.
XCom client voor het versturen van files via XCom.
 
 
 
 
Xerces based XML validator.
Sender for transferring files using the XFB protocol.
XML Schema guided XML to JSON converter;
XMLFilter with option to get schema information about child elements to be parsed.
 
Builds an XML-element with attributes and sub-elements.
 
 
Exception class for errors during XML processing
Deprecated, for removal: This API element is subject to removal in a future version.
please use the IfPipe for if (else/then) behaviour.
Sender for browsing and removing queue messages (with input and output in a XML message).
 
 
 
 
 
QuerySender that transforms the input message to a query.
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.
 
 
Convert an XML DOM document to the flat label-format of the rekenbox.
 
Some utilities for working with XML.
Pipe that validates the input message against an XML Schema.
Wrapper for the XML response validator.
SAX ContentHandler used during XML validation for some additional validation checks and getting more information in case validation fails.
 
 
 
 
 
Sender that validates the input message against a XML Schema.
Pipe that checks the well-formedness of the input message.
 
Perform an XQuery.
Applies a XSLT-stylesheet to the standard error generated by an ErrorMessageFormatter.
Perform an XSLT transformation with a specified stylesheet.
XSLT provider listener for the Test Tool.
Perform an XSLT transformation with a specified stylesheet or XPath-expression.
Deprecated.
Please note that the information returned by this ErrorMessageFormatter is not very informative.
 
Authenticator for in-memory authentication using a YAML file.
 
 
Sends a message to a Sender for each entry of its input, that must be an ZipInputStream.
 
Pipe that creates a ZIP archive (on action close).
Sender that writes an entry to a ZipStream, similar to ZipWriterPipe with action='write'.