Camel 2.8.0 release

New and Noteworthy

Welcome to the 2.8.0 release which approx 422 issues resolved (new features, improvements and bug fixes such as...)

• Fixed the OGNL support of Simple language to support dots in key for map access.
• Improved OGNL support of Simple to support chained [] indexes in List/Map so you can do: body[0][cool], to acces a List<Map> type.
• You can now configure the resultType when using Simple expressions.
• You can now specify type parameters in Bean to exact select method to be used when having overloaded methods (overloaded methods have same name, but vary in parameter types).
• The SFTP component now allows you to customize keep alive settings.
• Fixed issue if explict setting JmsMessage body to null would cause Camel to re-initialize the body from the underlying javax.jms.Message on access again.
• Mock endpoints is now lenient, which means its easier to replace components with Mock for testing purposes. Using uri parameters which the Mock endpoint wont no longer complain about being unknown parameters.
• Camel places a breadcrumb header in the Camel Message which allow us to keep track of messages across transports such as JMS, HTTP and many others. See more details at MDC logging.
• Improved XPath to allow GC to kick-in a bit earlier to free memory as Camel will clear references to used Exchanges used during XPath evaluations.
• Fixed an issue using FTP endpoints with the interceptSendToEndpoint
• Camel Proxy supports asynchronous invocations using Future handles.
• The endpoint cache can be configured on CamelContext.
• Cometd supports custom security policy and extensions as documented here
• Caches such as ProducerCache and EndpointRegistry can now be purged from JMX.
• Added stats for number of redeliveries and handled failures to JMX.
• Added support for JBoss 6.
• JMS consumer uses CACHE_AUTO for default cache level. This ensure that it will automatic detect if its transacted and use CACHE_NONE which must be used for transacted. And CACHE_CONSUMER for non transacted.
• Improved Splitter in parallel mode to be more responsive when aggregating on-the-fly under high load, and reducing number of threads in-use.
• Added onPrepare to Multicast, Splitter, Recipient List, and Wire Tap to execute custom logic when preparing messages. For example you can use that to deep clone message bodies, or enrich messages before they are processed.
• Added CamelSqlQuery header to SQL Component to specify (per exchange) SQL query.
• camel-cache now works in OSGi.
• Fixed an issue with HawtDB file store growing to large.
• Added repeatCount option to Timer so you can limit the number of times it fires.
• Consuming from JMS will now uses default exchange ids, instead of overring and uses ids based on JMSMessageID. This makes exchange ids consistent with all components in Camel.
• The camel-script component now works in OSGi and being able to discover and use ScriptEngineFactory from bundles.
• Restlet producer now supports the Asynchronous Routing Engine
• Throttler now uses an Expression for the maximum messages per period, which means it can be adjusted dynamic at runtime.
• Cache now supports replicating cache across nodes using listeners.
• Cache headers are now prefixed with 'CamelCache' and use mixed case, also they are removed from the exchange after a cache operation is performed
• Fixed issue with XMPP being redeployed (hot-deploy) in Apache ServiceMix may fail.
• CXF uses case-insensitive keys for CXF protocol headers, which Apache CXF itself also uses.
• Fixed issue with stopping context scoped Error Handler if a route was stopped, for example using JMX.
• Updated documentation of each EIP to include a table with the options they support.
• Improved the AWS-SQS, AWS-SNS and AWS-S3 components to be able to configure the region with which the Amazon client wants to work with.
• Improved the AWS-S3 component to be able to set the content length and content type of streamed objects.
• The testConnectionOnStartup option on JMS now also checks JMS producers as well.
• Upgraded Cometd from 1.0.1 to 2.1.0
• Message Filter EIP now fail on startup if it was mis-configured in XML DSL
• Fixed issue with Content Based Router in Scala DSL not evaluating as Predicates.
• Improved the JDBC component to not leave the database in an inconsistent state if one of multiple updates fails.
• Fixed issue with JMS consumer may report a class cast exception at WARN level during processing a message.
• Removed not needed type conversion attempts by camel-jaxb, when routing messages to Beans, for JAXB annotated payloads
• Optimized routing with Bean slightly
• Fixed an issue when restarting routes with scheduled polling consumers having consumer.xxx properties configured. The consumer.xxx properties would be lost on restart.
• Added fallback to File component, to do a copy/delete if a native file rename fails. This may happen if you rename files between different file systems such as linux -> shared windows directory.
• Minor improvements to Scala DSL
• Aggregator EIP will now by default uses eager completion check when grouped exchange has been enabled.
• Internal Camel caches now uses a SoftReference which allows the JVM to be able to garbage collection from the cache in case its running out of memory. This should help Camel end users when running in low memory systems.
• Added 2 new Camel Maven Archetypes for OSGi using spring-dm or blueprint
• The Log component will now by default not show stream message bodies. Use the new showStreams option to enable that explicit.
• Improved startup time of Camel by hard loading type converters from camel-core JAR
• Made unit testing the Camel Source go faster
• The Camel test kit will now by default lazy load type converters which makes unit testing faster for most tests.
• Added new features to AdviceWith to support weaveByType, selectors, and a shorthand to easily add nodes to start/end of routes.
• Camel Test support setting up CamelContext once per test class, instead of every test method. This can speedup testing when having multiple test methods in the same unit test class.
• Fixed an issue with FTP producer not trying to re-connect if pre write check fails. By re-connecting the producer can recover and process the message without failing.
• Camel JMX can now show the routes as XML on the CamelContext/Route mbeans. Likewise route(s) can be updated/added from XML as well.
• Camel JMX added operations to ManagedCamelContext to send messages which has headers as well.
• Camel JMX added operations to BrowsableEndpoint mbeans to show message in generic XML format.
• The JDBC and JPA based idempotent repositories now contains a createdAt property/column.
• Improved the AWS-SQS component to change all queue attributes (VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod and Policy) at a later time if needed.
• Aligned the authentication and proxy parameter names so HTTP4 uses same names as HTTP component.
• Removed some very seldom used expression builders in Java DSL that caused a minor problem with being able to render the routes as XML. By removing those we ensure the routes creating using Java DSL can accurately render itself as XML DSL routes.
• Added Hazelcast as supported store for the Idempotent Consumer EIP
• Tracer uses same logic as Log component for extracting message body. By default they will not log/trace message bodies from stream/files. But instead indicate its a stream/file message body. You can control this behavior by setting a property on the CamelContext.
• Added monitor type consumer to JMX consumer. This new style of consumer automatically creates and deploys a monitor bean (counter, gauge, or string) to monitor the specified attribute of an existing bean. This is useful for cases where a route wants to monitor a bean without relying on an pre-existing deployment and configuration of a monitor.
• Added Ref Language to make it easy to refer and use custom Expression in XML DSLs.
• You can provide additional arguments to Scripting Languages as a header on the Camel Message.
• Added support for setting custom properties in the endpoint uri for CXF by using properties. as prefix, eg properties.mtom-enabled=true to enable MTOM. This is usable if you configure and use CXF from Java DSL. The XML DSL has a specialized CXF schema to configure this using XML tags.
• Added option disableTimeToLive on JMS to force disabling time to live value. Added more details in JMS documentation about the need for synchronizing clocks for JMS systems when doing request/reply, and why the option disableTimeToLive may come handy.
• Spring Web Services producer now propagates headers correctly.
• Components loading resources such as Velocity, XSLT, XQuery, FreeMarker etc. now leverages Camels Pluggable Class Resolvers which ensures they now work in OSGi Blueprint.
• DefaultPackageScanClassResolver uses a JAR cache to speedup scanning JARs. This ensures Camel bootup faster, in case it re-scan JARs from the cache.
• Exposed Restlet API in Restlet to allow end users to be in full control. For example using the org.restlet.Response instance to populate the response from a Restlet route.
• Splited camel transport for cxf out of camel-cxf module. If you want to use camel transport for cxf or the cxfbean component, you need to add the dependency of camel-cxf-transport.
• Aggregate EIP will restore timeout values from existing exchanges from aggregation repository upon start. This ensures that restarting Camel, will allow the aggregator trigger timeouts for those existing exchanges.
• Bean component: Parameter Binding Annotations are now also inherited from superclasses and interfaces.
• Fixed routes using a Content Based Router not having its child nodes enlisted in JMX for management.
• Fixed parent/child relationship in Content Based Router to be more fine grained.
• Fixed issue related to non optional camel-core dependency on javax.script in OSGi.
• Added option shareUnitOfWork to Splitter, Multicast, and Recipient List to make the entire operation appear as one unit of work, that either succeed or failure. This underpins some use cases, especially with the Splitter and using a Dead Letter Channel to only store one failed Exchange (one unit of work).
• Exceptions thrown while handling other exceptions in OnException will now caught by a fallback error handler logging to 2nd exception and propagating the 2nd exception on the Exchange and causing that Exchange to break out processing and fail immediately. This avoids complications, what to do if a exceptions occur while handling a previous exception. For example you could end up going in circles. Now its predictable (Log the 2nd and fail).
• OnException will fail on startup if it has been misconfigured (eg its empty, such as onException(Exception.class);). You must either add redelivery settings, handled, continued, retryWhile, outputs, etc. to configure it
• Fixed issue when sending Mail as Camel could mistakenly drop characters from Content-Type header. Improved how charset is parsed and configured in the Content-Type header.
• The ScheduledPollingConsumer now rigorously catches all erros in the scheduled thread to avoid the thread from terminating by the JDK scheduled thread pool, causing the scheduled polling to stop. Added option runLoggingLevel to configure logging level for logging start/complete logs when the polling task runs.
• Fixed issue with Bean endpoint propagating CamelBeanMethodName header. This header was only intended for the first Bean endpoint, and not any subsequent Bean endpoints.
• Spring Web Services consumer now propagates exceptions back to Spring-WS. This allows for exception handling by Spring-WS EndpointExceptionResolver's
• Optimized Camel's routing engine by moving the need for defensive copy of Exchange during routing, to the Error Handlers instead (which is capable of performing redelivery). Optimized to only perform defensive copy if redelivery has been enabled.
• Fixed issue with Error Handler doing redelivery, the passed in Exchange could have left over state from the previous attempt.
• SEDA now supports suspend/resume Lifecycle, which for example is a more gentle way for temporary pausing SEDA routes.
• Fixed issue with ThrottlingInflightRoutePolicy in context scope may not trigger to resume routes, when Exchanges started from other independent routes, were completed.
• Added ManagementObjectStrategy as SPI to make it easier to reuse all the various MBeans created by Camel, or to plugin a custom strategy if needed.
• Improved SMPP to be able to return error codes to the SMSC in case of failures by processing the incoming message. This is useful e.g. to instruct the SMSC to redeliver the short message.
• Camel Mail component now supports marking mails as SEEN/DELETED after processing when using the pop3 protocol.
• Fixed issue using Content Enricher or Polling Consumer with Batch Consumer could cause the consumer to keep polling after usage. For example a FTP consumer would keep polling the FTP server.
• Content Enricher using pollEnrich will now set an empty message body if the Content Enricher could not poll from the resource. Previously the old message body would be preserved.
• Add fragment property on the Camel JAXB dataformat.
• In addition of Apache Karaf features descriptor, Camel now provides a Karaf shell commands to manipulate CamelContext, routes, etc.
• Mock endpoint now accepts multiple expected headers/properties using the expectedHeaderReceived / expectedPropertyReceived methods.
• Added the changed read lock option to the FTP component.
• Added minDepth and maxDepth options to File component.
• Fixed issue using SMPP with messages longer than 254 characters.
• Upgraded AMQP to use Apache QPid 0.10
• Fixed issue if having multiple routes on the exact same JMS topic endpoint, and if removing one of the routes, causing the other active routes to not receive any more messages from the JMS topic.
• Fixed issue when endpoint uris had multiple values for same parameter key, would only keep last parameter. For example if using HTTP, HTTP4 to send a HTTP request to a remote HTTP server and having parameters in the URI with multiple values for the same key, eg such as "http://someserver.com?from=me&to=foo&to=bar"
• Improved Ref component to throw better failure exceptions if the endpoint could not be found in the Registry
• Introduced mapMailMessage option (default true) to Camel Mail that determines if Camel should map the raw mail message to headers/bodies etc.
• AHC, HTTP, HTTP4, Jetty, SERVLET now supports multi valued HTTP headers.
• Lookup bean with expected type in Registry now reports better exception message with actual and expected type in case of a caused ClassCastException
• Type Converter discovery has been improved to be faster and better support different runtimes. Camel now prefers to load @Converter classes using the FQN class name instead of package scanning. Package scanning is a costly procedure and doesnt work out of the box in all runtimes, and using Pluggable Class Resolvers is needed to make that work.

New Enterprise Integration Patterns

New Components

• AHC - An asynchronous http client
• APNS - To send notifications to Apple iOS devices
• AWS-SNS - Simple Notification Service for Amazon AWS Cloud
• AWS-S3 - Simple Storage Service for Amazon AWS Cloud
• HDFS - Hadoop File System
• TestNG - Unit testing with TestNG

DSL Changes

• Wire Tap has now fluent builders in Java DSL to make it easier to configure.
• Wire Tap can now set headers directly in the DSL when using the send new message mode.
• Added skipDuplicate option to Idempotent Consumer EIP to allow end users to handle duplicate messages more easily in Camel routes.
• Throttler now uses an Expression to set the maximum requests per period, allow that to be dynamic evaluated at runtime. This means you need to migrate if you use XML DSL.
• Added copy option to Loop EIP so you can run in copy mode, which mean each iteration is reset and use a copy of the same input exchange.
• endDoTry added to Java DSL
• Added option shareUnitOfWork to Splitter, Multicast, and Recipient List to make the entire operation appear as one unit of work, that either succeed or failure. This underpins some use cases, especially with the Splitter and using a Dead Letter Channel to only store one failed Exchange (one unit of work).
• <bean>, <marshal>, and <unmarshal> tags in XML DSL no longer accepts children (outputs).

New Annotations

New Data Formats

New Languages

• Ref Language

New Examples

• CXF Example OSGi using Spring-DM
• CXF Example OSGi Blueprint using Blueprint

New Tutorials

API breaking

• Added purge method to ServicePool
• If you use Wire Tap from within a Content Based Router in Java DSL, then you need to use end() to indicate the end of the Wire Tap. See this test
• WireTapDefinition no longer extends from SendDefinition
• Removed maximumRequestsPerPeriod attribute on <throttle> in XML DSL. You should use an Expression instead, such as <constant>10</constant>
• Cache headers are now prefixed with 'CamelCache' (see CacheConstants) and are removed from the exchange after the cache operation is performed
• Scala DSL uses 'Camel case names' for its DSL to be consistent and aligned with the Java DSL
• The sendBody and requestBody methods on ManagedCamelContext have changed signature to use a java.lang.Object type in the 2nd parameter. Instead we have introduced sendStringBody and requestStringBody that has a java.lang.String type in the 2nd parameter. For example you can use those from JConsole.
• The JDBC and JPA based idempotent repositories now contains a createdAt property/column.
• The authentication and proxy parameter names have been renamed in the HTTP4 component. See the HTTP4 page for details.
• Removed seldom used methods on EIPs that uses an ExpressionClause to build up an expression. There are other existing methods that accept an Expression as parameter to be used instead:
  • completionPredicate() on AggregationDefinition
  • onWhen() on CatchDefinition
  • expression() on IdempotentConsumerDefinition
  • onWhen() on OnCompletionDefinition
  • onWhen() on OnExceptionDefinition
  • idempotentConsumer() on ProcessorDefinition
  • expression() on SplitDefinition
  • onWhen() on TryDefinition
  • expression() on WhenDefinition
• Removed the deprecated handled methods on Error Handler. If you used handled(false) on the Error Handler you would have to migrate to using Exception Clause instead that support handled.
• GZIPHelper moved from HTTP/HTTP4/ghttp components to camel-core
• Removed org.apache.camel.spi.ScriptEngineResolver
• org.apache.camel.component.cxf.CxfHeaderFilterStrategy moved from camel-cxf to camel-cxf-transport as org.apache.camel.component.cxf.common.header.CxfHeaderFilterStrategy
• Added removeEventNotifier method to ManagementStrategy
• Added getter/setter for ManagementObjectStrategy on ManagementStrategy
• Moved the exception ProxyInstantiationException from the package org.apache.camel.impl to org.apache.camel
• Added parameter depth to the method pollDirectory in the class GenericFileConsumer

Known Issues

• The Tracer may not output all details for some situations such as when using onCompletion or intercept etc.
• Using Debugger and Tracer at the same time is not working.
• Not all Examples have ANT build.xml files to run the example using ANT.
• The project cannot fully build the site using Maven (eg running "mvn site". There is no plan to make this work as the project do not use the maven site.
• The following two unit tests may fail on Windows from the camel-ftp component: FtpChangedReadLockTest and FtpChangedReadLockTimeoutTest.

Important changes to consider when upgrading

• Upgraded to slf4j 1.6.1
• Upgraded to Apache CXF 2.4.0 (CXF 2.3.x or older is no longer supported)
• The testConnectionOnStartup option on JMS now also checks JMS producers as well.
• Fixed InterceptStrategy to pass in actual OutputDefinition. For example in a route with a Splitter, it would now pass in the children of the splitter, in the wrapProcessorInInterceptors method.
• The Log component will now by default not show stream message bodies. Use the new showStreams option to enable that explicit. Likewise the Log component will not automatic convert the payload to StreamCache. For that you need to explicit enable Stream caching on the route or CamelContext.
• Removed the artifacts camel-spring-tests.jar and camel-blueprint-tests.jars from being released to Maven Central Repository.
• Upgraded to use Commons Net 2.2 (was 2.0) in FTP component.
• Splited Camel transport for CXF out of camel-cxf module. If you want to use camel transport for CXF or the cxfbean component, you need to add the dependency of camel-cxf-transport.
• Upgraded Spring Web Services to release 2.0.2 from 1.x.
• Exceptions thrown while handling other exceptions in OnException will now caught by a fallback error handler logging to 2nd exception and propagating the 2nd exception on the Exchange and causing that Exchange to break out processing and fail immediately. This avoids complications, what to do if a exceptions occur while handling a previous exception. For example you could end up going in circles. Now its predictable (Log the 2nd and fail).
• The default option useFixedDelay has been changed from false to true in the File and FTP consumers.
• The CamelBeanMethodName header on a Camel message will not be propagated routing through Bean components. The Bean component will remove the header after usage.
• Content Enricher using pollEnrich will now set an empty message body if the Content Enricher could not poll from the resource. Previously the old message body would be preserved.
• Added field routeId to trace event message in camel-core and JPA.
• Upgraded to Scala 2.9.0 in camel-scala and camel-web
• End users with custom components that has Type Converters should consider migrating to use the FQN in the META-INF/services/org/apache/camel/TypeConverter file. See more details at Type Converter.
• If you use Wire Tap in Java DSL, then you need to add .end() to mark where it ends, as shown in this unit test
• The default cacheLevel on JMS is now CACHE_AUTO, which reacts differently depending whether transacted=true or not. See more details at JMS page.

Notice

• The ANT support for the Examples is to be considered deprecated. Support for ANT will be removed in the next release. We may keep ANT supported for a single example, though.

Getting the Distributions

Binary Distributions

Source Distributions

Getting the Binaries using Maven 2

To use this release in your maven project, the proper dependency configuration that you should use in your Maven POM is:

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-core</artifactId>
  <version>2.8.0</version>
</dependency>

SVN Tag Checkout

svn co http://svn.apache.org/repos/asf/camel/tags/camel-2.8.0

Changelog

For a more detailed view of new features and bug fixes, see the:

• release notes for 2.8.0