Chapter 98. OSGi EventAdmin Component
Available as of Camel version 2.6
The eventadmin
component can be used in an OSGi environment to receive OSGi EventAdmin events and process them.
98.1. Dependencies
Maven users need to add the following dependency to their pom.xml
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-eventadmin</artifactId> <version>${camel-version}</version> </dependency>
where ${camel-version
} must be replaced by the actual version of Camel (2.6.0 or higher).
98.2. URI format
eventadmin:topic[?options]
where topic
is the name of the topic to listen too.
98.3. URI options
The OSGi EventAdmin component supports 2 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
bundleContext (common) | The OSGi BundleContext is automatic injected by Camel | BundleContext | |
resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The OSGi EventAdmin endpoint is configured using URI syntax:
eventadmin:topic
with the following path and query parameters:
98.3.1. Path Parameters (1 parameters):
Name | Description | Default | Type |
---|---|---|---|
topic | Name of topic to listen or send to | String |
98.3.2. Query Parameters (5 parameters):
Name | Description | Default | Type |
---|---|---|---|
send (common) | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) | false | boolean |
bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
exceptionHandler (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | |
exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
98.4. Message headers
Name | Type | Message |
---|---|---|
Description |
98.5. Message body
The in
message body will be set to the received Event.
98.6. Example usage
<route> <from uri="eventadmin:*"/> <to uri="stream:out"/> </route>