org.apache.camel.builder.component.dsl

Interface VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.vertx.websocket.VertxWebsocketComponent>

All Known Implementing Classes:

VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilderImpl

Enclosing interface:

VertxWebsocketComponentBuilderFactory

public static interface VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder
extends ComponentBuilder<org.apache.camel.component.vertx.websocket.VertxWebsocketComponent>

Builder for the Vert.x WebSocket component.

Method Summary

Modifier and Type	Method and Description
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	router(io.vertx.ext.web.Router router) To provide a custom vertx router to use on the WebSocket server.
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	useGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	vertx(io.vertx.core.Vertx vertx) To use an existing vertx instead of creating a new instance.
default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder	vertxOptions(io.vertx.core.VertxOptions vertxOptions) To provide a custom set of vertx options for configuring vertx.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

bridgeErrorHandler

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

lazyStartProducer

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

autowiredEnabled

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

router

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder router(io.vertx.ext.web.Router router)

To provide a custom vertx router to use on the WebSocket server. The option is a: <code>io.vertx.ext.web.Router</code> type. Group: advanced

Parameters:

router - the value to set

Returns:

the dsl builder

vertx

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder vertx(io.vertx.core.Vertx vertx)

To use an existing vertx instead of creating a new instance. The option is a: <code>io.vertx.core.Vertx</code> type. Group: advanced

Parameters:

vertx - the value to set

Returns:

the dsl builder

vertxOptions

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder vertxOptions(io.vertx.core.VertxOptions vertxOptions)

To provide a custom set of vertx options for configuring vertx. The option is a: <code>io.vertx.core.VertxOptions</code> type. Group: advanced

Parameters:

vertxOptions - the value to set

Returns:

the dsl builder

useGlobalSslContextParameters

default VertxWebsocketComponentBuilderFactory.VertxWebsocketComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)

Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security

Parameters:

useGlobalSslContextParameters - the value to set

Returns:

the dsl builder