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

Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder

Enclosing interface:

VertxWebsocketEndpointBuilderFactory

public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Vert.x WebSocket component.

Method Summary

Modifier and Type	Method	Description
default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointProducerBuilder	advanced()
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	clientOptions(io.vertx.core.http.HttpClientOptions clientOptions)	Sets customized options for configuring the WebSocket client used in the producer.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	clientOptions(String clientOptions)	Sets customized options for configuring the WebSocket client used in the producer.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	clientSubProtocols(String clientSubProtocols)	Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	sendToAll(boolean sendToAll)	To send to all websocket subscribers.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	sendToAll(String sendToAll)	To send to all websocket subscribers.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	sslContextParameters(String sslContextParameters)	To configure security using SSLContextParameters.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	To configure security using SSLContextParameters.

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

Method Details

advanced

default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointProducerBuilder advanced()

clientOptions

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientOptions(io.vertx.core.http.HttpClientOptions clientOptions)

Sets customized options for configuring the WebSocket client used in the producer. The option is a: <code>io.vertx.core.http.HttpClientOptions</code> type. Group: producer

Parameters:

clientOptions - the value to set

Returns:

the dsl builder

clientOptions

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientOptions(String clientOptions)

Sets customized options for configuring the WebSocket client used in the producer. The option will be converted to a <code>io.vertx.core.http.HttpClientOptions</code> type. Group: producer

Parameters:

clientOptions - the value to set

Returns:

the dsl builder

clientSubProtocols

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder clientSubProtocols(String clientSubProtocols)

Comma separated list of WebSocket subprotocols that the client should use for the Sec-WebSocket-Protocol header. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

clientSubProtocols - the value to set

Returns:

the dsl builder

sendToAll

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sendToAll(boolean sendToAll)

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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

sendToAll - the value to set

Returns:

the dsl builder

sendToAll

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder sendToAll(String sendToAll)

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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

sendToAll - the value to set

Returns:

the dsl builder

sslContextParameters

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder 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 VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder 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