Interface WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
,WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
- Enclosing interface:
- WebsocketEndpointBuilderFactory
public static interface WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder extends WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder, WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
Builder for endpoint for the Jetty Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder
advanced()
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
allowedOrigins(String allowedOrigins)
The CORS allowed origins.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
enableJmx(String enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
filterPath(String filterPath)
Context path for filtering CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
maxBinaryMessageSize(Integer maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
maxBinaryMessageSize(String maxBinaryMessageSize)
Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters.default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters.-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, sessionSupport, sessionSupport, staticResources
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
lazyStartProducer, lazyStartProducer, sendTimeout, sendTimeout, sendToAll, sendToAll
-
-
-
-
Method Detail
-
advanced
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder advanced()
- Specified by:
advanced
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
advanced
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder maxBinaryMessageSize(Integer maxBinaryMessageSize)
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). The option is a:java.lang.Integer
type. Default: -1 Group: common- Specified by:
maxBinaryMessageSize
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
maxBinaryMessageSize
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder maxBinaryMessageSize(String maxBinaryMessageSize)
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). The option will be converted to ajava.lang.Integer
type. Default: -1 Group: common- Specified by:
maxBinaryMessageSize
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
maxBinaryMessageSize
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
allowedOrigins
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder allowedOrigins(String allowedOrigins)
The CORS allowed origins. Use to allow all. The option is a:java.lang.String
type. Group: cors- Specified by:
allowedOrigins
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
allowedOrigins
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS. The option is a:boolean
type. Default: false Group: cors- Specified by:
crossOriginFilterOn
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
crossOriginFilterOn
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS. The option will be converted to aboolean
type. Default: false Group: cors- Specified by:
crossOriginFilterOn
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
crossOriginFilterOn
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
filterPath
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder filterPath(String filterPath)
Context path for filtering CORS. The option is a:java.lang.String
type. Group: cors- Specified by:
filterPath
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
filterPath
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option is a:boolean
type. Default: false Group: monitoring- Specified by:
enableJmx
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
enableJmx
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder enableJmx(String enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. The option will be converted to aboolean
type. Default: false Group: monitoring- Specified by:
enableJmx
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
enableJmx
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder sslContextParameters(Object sslContextParameters)
To configure security using SSLContextParameters. The option is a:org.apache.camel.support.jsse.SSLContextParameters
type. Group: security- Specified by:
sslContextParameters
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters. The option will be converted to aorg.apache.camel.support.jsse.SSLContextParameters
type. Group: security- Specified by:
sslContextParameters
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
- Specified by:
sslContextParameters
in interfaceWebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder
-
-