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

Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder, VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Enclosing interface:

VertxWebsocketEndpointBuilderFactory

public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder
extends VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder, VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Builder for endpoint for the Vert.x WebSocket component.

Method Summary

Modifier and Type	Method	Description
default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointBuilder	advanced()
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	allowOriginHeader(boolean allowOriginHeader)	Whether the WebSocket client should add the Origin header to the WebSocket handshake request.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	allowOriginHeader(String allowOriginHeader)	Whether the WebSocket client should add the Origin header to the WebSocket handshake request.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	handshakeHeaders(String key, Object value)	Headers to send in the HTTP handshake request.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	handshakeHeaders(Map values)	Headers to send in the HTTP handshake request.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	originHeaderUrl(String originHeaderUrl)	The value of the Origin header that the WebSocket client should use on the WebSocket handshake request.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	sslContextParameters(String sslContextParameters)	To configure security using SSLContextParameters.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder	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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

allowedOriginPattern, consumeAsClient, consumeAsClient, fireWebSocketConnectionEvents, fireWebSocketConnectionEvents, maxReconnectAttempts, maxReconnectAttempts, reconnectInitialDelay, reconnectInitialDelay, reconnectInterval, reconnectInterval

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

clientSubProtocols, sendToAll, sendToAll

Method Details

advanced

default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointBuilder advanced()

Specified by:

advanced in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

advanced in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

allowOriginHeader

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder allowOriginHeader(boolean allowOriginHeader)

Whether the WebSocket client should add the Origin header to the WebSocket handshake request. The option is a: boolean type. Default: true Group: security

Specified by:

allowOriginHeader in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

allowOriginHeader in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

allowOriginHeader - the value to set

Returns:

the dsl builder

allowOriginHeader

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder allowOriginHeader(String allowOriginHeader)

Whether the WebSocket client should add the Origin header to the WebSocket handshake request. The option will be converted to a boolean type. Default: true Group: security

Specified by:

allowOriginHeader in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

allowOriginHeader in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

allowOriginHeader - the value to set

Returns:

the dsl builder

handshakeHeaders

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder handshakeHeaders(String key,
 Object value)

Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true). This is a multi-value option with prefix: handshake. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the handshakeHeaders(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

handshakeHeaders in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

handshakeHeaders in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

handshakeHeaders

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder handshakeHeaders(Map values)

Headers to send in the HTTP handshake request. When the endpoint is a consumer, it only works when it consumes a remote host as a client (i.e. consumeAsClient is true). This is a multi-value option with prefix: handshake. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the handshakeHeaders(String, Object) method to add a value (call the method multiple times to set more values). Group: security

Specified by:

handshakeHeaders in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

handshakeHeaders in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

originHeaderUrl

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder originHeaderUrl(String originHeaderUrl)

The value of the Origin header that the WebSocket client should use on the WebSocket handshake request. When not specified, the WebSocket client will automatically determine the value for the Origin from the request URL. The option is a: java.lang.String type. Group: security

Specified by:

originHeaderUrl in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

originHeaderUrl in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

originHeaderUrl - the value to set

Returns:

the dsl builder

sslContextParameters

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

sslContextParameters in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

Specified by:

sslContextParameters in interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointProducerBuilder

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder