blob: 7bd1308780259ddb226847cf017d3b9c8a27ba39 [file] [log] [blame]
// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
[id="extensions-sjms2"]
= Simple JMS2
:page-aliases: extensions/sjms2.adoc
:linkattrs:
:cq-artifact-id: camel-quarkus-sjms2
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Send and receive messages to/from a JMS Queue or Topic using plain JMS 2.x API.
:cq-deprecated: false
:cq-jvm-since: 1.0.0
:cq-native-since: 1.0.0
ifeval::[{doc-show-badges} == true]
[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.0.0## [.badge-key]##Native since##[.badge-supported]##1.0.0##
endif::[]
Send and receive messages to/from a JMS Queue or Topic using plain JMS 2.x API.
[id="extensions-sjms2-whats-inside"]
== What's inside
* xref:{cq-camel-components}::sjms2-component.adoc[Simple JMS2 component], URI syntax: `sjms2:destinationType:destinationName`
Please refer to the above link for usage and configuration details.
[id="extensions-sjms2-maven-coordinates"]
== Maven coordinates
https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-sjms2[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"]
Or add the coordinates to your existing project:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-sjms2</artifactId>
</dependency>
----
ifeval::[{doc-show-user-guide-link} == true]
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
endif::[]
[id="extensions-sjms2-usage"]
== Usage
[id="extensions-sjms2-usage-message-mapping-with-org-w3c-dom-node"]
=== Message mapping with `org.w3c.dom.Node`
The Camel SJMS2 component supports message mapping between `jakarta.jms.Message` and `org.apache.camel.Message`. When wanting to convert a Camel message body type of `org.w3c.dom.Node`,
you must ensure that the `camel-quarkus-xml-jaxp` extension is present on the classpath.
[id="extensions-sjms2-usage-native-mode-support-for-jakarta-jms-objectmessage"]
=== Native mode support for jakarta.jms.ObjectMessage
When sending JMS message payloads as `jakarta.jms.ObjectMessage`, you must annotate the relevant classes to be registered for serialization with `@RegisterForReflection(serialization = true)`.
Note that this extension automatically sets `quarkus.camel.native.reflection.serialization-enabled = true` for you. Refer to the xref:user-guide/native-mode.adoc#serialization[native mode user guide] for more information.
[id="extensions-sjms2-transferexception-option-in-native-mode"]
== transferException option in native mode
To use the `transferException` option in native mode, you must enable support for object serialization. Refer to the xref:user-guide/native-mode.adoc#serialization[native mode user guide]
for more information.
You will also need to enable serialization for the exception classes that you intend to serialize. For example.
[source,java]
----
@RegisterForReflection(targets = { IllegalStateException.class, MyCustomException.class }, serialization = true)
----