This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6ac1b1f3ed4d637a83f8d60032efa3b12fe1629d
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Jun 12 10:44:12 2019 +0200
CAMEL-13634: Camel main - Allow to configure rest dsl configuration
---
.../camel/main/RestConfigurationProperties.java | 386 ++-------------------
1 file changed, 32 insertions(+), 354 deletions(-)
diff --git
a/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
b/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
index 6e1237a..9150315d 100644
---
a/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
+++
b/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
@@ -16,46 +16,16 @@
*/
package org.apache.camel.main;
+import org.apache.camel.spi.RestConfiguration;
import org.apache.camel.support.PatternHelper;
/**
* Global configuration for Rest DSL.
*/
-public class RestConfigurationProperties {
+public class RestConfigurationProperties extends RestConfiguration {
private final MainConfigurationProperties parent;
- private String component;
- private String apiComponent;
- private String producerComponent;
- private String scheme;
- private String host;
- private String apiHost;
- private Boolean useXForwardHeaders;
- private String port;
- private String producerApiDoc;
- private String contextPath;
- private String apiContextPath;
- private String apiContextRouteId;
- private String apiContextIdPattern;
- private Boolean apiContextListing;
- private Boolean apiVendorExtension;
- private String hostNameResolver;
- private String bindingMode;
- private Boolean skipBindingOnErrorCode;
- private Boolean clientRequestValidation;
- private Boolean enableCORS;
- private String jsonDataFormat;
- private String xmlDataFormat;
-
- // TODO: Do these later
-// private List<RestPropertyDefinition> componentProperties = new
ArrayList<>();
-// private List<RestPropertyDefinition> endpointProperties = new
ArrayList<>();
-// private List<RestPropertyDefinition> consumerProperties = new
ArrayList<>();
-// private List<RestPropertyDefinition> dataFormatProperties = new
ArrayList<>();
-// private List<RestPropertyDefinition> apiProperties = new ArrayList<>();
-// private List<RestPropertyDefinition> corsHeaders = new ArrayList<>();
-
public RestConfigurationProperties(MainConfigurationProperties parent) {
this.parent = parent;
}
@@ -67,299 +37,7 @@ public class RestConfigurationProperties {
// getter and setters
// --------------------------------------------------------------
- public String getComponent() {
- return component;
- }
-
- /**
- * The Camel Rest component to use for the REST transport (consumer), such
as restlet, spark-rest.
- * If no component has been explicit configured, then Camel will lookup if
there is a Camel component
- * that integrates with the Rest DSL, or if a
org.apache.camel.spi.RestConsumerFactory is registered in the registry.
- * If either one is found, then that is being used.
- */
- public void setComponent(String component) {
- this.component = component;
- }
-
- public String getApiComponent() {
- return apiComponent;
- }
-
- /**
- * The name of the Camel component to use as the REST API (such as swagger)
- */
- public void setApiComponent(String apiComponent) {
- this.apiComponent = apiComponent;
- }
-
- public String getProducerComponent() {
- return producerComponent;
- }
-
- /**
- * Sets the name of the Camel component to use as the REST producer
- */
- public void setProducerComponent(String producerComponent) {
- this.producerComponent = producerComponent;
- }
-
- public String getScheme() {
- return scheme;
- }
-
- /**
- * The scheme to use for exposing the REST service. Usually http or https
is supported.
- * <p/>
- * The default value is http
- */
- public void setScheme(String scheme) {
- this.scheme = scheme;
- }
-
- public String getHost() {
- return host;
- }
-
- /**
- * The hostname to use for exposing the REST service.
- */
- public void setHost(String host) {
- this.host = host;
- }
-
- public String getApiHost() {
- return apiHost;
- }
-
- /**
- * To use an specific hostname for the API documentation (eg swagger)
- * <p/>
- * This can be used to override the generated host with this configured
hostname
- */
- public void setApiHost(String apiHost) {
- this.apiHost = apiHost;
- }
-
- public Boolean getUseXForwardHeaders() {
- return useXForwardHeaders;
- }
-
- /**
- * Whether to use X-Forward headers for Host and related setting.
- * <p/>
- * The default value is true.
- */
- public void setUseXForwardHeaders(Boolean useXForwardHeaders) {
- this.useXForwardHeaders = useXForwardHeaders;
- }
-
- public String getPort() {
- return port;
- }
-
- /**
- * The port number to use for exposing the REST service.
- * Notice if you use servlet component then the port number configured
here does not apply,
- * as the port number in use is the actual port number the servlet
component is using.
- * eg if using Apache Tomcat its the tomcat http port, if using Apache
Karaf its the HTTP service in Karaf
- * that uses port 8181 by default etc. Though in those situations setting
the port number here,
- * allows tooling and JMX to know the port number, so its recommended to
set the port number
- * to the number that the servlet engine uses.
- */
- public void setPort(String port) {
- this.port = port;
- }
-
- public String getProducerApiDoc() {
- return producerApiDoc;
- }
-
- /**
- * Sets the location of the api document (swagger api) the REST producer
will use
- * to validate the REST uri and query parameters are valid accordingly to
the api document.
- * This requires adding camel-swagger-java to the classpath, and any miss
configuration
- * will let Camel fail on startup and report the error(s).
- * <p/>
- * The location of the api document is loaded from classpath by default,
but you can use
- * <tt>file:</tt> or <tt>http:</tt> to refer to resources to load from
file or http url.
- */
- public void setProducerApiDoc(String producerApiDoc) {
- this.producerApiDoc = producerApiDoc;
- }
-
- public String getContextPath() {
- return contextPath;
- }
-
- /**
- * Sets a leading context-path the REST services will be using.
- * <p/>
- * This can be used when using components such as <tt>camel-servlet</tt>
where the deployed web application
- * is deployed using a context-path. Or for components such as
<tt>camel-jetty</tt> or <tt>camel-netty4-http</tt>
- * that includes a HTTP server.
- */
- public void setContextPath(String contextPath) {
- this.contextPath = contextPath;
- }
-
- public String getApiContextPath() {
- return apiContextPath;
- }
-
- /**
- * Sets a leading API context-path the REST API services will be using.
- * <p/>
- * This can be used when using components such as <tt>camel-servlet</tt>
where the deployed web application
- * is deployed using a context-path.
- */
- public void setApiContextPath(String apiContextPath) {
- this.apiContextPath = apiContextPath;
- }
-
- public String getApiContextRouteId() {
- return apiContextRouteId;
- }
-
- /**
- * Sets the route id to use for the route that services the REST API.
- * <p/>
- * The route will by default use an auto assigned route id.
- */
- public void setApiContextRouteId(String apiContextRouteId) {
- this.apiContextRouteId = apiContextRouteId;
- }
-
- public String getApiContextIdPattern() {
- return apiContextIdPattern;
- }
-
- /**
- * Sets an CamelContext id pattern to only allow Rest APIs from rest
services within CamelContext's which name matches the pattern.
- * <p/>
- * The pattern <tt>#name#</tt> refers to the CamelContext name, to match
on the current CamelContext only.
- * For any other value, the pattern uses the rules from {@link
PatternHelper#matchPattern(String, String)}
- */
- public void setApiContextIdPattern(String apiContextIdPattern) {
- this.apiContextIdPattern = apiContextIdPattern;
- }
-
- public Boolean getApiContextListing() {
- return apiContextListing;
- }
-
- /**
- * Sets whether listing of all available CamelContext's with REST services
in the JVM is enabled. If enabled it allows to discover
- * these contexts, if <tt>false</tt> then only the current CamelContext is
in use.
- */
- public void setApiContextListing(Boolean apiContextListing) {
- this.apiContextListing = apiContextListing;
- }
-
- public Boolean getApiVendorExtension() {
- return apiVendorExtension;
- }
-
- /**
- * Whether vendor extension is enabled in the Rest APIs. If enabled then
Camel will include additional information
- * as vendor extension (eg keys starting with x-) such as route ids, class
names etc.
- * Not all 3rd party API gateways and tools supports vendor-extensions
when importing your API docs.
- */
- public void setApiVendorExtension(Boolean apiVendorExtension) {
- this.apiVendorExtension = apiVendorExtension;
- }
-
- public String getHostNameResolver() {
- return hostNameResolver;
- }
-
- /**
- * If no hostname has been explicit configured, then this resolver is used
to compute the hostname the REST service will be using.
- * The possible values are: allLocalIp, localIp, localHostName
- */
- public void setHostNameResolver(String hostNameResolver) {
- this.hostNameResolver = hostNameResolver;
- }
-
- public String getBindingMode() {
- return bindingMode;
- }
-
- /**
- * Sets the binding mode to use.
- * <p/>
- * The possible values are: auto, off, json, xml, json_xml
- * The default value is off
- */
- public void setBindingMode(String bindingMode) {
- this.bindingMode = bindingMode;
- }
-
- public Boolean getSkipBindingOnErrorCode() {
- return skipBindingOnErrorCode;
- }
-
- /**
- * Whether to skip binding on output if there is a custom HTTP error code
header.
- * This allows to build custom error messages that do not bind to json /
xml etc, as success messages otherwise will do.
- */
- public void setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode) {
- this.skipBindingOnErrorCode = skipBindingOnErrorCode;
- }
-
- public Boolean getClientRequestValidation() {
- return clientRequestValidation;
- }
-
- /**
- * Whether to enable validation of the client request to check whether the
Content-Type and Accept headers from
- * the client is supported by the Rest-DSL configuration of its
consumes/produces settings.
- * <p/>
- * This can be turned on, to enable this check. In case of validation
error, then HTTP Status codes 415 or 406 is returned.
- * <p/>
- * The default value is false.
- */
- public void setClientRequestValidation(Boolean clientRequestValidation) {
- this.clientRequestValidation = clientRequestValidation;
- }
-
- public Boolean getEnableCORS() {
- return enableCORS;
- }
-
- /**
- * Whether to enable CORS headers in the HTTP response.
- * <p/>
- * The default value is false.
- */
- public void setEnableCORS(Boolean enableCORS) {
- this.enableCORS = enableCORS;
- }
-
- public String getJsonDataFormat() {
- return jsonDataFormat;
- }
-
- /**
- * Name of specific json data format to use.
- * By default json-jackson will be used.
- * Important: This option is only for setting a custom name of the data
format, not to refer to an existing data format instance.
- */
- public void setJsonDataFormat(String jsonDataFormat) {
- this.jsonDataFormat = jsonDataFormat;
- }
-
- public String getXmlDataFormat() {
- return xmlDataFormat;
- }
-
- /**
- * Name of specific XML data format to use.
- * By default jaxb will be used.
- * Important: This option is only for setting a custom name of the data
format, not to refer to an existing data format instance.
- */
- public void setXmlDataFormat(String xmlDataFormat) {
- this.xmlDataFormat = xmlDataFormat;
- }
+ // these are inherited from the parent class
// fluent builders
@@ -372,7 +50,7 @@ public class RestConfigurationProperties {
* If either one is found, then that is being used.
*/
public RestConfigurationProperties withComponent(String component) {
- this.component = component;
+ setComponent(component);
return this;
}
@@ -380,7 +58,7 @@ public class RestConfigurationProperties {
* The name of the Camel component to use as the REST API (such as swagger)
*/
public RestConfigurationProperties withApiComponent(String apiComponent) {
- this.apiComponent = apiComponent;
+ setApiComponent(apiComponent);
return this;
}
@@ -388,7 +66,7 @@ public class RestConfigurationProperties {
* Sets the name of the Camel component to use as the REST producer
*/
public RestConfigurationProperties withProducerComponent(String
producerComponent) {
- this.producerComponent = producerComponent;
+ setProducerComponent(producerComponent);
return this;
}
@@ -398,7 +76,7 @@ public class RestConfigurationProperties {
* The default value is http
*/
public RestConfigurationProperties withScheme(String scheme) {
- this.scheme = scheme;
+ setScheme(scheme);
return this;
}
@@ -406,7 +84,7 @@ public class RestConfigurationProperties {
* The hostname to use for exposing the REST service.
*/
public RestConfigurationProperties withHost(String host) {
- this.host = host;
+ setHost(host);
return this;
}
@@ -416,7 +94,7 @@ public class RestConfigurationProperties {
* This can be used to override the generated host with this configured
hostname
*/
public RestConfigurationProperties withApiHost(String apiHost) {
- this.apiHost = apiHost;
+ setApiHost(apiHost);
return this;
}
@@ -425,8 +103,8 @@ public class RestConfigurationProperties {
* <p/>
* The default value is true.
*/
- public RestConfigurationProperties withUseXForwardHeaders(Boolean
useXForwardHeaders) {
- this.useXForwardHeaders = useXForwardHeaders;
+ public RestConfigurationProperties withUseXForwardHeaders(boolean
useXForwardHeaders) {
+ setUseXForwardHeaders(useXForwardHeaders);
return this;
}
@@ -439,8 +117,8 @@ public class RestConfigurationProperties {
* allows tooling and JMX to know the port number, so its recommended to
set the port number
* to the number that the servlet engine uses.
*/
- public RestConfigurationProperties withPort(String port) {
- this.port = port;
+ public RestConfigurationProperties withPort(int port) {
+ setPort(port);
return this;
}
@@ -454,7 +132,7 @@ public class RestConfigurationProperties {
* <tt>file:</tt> or <tt>http:</tt> to refer to resources to load from
file or http url.
*/
public RestConfigurationProperties withProducerApiDoc(String
producerApiDoc) {
- this.producerApiDoc = producerApiDoc;
+ setProducerApiDoc(producerApiDoc);
return this;
}
@@ -466,7 +144,7 @@ public class RestConfigurationProperties {
* that includes a HTTP server.
*/
public RestConfigurationProperties withContextPath(String contextPath) {
- this.contextPath = contextPath;
+ setContextPath(contextPath);
return this;
}
@@ -477,7 +155,7 @@ public class RestConfigurationProperties {
* is deployed using a context-path.
*/
public RestConfigurationProperties withApiContextPath(String
apiContextPath) {
- this.apiContextPath = apiContextPath;
+ setApiContextPath(apiContextPath);
return this;
}
@@ -487,7 +165,7 @@ public class RestConfigurationProperties {
* The route will by default use an auto assigned route id.
*/
public RestConfigurationProperties withApiContextRouteId(String
apiContextRouteId) {
- this.apiContextRouteId = apiContextRouteId;
+ setApiContextRouteId(apiContextRouteId);
return this;
}
@@ -498,7 +176,7 @@ public class RestConfigurationProperties {
* For any other value, the pattern uses the rules from {@link
PatternHelper#matchPattern(String, String)}
*/
public RestConfigurationProperties withApiContextIdPattern(String
apiContextIdPattern) {
- this.apiContextIdPattern = apiContextIdPattern;
+ setApiContextIdPattern(apiContextIdPattern);
return this;
}
@@ -506,8 +184,8 @@ public class RestConfigurationProperties {
* Sets whether listing of all available CamelContext's with REST services
in the JVM is enabled. If enabled it allows to discover
* these contexts, if <tt>false</tt> then only the current CamelContext is
in use.
*/
- public RestConfigurationProperties withApiContextListing(Boolean
apiContextListing) {
- this.apiContextListing = apiContextListing;
+ public RestConfigurationProperties withApiContextListing(boolean
apiContextListing) {
+ setApiContextListing(apiContextListing);
return this;
}
@@ -516,8 +194,8 @@ public class RestConfigurationProperties {
* as vendor extension (eg keys starting with x-) such as route ids, class
names etc.
* Not all 3rd party API gateways and tools supports vendor-extensions
when importing your API docs.
*/
- public RestConfigurationProperties withApiVendorExtension(Boolean
apiVendorExtension) {
- this.apiVendorExtension = apiVendorExtension;
+ public RestConfigurationProperties withApiVendorExtension(boolean
apiVendorExtension) {
+ setApiVendorExtension(apiVendorExtension);
return this;
}
@@ -526,7 +204,7 @@ public class RestConfigurationProperties {
* The possible values are: allLocalIp, localIp, localHostName
*/
public RestConfigurationProperties withHostNameResolver(String
hostNameResolver) {
- this.hostNameResolver = hostNameResolver;
+ setHostNameResolver(hostNameResolver);
return this;
}
@@ -537,7 +215,7 @@ public class RestConfigurationProperties {
* The default value is off
*/
public RestConfigurationProperties withBindingMode(String bindingMode) {
- this.bindingMode = bindingMode;
+ setBindingMode(bindingMode);
return this;
}
@@ -545,8 +223,8 @@ public class RestConfigurationProperties {
* Whether to skip binding on output if there is a custom HTTP error code
header.
* This allows to build custom error messages that do not bind to json /
xml etc, as success messages otherwise will do.
*/
- public RestConfigurationProperties withSkipBindingOnErrorCode(Boolean
skipBindingOnErrorCode) {
- this.skipBindingOnErrorCode = skipBindingOnErrorCode;
+ public RestConfigurationProperties withSkipBindingOnErrorCode(boolean
skipBindingOnErrorCode) {
+ setSkipBindingOnErrorCode(skipBindingOnErrorCode);
return this;
}
@@ -558,8 +236,8 @@ public class RestConfigurationProperties {
* <p/>
* The default value is false.
*/
- public RestConfigurationProperties withClientRequestValidation(Boolean
clientRequestValidation) {
- this.clientRequestValidation = clientRequestValidation;
+ public RestConfigurationProperties withClientRequestValidation(boolean
clientRequestValidation) {
+ setClientRequestValidation(clientRequestValidation);
return this;
}
@@ -568,8 +246,8 @@ public class RestConfigurationProperties {
* <p/>
* The default value is false.
*/
- public RestConfigurationProperties withEnableCORS(Boolean enableCORS) {
- this.enableCORS = enableCORS;
+ public RestConfigurationProperties withEnableCORS(boolean enableCORS) {
+ setEnableCORS(enableCORS);
return this;
}
@@ -579,7 +257,7 @@ public class RestConfigurationProperties {
* Important: This option is only for setting a custom name of the data
format, not to refer to an existing data format instance.
*/
public RestConfigurationProperties withJsonDataFormat(String
jsonDataFormat) {
- this.jsonDataFormat = jsonDataFormat;
+ setJsonDataFormat(jsonDataFormat);
return this;
}
@@ -589,7 +267,7 @@ public class RestConfigurationProperties {
* Important: This option is only for setting a custom name of the data
format, not to refer to an existing data format instance.
*/
public RestConfigurationProperties withXmlDataFormat(String xmlDataFormat)
{
- this.xmlDataFormat = xmlDataFormat;
+ setXmlDataFormat(xmlDataFormat);
return this;
}
