This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit 7880a636960476fc4918a8d22fee1015d8a645a0 Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Apr 6 15:36:08 2022 +0200 CAMEL-17792: Add doc about the message headers of camel-websocket-jsr356 --- .../org/apache/camel/websocket/jsr356/websocket-jsr356.json | 4 ++++ .../src/main/docs/websocket-jsr356-component.adoc | 5 +++-- .../main/java/org/apache/camel/websocket/jsr356/JSR356Constants.java | 4 ++++ .../main/java/org/apache/camel/websocket/jsr356/JSR356Endpoint.java | 2 +- 4 files changed, 12 insertions(+), 3 deletions(-) diff --git a/components/camel-websocket-jsr356/src/generated/resources/org/apache/camel/websocket/jsr356/websocket-jsr356.json b/components/camel-websocket-jsr356/src/generated/resources/org/apache/camel/websocket/jsr356/websocket-jsr356.json index 30f56ad55e9..bec63ca44e7 100644 --- a/components/camel-websocket-jsr356/src/generated/resources/org/apache/camel/websocket/jsr356/websocket-jsr356.json +++ b/components/camel-websocket-jsr356/src/generated/resources/org/apache/camel/websocket/jsr356/websocket-jsr356.json @@ -27,6 +27,10 @@ "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...] "serverEndpointDeploymentStrategy": { "kind": "property", "displayName": "Server Endpoint Deployment Strategy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.websocket.jsr356.ServerEndpointDeploymentStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "To enable customization of how a WebSocket ServerEndpoint is configured and deployed. By default DefaultServerEndpointDeploymentStrategy is used." } }, + "headers": { + "jsr356.session": { "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "javax.websocket.Session", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The session." }, + "jsr356.producer.session.incoming.use": { "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Use incoming session" } + }, "properties": { "uri": { "kind": "path", "displayName": "Uri", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.net.URI", "deprecated": false, "autowired": false, "secret": false, "description": "If a schemeless URI path is provided, a ServerEndpoint is deployed under that path. Else if the URI is prefixed with the 'ws:\/\/' scheme, then a connection is established to the corresponding server" }, "sessionCount": { "kind": "parameter", "displayName": "Session Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1, "description": "Used when the endpoint is in client mode to populate a pool of sessions" }, diff --git a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc index b8cf248d0ee..a402892c67b 100644 --- a/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc +++ b/components/camel-websocket-jsr356/src/main/docs/websocket-jsr356-component.adoc @@ -46,7 +46,8 @@ include::partial$component-endpoint-options.adoc[] // endpoint options: END - - +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END include::spring-boot:partial$starter.adoc[] diff --git a/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Constants.java b/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Constants.java index 8680a80fff2..f97bc7476f7 100644 --- a/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Constants.java +++ b/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Constants.java @@ -16,7 +16,11 @@ */ package org.apache.camel.websocket.jsr356; +import org.apache.camel.spi.Metadata; + public interface JSR356Constants { + @Metadata(description = "The session.", javaType = "javax.websocket.Session") String SESSION = "jsr356.session"; + @Metadata(label = "producer", description = "Use incoming session", javaType = "Boolean") String USE_INCOMING_SESSION = "jsr356.producer.session.incoming.use"; } diff --git a/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Endpoint.java b/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Endpoint.java index 9b2df351b2a..6e9927903b2 100644 --- a/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Endpoint.java +++ b/components/camel-websocket-jsr356/src/main/java/org/apache/camel/websocket/jsr356/JSR356Endpoint.java @@ -31,7 +31,7 @@ import org.apache.camel.support.DefaultEndpoint; * Expose websocket endpoints using JSR356. */ @UriEndpoint(firstVersion = "2.23.0", scheme = "websocket-jsr356", title = "Javax Websocket", syntax = "websocket-jsr356:uri", - category = { Category.HTTP }) + category = { Category.HTTP }, headersClass = JSR356Constants.class) public class JSR356Endpoint extends DefaultEndpoint { @UriPath(description = "If a schemeless URI path is provided, a ServerEndpoint is deployed under that path. " + "Else if the URI is prefixed with the 'ws://' scheme, then a connection is established to the corresponding server")
