Spring Integration 5.5.0-RC1 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
org.springframework.integration
Base package for Spring Integration Core.
org.springframework.integration.acks
Provides classes related to message acknowledgment.
org.springframework.integration.aggregator
Provides classes related to message aggregation.
org.springframework.integration.amqp.channel
Provides classes related to AMQP-backed channels.
org.springframework.integration.amqp.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.amqp.dsl
Provides AMQP Component support for the Java DSL.
org.springframework.integration.amqp.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.amqp.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.amqp.support
Provides AMQP support classes.
org.springframework.integration.annotation
Provides annotations for annotation-based configuration.
org.springframework.integration.aop
Provides classes to support message publication using AOP.
org.springframework.integration.channel
Provides classes representing various channel types.
org.springframework.integration.channel.interceptor
Provides classes related to channel interception.
org.springframework.integration.codec
Provides base classes for the Codec abstraction.
org.springframework.integration.codec.kryo
The Kryo specific Codec classes.
org.springframework.integration.config
Base package for configuration.
org.springframework.integration.config.annotation
Provides classes supporting annotation-based configuration.
org.springframework.integration.config.xml
Provides supporting XML-based configuration - parsers, namespace handlers.
org.springframework.integration.context
Provides classes relating to application context configuration.
org.springframework.integration.core
Provides core classes.
org.springframework.integration.dispatcher
Provides classes related to dispatching messages.
org.springframework.integration.dsl
Root package of the Spring Integration Java DSL.
org.springframework.integration.dsl.context
The context support classes for Spring Integration Java DSL.
org.springframework.integration.dsl.support
Provides various support classes used across Spring Integration Java DSL Components.
org.springframework.integration.endpoint
Provides core classes related to Endpoints.
org.springframework.integration.event.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.event.core
Provides Event core classes.
org.springframework.integration.event.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.event.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.events
ApplicationEvents generated by the Spring Integration framework.
org.springframework.integration.expression
Provides classes supporting SpEL expressions.
org.springframework.integration.feed.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.feed.dsl
Provides Feed Components support for Spring Integration Java DSL.
org.springframework.integration.feed.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.file
Base package for File support.
org.springframework.integration.file.aggregator
Provides support classes for file-based aggregation logic.
org.springframework.integration.file.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.file.dsl
Provides File Components support for Spring Integration Java DSL.
org.springframework.integration.file.event
ApplicationEvents generated by the file module.
org.springframework.integration.file.filters
Provides classes supporting file filtering.
org.springframework.integration.file.locking
Provides classes supporting file locking.
org.springframework.integration.file.remote
Base package for supporting remote files.
org.springframework.integration.file.remote.aop
Provides classes related to AOP.
org.springframework.integration.file.remote.gateway
Provides classes supporting remote file gateways.
org.springframework.integration.file.remote.handler
Provides classes supporting remote file message handlers.
org.springframework.integration.file.remote.server
Provides classes related to file servers.
org.springframework.integration.file.remote.session
Provides classes supporting remote file sessions.
org.springframework.integration.file.remote.synchronizer
Provides classes supporting the synchronization of remote and local file directories.
org.springframework.integration.file.splitter
Provides implementations of AbstractMessageSplitter.
org.springframework.integration.file.support
Provides various support classes used across Spring Integration File Components.
org.springframework.integration.file.tail
Classes used for tailing file system files.
org.springframework.integration.file.transformer
Provides classes supporting the transformation of file contents to messages.
org.springframework.integration.filter
Provides classes supporting the filter pattern.
org.springframework.integration.ftp.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.ftp.dsl
Provides FTP Components for the Java DSL.
org.springframework.integration.ftp.filters
Provides classes supporting FTP file filtering.
org.springframework.integration.ftp.gateway
Provides classes supporting FTP gateways.
org.springframework.integration.ftp.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.ftp.outbound
Provides classes for the FTP outbound channel adapter.
org.springframework.integration.ftp.server
Provides classes related to FTP servers.
org.springframework.integration.ftp.session
Provides classes supporting FTP sessions.
org.springframework.integration.gateway
Provides classes supporting messaging gateways.
org.springframework.integration.gemfire.config.xml
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.gemfire.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.gemfire.metadata
Provides classes for the Gemfire MetadataStore.
org.springframework.integration.gemfire.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.gemfire.store
Provides classes releated to storing messages.
org.springframework.integration.gemfire.util
Provides utility classes.
org.springframework.integration.graph
Provides classes related to the runtime object graph.
org.springframework.integration.groovy
Base package for Groovy support.
org.springframework.integration.groovy.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.handler
Provides classes implementing various types of message handler.
org.springframework.integration.handler.advice
Provides classes that are used to advise MessageHandlers with cross-cutting concerns.
org.springframework.integration.handler.support
Provides classes for message handlers support.
org.springframework.integration.history
Provides classes supporting the capture of message history.
org.springframework.integration.http
Base package for Http support.
org.springframework.integration.http.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.http.converter
Provides classes supporting message conversion.
org.springframework.integration.http.dsl
Provides HTTP Components support for Spring Integration Java DSL.
org.springframework.integration.http.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.http.management
Provides classes related to management support.
org.springframework.integration.http.multipart
Provides classes supporting multipart HTTP requests.
org.springframework.integration.http.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.http.support
Provides classes to support Http endpoints, including header mapping.
org.springframework.integration.ip
Base package for IP (TCP/UDP) Support.
org.springframework.integration.ip.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.ip.dsl
Provides TCP/UDP Component support for the Java DSL.
org.springframework.integration.ip.event
ApplicationEvents generated by the ip module.
org.springframework.integration.ip.tcp
Base package for TCP Support.
org.springframework.integration.ip.tcp.connection
All things related to tcp connections - client and server factories; listener and sender interfaces.
org.springframework.integration.ip.tcp.serializer
Byte array (de)serializers for putting some protocol on the wire so that incoming messages can be constructed from stream data.
org.springframework.integration.ip.udp
Base package for UDP support.
org.springframework.integration.ip.util
Provides utilities for IP support.
org.springframework.integration.jdbc
Root package of the Spring Integration JDBC module, which contains various JDBC and Stored Procedure/Function supporting components.
org.springframework.integration.jdbc.config
Contains parser classes for the JDBC namespace support.
org.springframework.integration.jdbc.lock  
org.springframework.integration.jdbc.metadata
Contains JDBC implementation of MetadataStore
org.springframework.integration.jdbc.store
Provides JDBC-backed Message Store implementations.
org.springframework.integration.jdbc.store.channel
Provides support classes for the JdbcChannelMessageStore.
org.springframework.integration.jdbc.storedproc
Provides Stored Procedure/Function supporting classes.
org.springframework.integration.jms
Base package for JMS Support.
org.springframework.integration.jms.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.jms.dsl
Provides JMS Component support for the Java DSL.
org.springframework.integration.jms.util  
org.springframework.integration.jmx
Base package for JMX support.
org.springframework.integration.jmx.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.jpa.config.xml
Provides parser classes to provide Xml namespace support for the Jpa components.
org.springframework.integration.jpa.core
Provides core classes of the JPA module.
org.springframework.integration.jpa.dsl
Provides JPA Components support for Java DSL.
org.springframework.integration.jpa.inbound
Provides inbound Spring Integration Jpa components.
org.springframework.integration.jpa.outbound
Provides Spring Integration components for doing outbound operations.
org.springframework.integration.jpa.support
Provides various support classes used across Spring Integration Jpa Components.
org.springframework.integration.jpa.support.parametersource
Provides generic support for ParameterSources and ParameterSource Factories.
org.springframework.integration.json
Provides classes supporting JSON in Spring Integration.
org.springframework.integration.kafka.channel
Provides classes related to message channel implementations for Apache Kafka.
org.springframework.integration.kafka.config.xml
Provides parser classes to provide Xml namespace support for the Apache Kafka components.
org.springframework.integration.kafka.dsl
Provides Spring Integration Java DSL Components support for Apache Kafka.
org.springframework.integration.kafka.inbound
Provides Spring Integration inbound components for Apache Kafka.
org.springframework.integration.kafka.outbound
Provides Spring Integration outbound components for Apache Kafka.
org.springframework.integration.kafka.support
Provides support classes.
org.springframework.integration.leader
Temporary package until s-c-c-core is released.
org.springframework.integration.leader.event
Temporary package until s-c-c-core is released.
org.springframework.integration.mail
Base package for Mail support.
org.springframework.integration.mail.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.mail.dsl
Provides Mail Components for the Java DSL.
org.springframework.integration.mail.event
Events generated by the mail module
org.springframework.integration.mail.support
Provides classes to support email.
org.springframework.integration.mail.transformer
Provides classes related to transforming mail messages.
org.springframework.integration.mapping
Provides classes related to mapping to/from message headers.
org.springframework.integration.mapping.support
Support classes for mapping.
org.springframework.integration.message
Provides concrete Message implementations.
org.springframework.integration.metadata
Provides classes supporting metadata stores.
org.springframework.integration.mongodb.config
Contains parser classes for the MongoDb namespace support.
org.springframework.integration.mongodb.dsl
Provides MongoDB Components support for Java DSL.
org.springframework.integration.mongodb.inbound
Provides classes related to the Mongo inbound channel adapters
org.springframework.integration.mongodb.metadata
Contains mongodb metadata store related classes
org.springframework.integration.mongodb.outbound
Provides classes related to the Mongo outbound channel adapters
org.springframework.integration.mongodb.store
Provides classes related to the MongoDB message store.
org.springframework.integration.mongodb.support
Provides supporting classes for this module.
org.springframework.integration.monitor
Provides classes related to Spring Integration managed resources.
org.springframework.integration.mqtt.config.xml
Provides parser classes to provide Xml namespace support for the MqttAdapter components.
org.springframework.integration.mqtt.core
Provides core classes of the MqttAdapter module.
org.springframework.integration.mqtt.event
ApplicationEvents generated by the mqtt module.
org.springframework.integration.mqtt.inbound
Provides inbound Spring Integration MqttAdapter components.
org.springframework.integration.mqtt.outbound
Provides Spring Integration components for doing outbound operations.
org.springframework.integration.mqtt.support
Provides various support classes used across Spring Integration MqttAdapter Components.
org.springframework.integration.r2dbc.dsl
Provides classes for supporting Java DSL for R2DBC components.
org.springframework.integration.r2dbc.inbound
Provides classes for supporting R2DBC inbound components.
org.springframework.integration.r2dbc.outbound
Provides classes for supporting R2DBC outbound components.
org.springframework.integration.redis.channel
Provides classes related to Redis-backed channels.
org.springframework.integration.redis.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.redis.event
Events generated by the redis module
org.springframework.integration.redis.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.redis.metadata
Provides support for Redis-based MetadataStores.
org.springframework.integration.redis.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.redis.store
Provides classes related to the Redis message store.
org.springframework.integration.redis.support
Provides supporting classes for this module.
org.springframework.integration.redis.util
Provides utility classes.
org.springframework.integration.resource
Provides classes related to messaging using Spring Resources
org.springframework.integration.rmi
Base package for RMI support.
org.springframework.integration.rmi.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.router
Provides classes supporting the router pattern.
org.springframework.integration.routingslip
Provides classes supporting the RoutingSlip pattern.
org.springframework.integration.rsocket
Provides common classes for RSocket components.
org.springframework.integration.rsocket.config
Provides classes for RSocket XML namespace parsing and configuration support.
org.springframework.integration.rsocket.dsl
Provides RSocket Components support for Spring Integration Java DSL.
org.springframework.integration.rsocket.inbound
Provides classes representing inbound RSocket components.
org.springframework.integration.rsocket.outbound
Provides classes representing outbound RSocket components.
org.springframework.integration.scattergather
Provides classes supporting the Scatter-Gather pattern.
org.springframework.integration.scheduling
Provides classes related to task scheduling.
org.springframework.integration.scripting
Base package for scripting support.
org.springframework.integration.scripting.config
Base package supporting configuration.
org.springframework.integration.scripting.config.jsr223
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.scripting.dsl
Provides Scripting Components support for Spring Integration Java DSL.
org.springframework.integration.scripting.jsr223
Provides classes supporting JSR223 Scripting.
org.springframework.integration.security.channel
Provides classes related to secured channels.
org.springframework.integration.security.config
Provides classes for configuration - parsers, namespace handlers, bean post processors.
org.springframework.integration.selector
Provides classes related to message selection.
org.springframework.integration.sftp.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.sftp.dsl
Provides SFTP Components for the Java DSL.
org.springframework.integration.sftp.filters
Provides classes supporting SFTP file filtering.
org.springframework.integration.sftp.gateway
Provides classes supporting SFTP gateways.
org.springframework.integration.sftp.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.sftp.outbound
Provides classes for the SFTP outbound channel adapter.
org.springframework.integration.sftp.server
Provides classes related to SFTP servers.
org.springframework.integration.sftp.session
Provides classes supporting SFTP sessions.
org.springframework.integration.sftp.support
Provides general support classes for sftp.
org.springframework.integration.splitter
Provides classes supporting the splitter pattern.
org.springframework.integration.stomp
Provides core classes STOMP components.
org.springframework.integration.stomp.config
Contains parser classes for the STOMP namespace support.
org.springframework.integration.stomp.event  
org.springframework.integration.stomp.inbound
Provides classes which represent inbound STOMP components.
org.springframework.integration.stomp.outbound
Provides classes which represent outbound STOMP components.
org.springframework.integration.stomp.support
Provides classes to support STOMP components.
org.springframework.integration.store
Provides classes releated to storing messages.
org.springframework.integration.stream
Base package for stream support.
org.springframework.integration.stream.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.support
Base core support package.
org.springframework.integration.support.channel  
org.springframework.integration.support.context
Provides classes supporting use of the application context.
org.springframework.integration.support.converter
Provides classes supporting message conversion.
org.springframework.integration.support.json
Provides classes supporting json.
org.springframework.integration.support.leader  
org.springframework.integration.support.locks
Provides classes related to locking resources.
org.springframework.integration.support.management
Provides classes related to management support.
org.springframework.integration.support.management.metrics
Provides interfaces related to 5.0 metrics.
org.springframework.integration.support.management.micrometer
Provides classes to support the use of Micrometer for metrics.
org.springframework.integration.support.utils
Provides global utility support classes for the runtime system.
org.springframework.integration.syslog
Base package for Syslog Support.
org.springframework.integration.syslog.config
Provides classes for configuration - parsers, namespace handlers, factory beans.
org.springframework.integration.syslog.inbound
Provides classes for inbound endpoints.
org.springframework.integration.test.condition  
org.springframework.integration.test.context
Test context-related components.
org.springframework.integration.test.mail
Provides testing utils for mail support.
org.springframework.integration.test.matcher
Provides several BaseMatcher implementations.
org.springframework.integration.test.mock
Utilities for mocking integration components.
org.springframework.integration.test.predicate  
org.springframework.integration.test.rule
Provides various test rules.
org.springframework.integration.test.support
Provides several test support classes including for testing Spring Integration request-response message scenarios.
org.springframework.integration.test.util
Provides various test utilities, for example TestUtils provides convenience helpers to easily retrieve private bean properties.
org.springframework.integration.transaction
Provides classes supporting the use of transactions and pseudo transactions in Spring Integration applications.
org.springframework.integration.transformer
Contains core-implementation of various Transformers which includes Enrichers and Filters.
org.springframework.integration.transformer.support
Contains support classes for Transformers.
org.springframework.integration.util
Provides core utility classes.
org.springframework.integration.webflux.config
Provides classes for configuration - parsers, namespace handlers.
org.springframework.integration.webflux.dsl
Provides WebFlux Components support for Spring Integration Java DSL.
org.springframework.integration.webflux.inbound
Provides classes supporting inbound endpoints.
org.springframework.integration.webflux.outbound
Provides classes supporting outbound endpoints.
org.springframework.integration.webflux.support
Provides classes to support WebFlux endpoints.
org.springframework.integration.websocket
Provides classes used across all WebSocket components.
org.springframework.integration.websocket.config
Contains parser classes for the WebSockets namespace support.
org.springframework.integration.websocket.event  
org.springframework.integration.websocket.inbound
Provides classes which represent inbound WebSocket components.
org.springframework.integration.websocket.outbound
Provides classes which represent outbound WebSocket components.
org.springframework.integration.websocket.support
Provides support classes used from WebSocket components.
org.springframework.integration.ws
Provides several inbound and outbound Web Service components.
org.springframework.integration.ws.config
Contains parser classes for the Web Services namespace support.
org.springframework.integration.ws.dsl
Contains classes for DSL support.
org.springframework.integration.xml
Root package of the XML Module.
org.springframework.integration.xml.config
Contains parser classes for the XML namespace support.
org.springframework.integration.xml.result
Provides ResultFactory that will return Result, possibly taking into account payload instance.
org.springframework.integration.xml.router
Provides XML message routers.
org.springframework.integration.xml.selector
Provides XML-centric MessageSelector implementations.
org.springframework.integration.xml.source
Provides various SourceFactory implementations.
org.springframework.integration.xml.splitter
Provides implementations of AbstractMessageSplitter.
org.springframework.integration.xml.transformer
Provides Transformer and Enricher implementations.
org.springframework.integration.xml.transformer.support
Contains support classes for Transformers.
org.springframework.integration.xml.xpath
Provides XPath supporting classes.
org.springframework.integration.xmpp
Root package of the Spring Integration XMPP Module.
org.springframework.integration.xmpp.config
Contains parser classes for the XMPP namespace support.
org.springframework.integration.xmpp.core
Provides classes shared across all XMPP components.
org.springframework.integration.xmpp.inbound
Provides XMPP inbound Endpoint implementations that extend AbstractXmppConnectionAwareEndpoint.
org.springframework.integration.xmpp.outbound
Provides XMPP outbound MessageHandler implementations.
org.springframework.integration.xmpp.support
Provides XMPP specific support classes.
org.springframework.integration.zeromq
Provides common classes for supporting ZeroMQ components.
org.springframework.integration.zeromq.channel
Provides classes for message channels support over ZeroMQ.
org.springframework.integration.zeromq.dsl
Provides classes for supporting ZeroMQ component via Java DSL.
org.springframework.integration.zeromq.inbound
Provides classes for inbound channel adapters over ZeroMQ.
org.springframework.integration.zeromq.outbound
Provides classes for outbound channel adapters over ZeroMQ.
org.springframework.integration.zookeeper.config  
org.springframework.integration.zookeeper.config.xml
Base package for zookeeper configuration.
org.springframework.integration.zookeeper.leader
Temporary package until s-c-c-zookeeper is released.
org.springframework.integration.zookeeper.lock
Provides classes related to locking.
org.springframework.integration.zookeeper.metadata
Provides classes supporting the Zookeeper-based ListenableMetadataStore