Interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder
- Enclosing interface:
- WebsocketEndpointBuilderFactory
public static interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Jetty Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder
advanced()
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
allowedOrigins(String allowedOrigins)
The CORS allowed origins.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
enableJmx(String enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
filterPath(String filterPath)
Context path for filtering CORS.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
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.WebsocketEndpointConsumerBuilder
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.WebsocketEndpointConsumerBuilder
sessionSupport(boolean sessionSupport)
Whether to enable session support which enables HttpSession for each http request.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sessionSupport(String sessionSupport)
Whether to enable session support which enables HttpSession for each http request.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
To configure security using SSLContextParameters.default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
staticResources(String staticResources)
Set a resource path for static resources (such as .html files etc).default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder
subprotocol(String subprotocol)
This is a comma-separated list of subprotocols that are supported by the application.
-
-
-
Method Detail
-
advanced
default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointConsumerBuilder advanced()
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder 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: <code>java.lang.Integer</code> type. Default: -1 Group: common- Parameters:
maxBinaryMessageSize
- the value to set- Returns:
- the dsl builder
-
maxBinaryMessageSize
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder 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 a <code>java.lang.Integer</code> type. Default: -1 Group: common- Parameters:
maxBinaryMessageSize
- the value to set- Returns:
- the dsl builder
-
sessionSupport
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sessionSupport(boolean sessionSupport)
Whether to enable session support which enables HttpSession for each http request. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sessionSupport
- the value to set- Returns:
- the dsl builder
-
sessionSupport
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sessionSupport(String sessionSupport)
Whether to enable session support which enables HttpSession for each http request. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sessionSupport
- the value to set- Returns:
- the dsl builder
-
staticResources
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder staticResources(String staticResources)
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. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
staticResources
- the value to set- Returns:
- the dsl builder
-
subprotocol
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder subprotocol(String subprotocol)
This is a comma-separated list of subprotocols that are supported by the application. The list is in priority order. The first subprotocol on this list that is proposed by the client is the one that will be accepted. If no subprotocol on this list is proposed by the client, then the websocket connection is refused. The special value 'any' means that any subprotocol is acceptable. 'any' can be used on its own, or as a failsafe at the end of a list of more specific protocols. 'any' will also match the case where no subprotocol is proposed by the client. The option is a: <code>java.lang.String</code> type. Default: any Group: consumer- Parameters:
subprotocol
- the value to set- Returns:
- the dsl builder
-
allowedOrigins
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder allowedOrigins(String allowedOrigins)
The CORS allowed origins. Use to allow all. The option is a: <code>java.lang.String</code> type. Group: cors- Parameters:
allowedOrigins
- the value to set- Returns:
- the dsl builder
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder crossOriginFilterOn(boolean crossOriginFilterOn)
Whether to enable CORS. The option is a: <code>boolean</code> type. Default: false Group: cors- Parameters:
crossOriginFilterOn
- the value to set- Returns:
- the dsl builder
-
crossOriginFilterOn
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder crossOriginFilterOn(String crossOriginFilterOn)
Whether to enable CORS. The option will be converted to a <code>boolean</code> type. Default: false Group: cors- Parameters:
crossOriginFilterOn
- the value to set- Returns:
- the dsl builder
-
filterPath
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder filterPath(String filterPath)
Context path for filtering CORS. The option is a: <code>java.lang.String</code> type. Group: cors- Parameters:
filterPath
- the value to set- Returns:
- the dsl builder
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: monitoring- Parameters:
enableJmx
- the value to set- Returns:
- the dsl builder
-
enableJmx
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder 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 a <code>boolean</code> type. Default: false Group: monitoring- Parameters:
enableJmx
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
-