blob: 07714cd7476d262e929f9fdf332c0b2dfa2e2a0d [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.component.websocket.springboot;
import javax.annotation.Generated;
import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon;
import org.apache.camel.support.jsse.SSLContextParameters;
import org.eclipse.jetty.util.thread.ThreadPool;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Expose websocket endpoints using Jetty.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo")
@ConfigurationProperties(prefix = "camel.component.websocket")
public class WebsocketComponentConfiguration
extends
ComponentConfigurationPropertiesCommon {
/**
* Whether to enable auto configuration of the websocket component. This is
* enabled by default.
*/
private Boolean enabled;
/**
* The hostname. The default value is 0.0.0.0
*/
private String host = "0.0.0.0";
/**
* The port number. The default value is 9292
*/
private Integer port = 9292;
/**
* 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.
*/
private Boolean bridgeErrorHandler = false;
/**
* 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.
*/
private String staticResources;
/**
* 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.
*/
private Boolean lazyStartProducer = false;
/**
* 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.
*/
private Boolean autowiredEnabled = true;
/**
* If this option is true, Jetty JMX support will be enabled for this
* endpoint. See Jetty JMX support for more details.
*/
private Boolean enableJmx = false;
/**
* 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.
*/
private Integer maxThreads;
/**
* 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.
*/
private Integer minThreads;
/**
* This is a comma-separated list of subprotocols that are supported by the
* application. The list is in priority order. The first subprotocol on this
* list that is proposed by the client is the one that will be accepted. If
* no subprotocol on this list is proposed by the client, then the websocket
* connection is refused. The special value 'any' means that any subprotocol
* is acceptable. 'any' can be used on its own, or as a failsafe at the end
* of a list of more specific protocols. 'any' will also match the case
* where no subprotocol is proposed by the client.
*/
private String subprotocol = "any";
/**
* 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.
*/
private ThreadPool threadPool;
/**
* To configure security using SSLContextParameters. The option is a
* org.apache.camel.support.jsse.SSLContextParameters type.
*/
private SSLContextParameters sslContextParameters;
/**
* The password for the keystore when using SSL.
*/
private String sslKeyPassword;
/**
* The path to the keystore.
*/
private String sslKeystore;
/**
* The password when using SSL.
*/
private String sslPassword;
/**
* Enable usage of global SSL context parameters.
*/
private Boolean useGlobalSslContextParameters = false;
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public Integer getPort() {
return port;
}
public void setPort(Integer port) {
this.port = port;
}
public Boolean getBridgeErrorHandler() {
return bridgeErrorHandler;
}
public void setBridgeErrorHandler(Boolean bridgeErrorHandler) {
this.bridgeErrorHandler = bridgeErrorHandler;
}
public String getStaticResources() {
return staticResources;
}
public void setStaticResources(String staticResources) {
this.staticResources = staticResources;
}
public Boolean getLazyStartProducer() {
return lazyStartProducer;
}
public void setLazyStartProducer(Boolean lazyStartProducer) {
this.lazyStartProducer = lazyStartProducer;
}
public Boolean getAutowiredEnabled() {
return autowiredEnabled;
}
public void setAutowiredEnabled(Boolean autowiredEnabled) {
this.autowiredEnabled = autowiredEnabled;
}
public Boolean getEnableJmx() {
return enableJmx;
}
public void setEnableJmx(Boolean enableJmx) {
this.enableJmx = enableJmx;
}
public Integer getMaxThreads() {
return maxThreads;
}
public void setMaxThreads(Integer maxThreads) {
this.maxThreads = maxThreads;
}
public Integer getMinThreads() {
return minThreads;
}
public void setMinThreads(Integer minThreads) {
this.minThreads = minThreads;
}
public String getSubprotocol() {
return subprotocol;
}
public void setSubprotocol(String subprotocol) {
this.subprotocol = subprotocol;
}
public ThreadPool getThreadPool() {
return threadPool;
}
public void setThreadPool(ThreadPool threadPool) {
this.threadPool = threadPool;
}
public SSLContextParameters getSslContextParameters() {
return sslContextParameters;
}
public void setSslContextParameters(
SSLContextParameters sslContextParameters) {
this.sslContextParameters = sslContextParameters;
}
public String getSslKeyPassword() {
return sslKeyPassword;
}
public void setSslKeyPassword(String sslKeyPassword) {
this.sslKeyPassword = sslKeyPassword;
}
public String getSslKeystore() {
return sslKeystore;
}
public void setSslKeystore(String sslKeystore) {
this.sslKeystore = sslKeystore;
}
public String getSslPassword() {
return sslPassword;
}
public void setSslPassword(String sslPassword) {
this.sslPassword = sslPassword;
}
public Boolean getUseGlobalSslContextParameters() {
return useGlobalSslContextParameters;
}
public void setUseGlobalSslContextParameters(
Boolean useGlobalSslContextParameters) {
this.useGlobalSslContextParameters = useGlobalSslContextParameters;
}
}