f30da932e8
This is a significant update to the build system, including the changes listed below. README.md has been updated with instructions on the most important day-to-day commands. - Eliminate buildSrc submodule In favor of using the new bundlor and docbook-reference plugins. The net effect is a large reduction in number of lines of build code. Common docbook resources, stylesheets, etc are stored directly in the docbook plugin. This means that --recursive is no longer required when cloning and there will never be a need to use `git submodule` commands. README files have been updated to reflect. Use of the new bundlor plugin also means the removal of template.mf files from the source tree in favor of an inline approach. See build.gradle for details. Bundlor 'import templates' are built up programmatically and kept physically close to gradle dependency declarations, leading to more convenience when changing these values and hopefully fewer errors / version inconsistencies over time. Certain tests depended on the presence of template.mf files, all of which have recently been removed from the source tree in favor of the new bundlor plugin which allows for inlining bundlor configuration within the Gradle build script. These tests now create temp files using the java.io.File API instead. - Upgrade to Gradle 1.0-milestone-6 The m6 release is significantly faster when resolving dependencies and has a number of valuable new features over the earlier m3 version. Review the release notes for Gradle 1.0-milestone-6 online for full details. - Switch to repo.springsource.org repository Previously the project build declared as many repositories as necessary to resolve all project dependencies. Now depending on a single 'virtual repository' defined within the SpringSource Artifactory instance at http://repo.springsource.org. Currently, the virtual repository in use is 'libs-milestone', which allows for the resolution of all "milestone-or-better" versions of all S2 and third-party dependencies. Should snapshot dependencies become required, this value may be changed from 'libs-milestone' to 'libs-snapshot'. To build only against GA releases, change the value to 'libs-release'. - New build plan(s) Spring Integration build plans have been updated to use the Artifactory Bamboo plugin and publish to repo.springsource.org. Build plans have names like 2.1.x to reflect the version under development, not necessarily the name of the branch, as this may change over time and across major releases. - Improve release process As mentioned above, Spring Integration will now use the Artifactory Bamboo plugin to publish releases and also use Artifactory's support for pushing builds directly into Maven Central via oss.sonatype.org. Generate poms that contain all necessary fields for onboarding at Maven central (scm, developers, organization, licenses, etc). Generate -source and -javadoc poms to comply with Maven Central onboarding rules (and for general good practice anyway). Generation of PGP signatures, sha1 and md5 checksums are all handled automatically by Artifactory. These are also requirements for automated entry into Maven Central. - Remove source-level pom generation Automatic generation of Maven poms suitable for use in building Spring Integration is no longer supported. Generation and publication of poms for the purpose of dependency management remains supported. Sonar support has to date depended on these poms, but will be switched over to use the Gradle Sonar plugin shortly. - Eliminate docs subproject Move docs/src to the root of the project and eliminate docs as a formal subproject. This simplifies the build in a number of ways, including removing the need for distinguishing between 'subprojects' and 'javaprojects' as well as allowing users to build both 'api' and 'reference' docs without qualifying with a ':docs' prefix. Also rename the src/info directory to src/dist to better reflect that these files are packaged with the distribution. For example, the readme.txt there is really the distribution readme, distinct from the README.md at the root of the project which is for building from source, etc.
78 lines
4.7 KiB
XML
78 lines
4.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="applicationevent"
|
||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
|
||
<title>Spring ApplicationEvent Support</title>
|
||
|
||
<para>
|
||
Spring Integration provides support for inbound and outbound <classname>ApplicationEvents</classname>
|
||
as defined by the underlying Spring Framework. For more information about Spring's support for events and listeners,
|
||
refer to the <ulink url="http://static.springsource.org/spring/docs/2.5.x/reference/beans.html#context-functionality-events">Spring Reference Manual</ulink>.
|
||
</para>
|
||
|
||
<section id="applicationevent-inbound">
|
||
<title>Receiving Spring ApplicationEvents</title>
|
||
<para>
|
||
To receive events and send them to a channel, simply define an instance of Spring Integration's
|
||
<classname>ApplicationEventListeningMessageProducer</classname>. This class is an implementation of
|
||
Spring's <interfacename>ApplicationListener</interfacename> interface. By default it will pass all
|
||
received events as Spring Integration Messages. To limit based on the type of event, configure the
|
||
list of event types that you want to receive with the 'eventTypes' property. If a received event
|
||
has a Message instance as its 'source', then that will be passed as-is. Otherwise, if a SpEL-based
|
||
"payloadExpression" has been provided, that will be evaluated against the ApplicationEvent instance.
|
||
If the event's source is not a Message instance and no "payloadExpression" has been provided, then
|
||
the ApplicationEvent itself will be passed as the payload.
|
||
</para>
|
||
<para>
|
||
For convenience namespace support is provided to configure an <classname>ApplicationEventListeningMessageProducer</classname>
|
||
via the <emphasis>inbound-channel-adapter</emphasis> element.
|
||
<programlisting language="xml"><![CDATA[<int-event:inbound-channel-adapter channel="eventChannel"
|
||
error-channel="eventErrorChannel"
|
||
event-types="example.FooEvent, example.BarEvent"/>
|
||
|
||
<int:publish-subscribe-channel id="eventChannel"/>]]></programlisting>
|
||
In the above example, all Application Context events that match one of the types specified by the 'event-types' (optional) attribute will be
|
||
delivered as Spring Integration Messages to the Message Channel named 'eventChannel'. If a downstream component throws
|
||
an exception, a MessagingException containing the failed message and exception will be sent to the channel named
|
||
'eventErrorChannel'. If no "error-channel" is specified and the downstream channels are synchronous, the Exception
|
||
will be propagated to the caller.
|
||
</para>
|
||
</section>
|
||
|
||
<section id="applicationevent-outbound">
|
||
<title>Sending Spring ApplicationEvents</title>
|
||
<para>
|
||
To send Spring <classname>ApplicationEvents</classname>, create an instance of the
|
||
<classname>ApplicationEventPublishingMessageHandler</classname> and register it within an endpoint.
|
||
This implementation of the <interfacename>MessageHandler</interfacename> interface also implements
|
||
Spring's <interfacename>ApplicationEventPublisherAware</interfacename> interface and thus acts as a
|
||
bridge between Spring Integration Messages and <classname>ApplicationEvents</classname>.
|
||
</para>
|
||
|
||
<para>
|
||
For convenience namespace support is provided to configure an <classname>ApplicationEventPublishingMessageHandler</classname>
|
||
via the <emphasis>outbound-channel-adapter</emphasis> element.
|
||
<programlisting language="xml"><![CDATA[<int:channel id="eventChannel"/>
|
||
|
||
<int-event:outbound-channel-adapter channel="eventChannel"/>]]></programlisting>
|
||
If you are using a PollableChannel (e.g., Queue), you can also provide <emphasis>poller</emphasis> as a sub-element of the
|
||
<emphasis>outbound-channel-adapter</emphasis> element. You can also optionally provide a <emphasis>task-executor</emphasis>
|
||
reference for that poller. The following example demonstrates both.
|
||
<programlisting language="xml"><![CDATA[<int:channel id="eventChannel">
|
||
<int:queue/>
|
||
</int:channel>
|
||
|
||
<int-event:outbound-channel-adapter channel="eventChannel">
|
||
<int:poller max-messages-per-poll="1" task-executor="executor" fixed-rate="100"/>
|
||
</int-event:outbound-channel-adapter>
|
||
|
||
<task:executor id="executor" pool-size="5"/>]]></programlisting>
|
||
|
||
In the above example, all messages sent to the 'eventChannel' channel will be published as ApplicationEvents to any relevant
|
||
ApplicationListener instances that are registered within the same Spring ApplicationContext. If the payload of the Message is
|
||
an ApplicationEvent, it will be passed as-is. Otherwise the Message itself will be wrapped in a MessagingEvent instance.
|
||
</para>
|
||
</section>
|
||
|
||
</chapter>
|