blob: af5312917f338c45c53c8a54e2290983145a4c47 [file] [log] [blame]
// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
[id="extensions-hazelcast"]
= Hazelcast Atomic Number
:linkattrs:
:cq-artifact-id: camel-quarkus-hazelcast
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Increment, decrement, set, etc. Hazelcast atomic number (a grid wide number).
:cq-deprecated: false
:cq-jvm-since: 1.1.0
:cq-native-since: 1.6.0
ifeval::[{doc-show-badges} == true]
[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.1.0## [.badge-key]##Native since##[.badge-supported]##1.6.0##
endif::[]
Increment, decrement, set, etc. Hazelcast atomic number (a grid wide number).
[id="extensions-hazelcast-whats-inside"]
== What's inside
* xref:{cq-camel-components}::hazelcast-atomicvalue-component.adoc[Hazelcast Atomic Number component], URI syntax: `hazelcast-atomicvalue:cacheName`
* xref:{cq-camel-components}::hazelcast-instance-component.adoc[Hazelcast Instance component], URI syntax: `hazelcast-instance:cacheName`
* xref:{cq-camel-components}::hazelcast-list-component.adoc[Hazelcast List component], URI syntax: `hazelcast-list:cacheName`
* xref:{cq-camel-components}::hazelcast-map-component.adoc[Hazelcast Map component], URI syntax: `hazelcast-map:cacheName`
* xref:{cq-camel-components}::hazelcast-multimap-component.adoc[Hazelcast Multimap component], URI syntax: `hazelcast-multimap:cacheName`
* xref:{cq-camel-components}::hazelcast-queue-component.adoc[Hazelcast Queue component], URI syntax: `hazelcast-queue:cacheName`
* xref:{cq-camel-components}::hazelcast-replicatedmap-component.adoc[Hazelcast Replicated Map component], URI syntax: `hazelcast-replicatedmap:cacheName`
* xref:{cq-camel-components}::hazelcast-ringbuffer-component.adoc[Hazelcast Ringbuffer component], URI syntax: `hazelcast-ringbuffer:cacheName`
* xref:{cq-camel-components}::hazelcast-seda-component.adoc[Hazelcast SEDA component], URI syntax: `hazelcast-seda:cacheName`
* xref:{cq-camel-components}::hazelcast-set-component.adoc[Hazelcast Set component], URI syntax: `hazelcast-set:cacheName`
* xref:{cq-camel-components}::hazelcast-topic-component.adoc[Hazelcast Topic component], URI syntax: `hazelcast-topic:cacheName`
Please refer to the above links for usage and configuration details.
[id="extensions-hazelcast-maven-coordinates"]
== Maven coordinates
https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-hazelcast[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-hazelcast</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-hazelcast-ssl-in-native-mode"]
== SSL in native mode
This extension auto-enables SSL support in native mode. Hence you do not need to add
`quarkus.ssl.native=true` to your `application.properties` yourself. See also
https://quarkus.io/guides/native-and-ssl[Quarkus SSL guide].
[id="extensions-hazelcast-additional-camel-quarkus-configuration"]
== Additional Camel Quarkus configuration
This extension leverages https://github.com/hazelcast/quarkus-hazelcast-client[Hazelcast Client for Quarkus]. The configuration of the HazelcastInstance is managed by the extension. To configure Hazelcast Instance, check the https://github.com/hazelcast/quarkus-hazelcast-client[Hazelcast Client for Quarkus] guide.
*Please note that the camel-quarkus-hazelcast component works only with the client mode.*
To use the Hazelcast instance in the camel-quarkus-hazelcast component, you should configure the component with :
* The HazelcastInstance initialized by the Hazelcast Client for Quarkus
* The component mode as : "client"
Example of configuration for HazelcastMap component:
[source,java]
----
@Inject
HazelcastInstance hazelcastInstance;
@Produces
@ApplicationScoped
@Unremovable
@Named("hazelcast-map")
HazelcastDefaultComponent hazelcastMap() {
final HazelcastMapComponent hazelcastComponent = new HazelcastMapComponent();
hazelcastComponent.setHazelcastInstance(hazelcastInstance);
hazelcastComponent.setHazelcastMode(HazelcastConstants.HAZELCAST_CLIENT_MODE);
return getHazelcastComponent(hazelcastComponent);
}
----
You may want to check the https://github.com/apache/camel-quarkus/tree/main/integration-tests/hazelcast[integration test]
in our source tree as an example.