Package org.apache.camel.builder.endpoint.dsl

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

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(String sslContextParameters)	To configure security using SSLContextParameters.
default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	To configure security using SSLContextParameters.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

sessionSupport, sessionSupport, staticResources, subprotocol

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

sendTimeout, sendTimeout, sendToAll, sendToAll

Method Detail

advanced

default WebsocketEndpointBuilderFactory.AdvancedWebsocketEndpointBuilder advanced()

Specified by:

advanced in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

advanced in interface WebsocketEndpointBuilderFactory.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: <code>java.lang.Integer</code> type. Default: -1 Group: common

Specified by:

maxBinaryMessageSize in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

maxBinaryMessageSize in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

maxBinaryMessageSize - the value to set

Returns:

the dsl builder

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 a <code>java.lang.Integer</code> type. Default: -1 Group: common

Specified by:

maxBinaryMessageSize in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

maxBinaryMessageSize in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

maxBinaryMessageSize - the value to set

Returns:

the dsl builder

allowedOrigins

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder allowedOrigins(String allowedOrigins)

The CORS allowed origins. Use to allow all. The option is a: <code>java.lang.String</code> type. Group: cors

Specified by:

allowedOrigins in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

allowedOrigins in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

allowedOrigins - the value to set

Returns:

the dsl builder

crossOriginFilterOn

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder crossOriginFilterOn(boolean crossOriginFilterOn)

Whether to enable CORS. The option is a: <code>boolean</code> type. Default: false Group: cors

Specified by:

crossOriginFilterOn in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

crossOriginFilterOn in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

crossOriginFilterOn - the value to set

Returns:

the dsl builder

crossOriginFilterOn

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder crossOriginFilterOn(String crossOriginFilterOn)

Whether to enable CORS. The option will be converted to a <code>boolean</code> type. Default: false Group: cors

Specified by:

crossOriginFilterOn in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

crossOriginFilterOn in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

crossOriginFilterOn - the value to set

Returns:

the dsl builder

filterPath

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder filterPath(String filterPath)

Context path for filtering CORS. The option is a: <code>java.lang.String</code> type. Group: cors

Specified by:

filterPath in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

filterPath in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

filterPath - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: monitoring

Specified by:

enableJmx in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

enableJmx in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

enableJmx - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: false Group: monitoring

Specified by:

enableJmx in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

enableJmx in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

enableJmx - the value to set

Returns:

the dsl builder

sslContextParameters

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder 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

Specified by:

sslContextParameters in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

sslContextParameters in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default WebsocketEndpointBuilderFactory.WebsocketEndpointBuilder 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

Specified by:

sslContextParameters in interface WebsocketEndpointBuilderFactory.WebsocketEndpointConsumerBuilder

Specified by:

sslContextParameters in interface WebsocketEndpointBuilderFactory.WebsocketEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder