docs/modules/ROOT/pages/reference/extensions/websocket-jsr356.adoc

// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= Javax Websocket (JSR 356)
:page-aliases: extensions/websocket-jsr356.adoc
:cq-artifact-id: camel-quarkus-websocket-jsr356
:cq-native-supported: true
:cq-status: Stable
:cq-description: Expose websocket endpoints using JSR356.
:cq-deprecated: false
:cq-jvm-since: 1.0.0
:cq-native-since: 1.0.0

[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.0.0## [.badge-key]##Native since##[.badge-supported]##1.0.0##

Expose websocket endpoints using JSR356.

== What's inside

* https://camel.apache.org/components/latest/websocket-jsr356-component.html[Javax Websocket component], URI syntax: `websocket-jsr356:uri`

Please refer to the above link for usage and configuration details.

== Maven coordinates

[source,xml]
----
<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-websocket-jsr356</artifactId>
</dependency>
----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.

== Additional Camel Quarkus configuration

When using WebSocket consumers (E.g `from("websocket-jsr356:/some/path")`), you must first register the endpoint paths via
the `server-endpoint-paths` configuration property.

For example:

[source,properties]
----
quarkus.camel.websocket-jsr356.server-endpoint-paths=/foo,/foo/bar,/foo/bar/cheese
----

Note that paths are relative to the value of `quarkus.http.root-path`.


[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.websocket-jsr356.server-endpoint-paths]]`link:#quarkus.camel.websocket-jsr356.server-endpoint-paths[quarkus.camel.websocket-jsr356.server-endpoint-paths]`

A comma separated list of server endpoint paths that the websocket consumer will bind to.
| `string`
| 
|===

[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.