You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2018/08/21 06:24:31 UTC
[camel] 01/02: Regen and updated component docs
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 6b692cb72e064c2badf9552080450770aaf3f02f
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Aug 21 08:22:11 2018 +0200
Regen and updated component docs
---
.../src/main/docs/atmosphere-websocket-component.adoc | 9 ++++++++-
.../camel-servlet/src/main/docs/servlet-component.adoc | 4 ++--
.../apache/camel/component/servlet/ServletComponent.java | 13 +++++++++++--
.../springboot/WebsocketComponentConfiguration.java | 2 +-
.../servlet/springboot/ServletComponentConfiguration.java | 2 +-
5 files changed, 23 insertions(+), 7 deletions(-)
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
index e252c6c..1de8d15 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
@@ -42,10 +42,17 @@ The Atmosphere Websocket component supports 9 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
+<<<<<<< HEAD
| *servletName* (common) | Default name of servlet to use. The default name is CamelServlet. | | String
| *httpRegistry* (common) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry
| *attachmentMultipart Binding* (common) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean
| *fileNameExtWhitelist* (common) | Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. | | String
+=======
+| *servletName* (consumer) | Default name of servlet to use. The default name is CamelServlet. | CamelServlet | String
+| *httpRegistry* (consumer) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry
+| *attachmentMultipart Binding* (consumer) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean
+| *fileNameExtWhitelist* (consumer) | Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. | | String
+>>>>>>> Regen and updated component docs
| *httpBinding* (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
| *httpConfiguration* (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration
| *allowJavaSerialized Object* (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | boolean
@@ -142,7 +149,7 @@ The component supports 10 options, which are listed below.
| *camel.component.atmosphere-websocket.http-configuration* | To use the shared HttpConfiguration as base configuration. The option is a org.apache.camel.http.common.HttpConfiguration type. | | String
| *camel.component.atmosphere-websocket.http-registry* | To use a custom org.apache.camel.component.servlet.HttpRegistry. The option is a org.apache.camel.component.servlet.HttpRegistry type. | | String
| *camel.component.atmosphere-websocket.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.atmosphere-websocket.servlet-name* | Default name of servlet to use. The default name is CamelServlet. | | String
+| *camel.component.atmosphere-websocket.servlet-name* | Default name of servlet to use. The default name is CamelServlet. | CamelServlet | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc
index 680f1c1..b6d48eb 100644
--- a/components/camel-servlet/src/main/docs/servlet-component.adoc
+++ b/components/camel-servlet/src/main/docs/servlet-component.adoc
@@ -50,7 +50,7 @@ The Servlet component supports 9 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *servletName* (consumer) | Default name of servlet to use. The default name is CamelServlet. | | String
+| *servletName* (consumer) | Default name of servlet to use. The default name is CamelServlet. | CamelServlet | String
| *httpRegistry* (consumer) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry
| *attachmentMultipart Binding* (consumer) | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's. | false | boolean
| *fileNameExtWhitelist* (consumer) | Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml. | | String
@@ -134,7 +134,7 @@ The component supports 13 options, which are listed below.
| *camel.component.servlet.mapping.enabled* | Enables the automatic mapping of the servlet component into the Spring web context. | true | Boolean
| *camel.component.servlet.mapping.servlet-name* | The name of the Camel servlet. | CamelServlet | String
| *camel.component.servlet.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
-| *camel.component.servlet.servlet-name* | Default name of servlet to use. The default name is CamelServlet. | | String
+| *camel.component.servlet.servlet-name* | Default name of servlet to use. The default name is CamelServlet. | CamelServlet | String
|===
// spring-boot-auto-configure options: END
diff --git a/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletComponent.java b/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletComponent.java
index 3683be6..1ee0fda 100644
--- a/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletComponent.java
+++ b/components/camel-servlet/src/main/java/org/apache/camel/component/servlet/ServletComponent.java
@@ -30,6 +30,7 @@ import org.apache.camel.http.common.HttpBinding;
import org.apache.camel.http.common.HttpCommonComponent;
import org.apache.camel.http.common.HttpConsumer;
import org.apache.camel.spi.HeaderFilterStrategy;
+import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.RestApiConsumerFactory;
import org.apache.camel.spi.RestConfiguration;
import org.apache.camel.spi.RestConsumerFactory;
@@ -44,9 +45,17 @@ public class ServletComponent extends HttpCommonComponent implements RestConsume
private static final Logger LOG = LoggerFactory.getLogger(ServletComponent.class);
+ @Metadata(label = "consumer", defaultValue = "CamelServlet", description = "Default name of servlet to use. The default name is CamelServlet.")
private String servletName = "CamelServlet";
+ @Metadata(label = "consumer,advanced", description = "To use a custom org.apache.camel.component.servlet.HttpRegistry.")
private HttpRegistry httpRegistry;
+ @Metadata(label = "consumer,advanced", description = "Whether to automatic bind multipart/form-data as attachments on the Camel Exchange}."
+ + " The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together."
+ + " Remove disableStreamCache to use AttachmentMultipartBinding."
+ + " This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.")
private boolean attachmentMultipartBinding;
+ @Metadata(label = "consumer,advanced", description = "Whitelist of accepted filename extensions for accepting uploaded files."
+ + " Multiple extensions can be separated by comma, such as txt,xml.")
private String fileNameExtWhitelist;
public ServletComponent() {
@@ -191,7 +200,7 @@ public class ServletComponent extends HttpCommonComponent implements RestConsume
}
/**
- * Default name of servlet to use. The default name is <tt>CamelServlet</tt>.
+ * Default name of servlet to use. The default name is CamelServlet.
*/
public void setServletName(String servletName) {
this.servletName = servletName;
@@ -202,7 +211,7 @@ public class ServletComponent extends HttpCommonComponent implements RestConsume
}
/**
- * To use a custom {@link org.apache.camel.component.servlet.HttpRegistry}.
+ * To use a custom org.apache.camel.component.servlet.HttpRegistry.
*/
public void setHttpRegistry(HttpRegistry httpRegistry) {
this.httpRegistry = httpRegistry;
diff --git a/platforms/spring-boot/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
index d84c759..8683f0a 100644
--- a/platforms/spring-boot/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
@@ -39,7 +39,7 @@ public class WebsocketComponentConfiguration
/**
* Default name of servlet to use. The default name is CamelServlet.
*/
- private String servletName;
+ private String servletName = "CamelServlet";
/**
* To use a custom org.apache.camel.component.servlet.HttpRegistry. The
* option is a org.apache.camel.component.servlet.HttpRegistry type.
diff --git a/platforms/spring-boot/components-starter/camel-servlet-starter/src/main/java/org/apache/camel/component/servlet/springboot/ServletComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-servlet-starter/src/main/java/org/apache/camel/component/servlet/springboot/ServletComponentConfiguration.java
index 3599ad6..20c69ed 100644
--- a/platforms/spring-boot/components-starter/camel-servlet-starter/src/main/java/org/apache/camel/component/servlet/springboot/ServletComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-servlet-starter/src/main/java/org/apache/camel/component/servlet/springboot/ServletComponentConfiguration.java
@@ -40,7 +40,7 @@ public class ServletComponentConfiguration
/**
* Default name of servlet to use. The default name is CamelServlet.
*/
- private String servletName;
+ private String servletName = "CamelServlet";
/**
* To use a custom org.apache.camel.component.servlet.HttpRegistry. The
* option is a org.apache.camel.component.servlet.HttpRegistry type.