Jetty Websocket

Jetty Websocket

Scheme: websocket
Name Kind Type Required Deprecated Default Value Enum Values Description
host path java.lang.String false 0.0.0.0 The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.
port path java.lang.Integer false 9292 The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.
resourceUri path java.lang.String true false Name of the websocket channel to use
sendToAll parameter java.lang.Boolean false To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message.
enableJmx parameter boolean false If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
sessionSupport parameter boolean false Whether to enable session support which enables HttpSession for each http request.
crossOriginFilterOn parameter boolean false Whether to enable CORS
sslContextParameters parameter org.apache.camel.util.jsse.SSLContextParameters false To configure security using SSLContextParameters
allowedOrigins parameter java.lang.String false The CORS allowed origins. Use * to allow all.
filterPath parameter java.lang.String false Context path for filtering CORS
staticResources parameter java.lang.String false Set a resource path for static resources (such as .html files etc).

The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files.

For example to load from root classpath use classpath:., or classpath:WEB-INF/static

If not configured (eg null) then no static resource is in use.

bufferSize parameter java.lang.Integer false 8192 Set the buffer size of the websocketServlet, which is also the max frame byte size (default 8192)
maxIdleTime parameter java.lang.Integer false 300000 Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)
maxTextMessageSize parameter java.lang.Integer false Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
maxBinaryMessageSize parameter java.lang.Integer false -1 Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)
minVersion parameter java.lang.Integer false 13 Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

websocket consumer