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

Interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointBuilder

Enclosing interface:

VertxWebsocketEndpointBuilderFactory

public static interface VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

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

Method Summary

Modifier and Type	Method	Description
default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointConsumerBuilder	advanced()
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	allowedOriginPattern(String allowedOriginPattern)	Regex pattern to match the origin header sent by WebSocket clients.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	router(io.vertx.ext.web.Router router)	To use an existing vertx router for the HTTP server.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	router(String router)	To use an existing vertx router for the HTTP server.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	serverOptions(io.vertx.core.http.HttpServerOptions serverOptions)	Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	serverOptions(String serverOptions)	Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	sslContextParameters(String sslContextParameters)	To configure security using SSLContextParameters.
default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder	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

Method Detail

advanced

default VertxWebsocketEndpointBuilderFactory.AdvancedVertxWebsocketEndpointConsumerBuilder advanced()

allowedOriginPattern

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder allowedOriginPattern(String allowedOriginPattern)

Regex pattern to match the origin header sent by WebSocket clients. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

allowedOriginPattern - the value to set

Returns:

the dsl builder

router

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(io.vertx.ext.web.Router router)

To use an existing vertx router for the HTTP server. The option is a: <code>io.vertx.ext.web.Router</code> type. Group: consumer

Parameters:

router - the value to set

Returns:

the dsl builder

router

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder router(String router)

To use an existing vertx router for the HTTP server. The option will be converted to a <code>io.vertx.ext.web.Router</code> type. Group: consumer

Parameters:

router - the value to set

Returns:

the dsl builder

serverOptions

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(io.vertx.core.http.HttpServerOptions serverOptions)

Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option is a: <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer

Parameters:

serverOptions - the value to set

Returns:

the dsl builder

serverOptions

default VertxWebsocketEndpointBuilderFactory.VertxWebsocketEndpointConsumerBuilder serverOptions(String serverOptions)

Sets customized options for configuring the HTTP server hosting the WebSocket for the consumer. The option will be converted to a <code>io.vertx.core.http.HttpServerOptions</code> type. Group: consumer

Parameters:

serverOptions - the value to set

Returns:

the dsl builder

sslContextParameters

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