| {"component":{"kind":"component","name":"vertx-websocket","title":"Vert.x WebSocket","description":"Expose WebSocket endpoints and connect to remote WebSocket servers using Vert.x","deprecated":false,"firstVersion":"3.5.0","label":"websocket","javaType":"org.apache.camel.component.vertx.websocket.VertxWebsocketComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-vertx-websocket","version":"3.18.1","scheme":"vertx-websocket","extendsScheme":"","syntax":"vertx-websocket:host:port/path","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelVertxWebsocket.connectionKey":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to the client with the given connection key. You can use a comma separated list of keys to send a message to multiple clients","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#CONNECTION_KEY"},"CamelVertxWebsocket.sendToAll":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#SEND_TO_ALL"},"CamelVertxWebsocket.remoteAddress":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"io.vertx.core.net.SocketAddress","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote address.","constantName":"org.apache.camel.component.vertx.websocket.VertxWebsocketConstants#REMOTE_ADDRESS"}},"properties":{"host":{"kind":"path","displayName":"Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"0.0.0.0","configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"The host that the consumer should bind to or the host of the remote websocket destination that the producer should connect to"},"port":{"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"The port that the consumer should bind to or port of the remote websocket destination that the producer should connect to"},"path":{"kind":"path","displayName":"Path","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"/","configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"The path that the consumer should bind to or path of the remote websocket destination that the producer should connect to"},"allowedOriginPattern":{"kind":"parameter","displayName":"Allowed Origin Pattern","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Regex pattern to match the origin header sent by WebSocket clients"},"router":{"kind":"parameter","displayName":"Router","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.ext.web.Router","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To use an existing vertx router for the HTTP server"},"serverOptions":{"kind":"parameter","displayName":"Server Options","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpServerOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"clientOptions":{"kind":"parameter","displayName":"Client Options","group":"producer","label":"producer","required":false,"type":"object","javaType":"io.vertx.core.http.HttpClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Sets customized options for configuring the WebSocket client used in the producer"},"clientSubProtocols":{"kind":"parameter","displayName":"Client Sub Protocols","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header"},"sendToAll":{"kind":"parameter","displayName":"Send To All","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the VertxWebsocketConstants.SEND_TO_ALL header on the message."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"sslContextParameters":{"kind":"parameter","displayName":"Ssl Context Parameters","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.support.jsse.SSLContextParameters","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.vertx.websocket.VertxWebsocketConfiguration","configurationField":"configuration","description":"To configure security using SSLContextParameters"}}} |