Interface WebsocketComponentBuilderFactory.WebsocketComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.websocket.WebsocketComponent>
- All Known Implementing Classes:
WebsocketComponentBuilderFactory.WebsocketComponentBuilderImpl
- Enclosing interface:
- WebsocketComponentBuilderFactory
public static interface WebsocketComponentBuilderFactory.WebsocketComponentBuilder extends ComponentBuilder<org.apache.camel.component.websocket.WebsocketComponent>
Builder for the Jetty Websocket component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
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 WebsocketComponentBuilderFactory.WebsocketComponentBuilder
enableJmx(boolean enableJmx)
If this option is true, Jetty JMX support will be enabled for this endpoint.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
host(String host)
The hostname.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
maxThreads(Integer maxThreads)
To set a value for maximum number of threads in server thread pool.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
minThreads(Integer minThreads)
To set a value for minimum number of threads in server thread pool.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
port(Integer port)
The port number.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
To configure security using SSLContextParameters.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
sslKeyPassword(String sslKeyPassword)
The password for the keystore when using SSL.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
sslKeystore(String sslKeystore)
The path to the keystore.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
sslPassword(String sslPassword)
The password when using SSL.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
staticResources(String staticResources)
Set a resource path for static resources (such as .html files etc).default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
threadPool(org.eclipse.jetty.util.thread.ThreadPool threadPool)
To use a custom thread pool for the server.default WebsocketComponentBuilderFactory.WebsocketComponentBuilder
useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
Enable usage of global SSL context parameters.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
host
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder host(String host)
The hostname. The default value is 0.0.0.0. The option is a:java.lang.String
type. Default: 0.0.0.0 Group: common
-
port
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder port(Integer port)
The port number. The default value is 9292. The option is a:java.lang.Integer
type. Default: 9292 Group: common
-
bridgeErrorHandler
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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:boolean
type. Default: false Group: consumer
-
staticResources
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder staticResources(String staticResources)
Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath, if you prefix with classpath:, otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:., or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. The option is a:java.lang.String
type. Group: consumer
-
lazyStartProducer
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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:boolean
type. Default: false Group: producer
-
autowiredEnabled
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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:boolean
type. Default: true Group: advanced
-
enableJmx
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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:boolean
type. Default: false Group: advanced
-
maxThreads
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder maxThreads(Integer maxThreads)
To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores. The option is a:java.lang.Integer
type. Group: advanced
-
minThreads
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder minThreads(Integer minThreads)
To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1. The option is a:java.lang.Integer
type. Group: advanced
-
threadPool
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder threadPool(org.eclipse.jetty.util.thread.ThreadPool threadPool)
To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The option is a:org.eclipse.jetty.util.thread.ThreadPool
type. Group: advanced
-
sslContextParameters
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder 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
-
sslKeyPassword
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslKeyPassword(String sslKeyPassword)
The password for the keystore when using SSL. The option is a:java.lang.String
type. Group: security
-
sslKeystore
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslKeystore(String sslKeystore)
The path to the keystore. The option is a:java.lang.String
type. Group: security
-
sslPassword
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder sslPassword(String sslPassword)
The password when using SSL. The option is a:java.lang.String
type. Group: security
-
useGlobalSslContextParameters
default WebsocketComponentBuilderFactory.WebsocketComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
Enable usage of global SSL context parameters. The option is a:boolean
type. Default: false Group: security
-
-