Spring Integration 6.0.0-SNAPSHOT API

This document is the API specification for Spring Integration

For further API reference and developer documentation, see the Spring Integration reference documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Spring Integration main project page

If you are interested in commercial training, consultancy, and support for Spring Integration, please visit https://spring.io

Packages
Package
Description
Base package for Spring Integration Core.
Provides classes related to message acknowledgment.
Provides classes related to message aggregation.
Provides classes related to AMQP-backed channels.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides AMQP Component support for the Java DSL.
Provides classes supporting inbound endpoints.
Provides classes supporting outbound endpoints.
Provides AMQP support classes.
Provides annotations for annotation-based configuration.
Provides classes to support message publication using AOP.
Provides classes representing various channel types.
Provides classes related to channel interception.
Provides base classes for the Codec abstraction.
The Kryo specific Codec classes.
Base package for configuration.
Provides classes supporting annotation-based configuration.
Provides supporting XML-based configuration - parsers, namespace handlers.
Provides classes relating to application context configuration.
Provides core classes.
Provides classes related to dispatching messages.
Root package of the Spring Integration Java DSL.
The context support classes for Spring Integration Java DSL.
Provides various support classes used across Spring Integration Java DSL Components.
Provides core classes related to Endpoints.
Provides classes for configuration - parsers, namespace handlers.
Provides Event core classes.
Provides classes supporting inbound endpoints.
Provides classes supporting outbound endpoints.
ApplicationEvents generated by the Spring Integration framework.
Provides classes supporting SpEL expressions.
Provides classes for configuration - parsers, namespace handlers.
Provides Feed Components support for Spring Integration Java DSL.
Provides classes supporting inbound endpoints.
Base package for File support.
Provides support classes for file-based aggregation logic.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides File Components support for Spring Integration Java DSL.
ApplicationEvents generated by the file module.
Provides classes supporting file filtering.
Provides classes supporting file locking.
Base package for supporting remote files.
Provides classes related to AOP.
Provides classes supporting remote file gateways.
Provides classes supporting remote file message handlers.
Provides classes related to file servers.
Provides classes supporting remote file sessions.
Provides classes supporting the synchronization of remote and local file directories.
Provides implementations of AbstractMessageSplitter.
Provides various support classes used across Spring Integration File Components.
Classes used for tailing file system files.
Provides classes supporting the transformation of file contents to messages.
Provides classes supporting the filter pattern.
Provides classes for configuration - parsers, namespace handlers.
Provides FTP Components for the Java DSL.
Provides classes supporting FTP file filtering.
Provides classes supporting FTP gateways.
Provides classes supporting inbound endpoints.
Provides classes for the FTP outbound channel adapter.
Provides classes related to FTP servers.
Provides classes supporting FTP sessions.
Provides classes supporting messaging gateways.
Provides classes for configuration - parsers, namespace handlers.
Provides classes supporting inbound endpoints.
Provides classes for the Gemfire MetadataStore.
Provides classes supporting outbound endpoints.
Provides classes releated to storing messages.
Provides utility classes.
Provides classes related to the runtime object graph.
Base package for Groovy support.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides classes implementing various types of message handler.
Provides classes that are used to advise MessageHandlers with cross-cutting concerns.
Provides classes for message handlers support.
Provides classes supporting the capture of message history.
Base package for Http support.
Provides classes for configuration - parsers, namespace handlers.
Provides classes supporting message conversion.
Provides HTTP Components support for Spring Integration Java DSL.
Provides classes supporting inbound endpoints.
Provides classes related to management support.
Provides classes supporting multipart HTTP requests.
Provides classes supporting outbound endpoints.
Provides classes to support Http endpoints, including header mapping.
Base package for IP (TCP/UDP) Support.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides TCP/UDP Component support for the Java DSL.
ApplicationEvents generated by the ip module.
Base package for TCP Support.
All things related to tcp connections - client and server factories; listener and sender interfaces.
Byte array (de)serializers for putting some protocol on the wire so that incoming messages can be constructed from stream data.
Base package for UDP support.
Provides utilities for IP support.
Root package of the Spring Integration JDBC module, which contains various JDBC and Stored Procedure/Function supporting components.
Contains parser classes for the JDBC namespace support.
 
Contains JDBC implementation of MetadataStore
Provides JDBC-backed Message Store implementations.
Provides support classes for the JdbcChannelMessageStore.
Provides Stored Procedure/Function supporting classes.
Base package for JMS Support.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides JMS Component support for the Java DSL.
 
Base package for JMX support.
Provides classes for configuration - parsers, namespace handlers.
Provides parser classes to provide Xml namespace support for the Jpa components.
Provides core classes of the JPA module.
Provides JPA Components support for Java DSL.
Provides inbound Spring Integration Jpa components.
Provides Spring Integration components for doing outbound operations.
Provides various support classes used across Spring Integration Jpa Components.
Provides generic support for ParameterSources and ParameterSource Factories.
Provides classes supporting JSON in Spring Integration.
Provides classes related to message channel implementations for Apache Kafka.
Provides parser classes to provide Xml namespace support for the Apache Kafka components.
Provides Spring Integration Java DSL Components support for Apache Kafka.
Provides Spring Integration inbound components for Apache Kafka.
Provides Spring Integration outbound components for Apache Kafka.
Provides support classes.
Temporary package until s-c-c-core is released.
Temporary package until s-c-c-core is released.
Base package for Mail support.
Provides classes for configuration - parsers, namespace handlers.
Provides Mail Components for the Java DSL.
Events generated by the mail module
Provides classes to support email.
Provides classes related to transforming mail messages.
Provides classes related to mapping to/from message headers.
Support classes for mapping.
Provides concrete Message implementations.
Provides classes supporting metadata stores.
Contains parser classes for the MongoDb namespace support.
Provides MongoDB Components support for Java DSL.
Provides classes related to the Mongo inbound channel adapters
Contains mongodb metadata store related classes
Provides classes related to the Mongo outbound channel adapters
Provides classes related to the MongoDB message store.
Provides supporting classes for this module.
Provides classes related to Spring Integration managed resources.
Provides parser classes to provide Xml namespace support for the MqttAdapter components.
Provides core classes of the MqttAdapter module.
ApplicationEvents generated by the mqtt module.
Provides inbound Spring Integration MqttAdapter components.
Provides Spring Integration components for doing outbound operations.
Provides various support classes used across Spring Integration MqttAdapter Components.
Provides classes for supporting Java DSL for R2DBC components.
Provides classes for supporting R2DBC inbound components.
Provides classes for supporting R2DBC outbound components.
Provides classes related to Redis-backed channels.
Provides classes for configuration - parsers, namespace handlers.
Events generated by the redis module
Provides classes supporting inbound endpoints.
Provides support for Redis-based MetadataStores.
Provides classes supporting outbound endpoints.
Provides classes related to the Redis message store.
Provides supporting classes for this module.
Provides utility classes.
Provides classes related to messaging using Spring Resources
Provides classes supporting the router pattern.
Provides classes supporting the RoutingSlip pattern.
Provides common classes for RSocket components.
Provides classes for RSocket XML namespace parsing and configuration support.
Provides RSocket Components support for Spring Integration Java DSL.
Provides classes representing inbound RSocket components.
Provides classes representing outbound RSocket components.
Provides classes supporting the Scatter-Gather pattern.
Provides classes related to task scheduling.
Base package for scripting support.
Base package supporting configuration.
Provides classes for configuration - parsers, namespace handlers.
Provides Scripting Components support for Spring Integration Java DSL.
Provides classes supporting JSR223 Scripting.
Provides classes related to secured channels.
Provides classes for configuration - parsers, namespace handlers, bean post processors.
Provides classes related to message selection.
Provides classes for configuration - parsers, namespace handlers.
Provides SFTP Components for the Java DSL.
Provides classes supporting SFTP file filtering.
Provides classes supporting SFTP gateways.
Provides classes supporting inbound endpoints.
Provides classes for the SFTP outbound channel adapter.
Provides classes related to SFTP servers.
Provides classes supporting SFTP sessions.
Provides general support classes for sftp.
Provides classes supporting the splitter pattern.
Provides core classes STOMP components.
Contains parser classes for the STOMP namespace support.
 
Provides classes which represent inbound STOMP components.
Provides classes which represent outbound STOMP components.
Provides classes to support STOMP components.
Provides classes releated to storing messages.
Base package for stream support.
Provides classes for configuration - parsers, namespace handlers.
Base core support package.
 
Provides classes supporting use of the application context.
Provides classes supporting message conversion.
Provides classes supporting json.
 
Provides classes related to locking resources.
Provides classes related to management support.
Provides interfaces related to 5.0 metrics.
Provides classes to support the use of Micrometer for metrics.
Provides global utility support classes for the runtime system.
Base package for Syslog Support.
Provides classes for configuration - parsers, namespace handlers, factory beans.
Provides classes for inbound endpoints.
 
Test context-related components.
Provides testing utils for mail support.
Provides several BaseMatcher implementations.
Utilities for mocking integration components.
 
Provides various test rules.
Provides several test support classes including for testing Spring Integration request-response message scenarios.
Provides various test utilities, for example TestUtils provides convenience helpers to easily retrieve private bean properties.
Provides classes supporting the use of transactions and pseudo transactions in Spring Integration applications.
Contains core-implementation of various Transformers which includes Enrichers and Filters.
Contains support classes for Transformers.
Provides core utility classes.
Provides classes for configuration - parsers, namespace handlers.
Provides WebFlux Components support for Spring Integration Java DSL.
Provides classes supporting inbound endpoints.
Provides classes supporting outbound endpoints.
Provides classes to support WebFlux endpoints.
Provides classes used across all WebSocket components.
Contains parser classes for the WebSockets namespace support.
 
Provides classes which represent inbound WebSocket components.
Provides classes which represent outbound WebSocket components.
Provides support classes used from WebSocket components.
Provides several inbound and outbound Web Service components.
Contains parser classes for the Web Services namespace support.
Contains classes for DSL support.
Root package of the XML Module.
Contains parser classes for the XML namespace support.
Provides ResultFactory that will return Result, possibly taking into account payload instance.
Provides XML message routers.
Provides XML-centric MessageSelector implementations.
Provides various SourceFactory implementations.
Provides implementations of AbstractMessageSplitter.
Provides Transformer and Enricher implementations.
Contains support classes for Transformers.
Provides XPath supporting classes.
Root package of the Spring Integration XMPP Module.
Contains parser classes for the XMPP namespace support.
Provides classes shared across all XMPP components.
Provides XMPP inbound Endpoint implementations that extend AbstractXmppConnectionAwareEndpoint.
Provides XMPP outbound MessageHandler implementations.
Provides XMPP specific support classes.
Provides common classes for supporting ZeroMQ components.
Provides classes for message channels support over ZeroMQ.
Provides classes for supporting ZeroMQ component via Java DSL.
Provides classes for inbound channel adapters over ZeroMQ.
Provides classes for outbound channel adapters over ZeroMQ.
 
Base package for zookeeper configuration.
Temporary package until s-c-c-zookeeper is released.
Provides classes related to locking.
Provides classes supporting the Zookeeper-based ListenableMetadataStore