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 2017/04/07 08:47:57 UTC
[1/3] camel git commit: CAMEL-11021: Add missing docs
Repository: camel
Updated Branches:
refs/heads/master 077e5df4f -> 97f442c6d
CAMEL-11021: Add missing docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6c284f7b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6c284f7b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6c284f7b
Branch: refs/heads/master
Commit: 6c284f7be78c6f85a61afc67c85825577b4d60ca
Parents: 077e5df
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 7 10:16:40 2017 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 7 10:16:40 2017 +0200
----------------------------------------------------------------------
.../org/apache/camel/spring/CamelContextFactoryBean.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/6c284f7b/components/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java b/components/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
index d839146..3faa12d 100644
--- a/components/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
+++ b/components/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
@@ -974,6 +974,9 @@ public class CamelContextFactoryBean extends AbstractCamelContextFactoryBean<Spr
return defaultServiceCallConfiguration;
}
+ /**
+ * ServiceCall EIP default configuration
+ */
public void setDefaultServiceCallConfiguration(ServiceCallConfigurationDefinition defaultServiceCallConfiguration) {
this.defaultServiceCallConfiguration = defaultServiceCallConfiguration;
}
@@ -984,7 +987,7 @@ public class CamelContextFactoryBean extends AbstractCamelContextFactoryBean<Spr
}
/**
- * ServiceCall configurations
+ * ServiceCall EIP configurations
*/
public void setServiceCallConfigurations(List<ServiceCallConfigurationDefinition> serviceCallConfigurations) {
this.serviceCallConfigurations = serviceCallConfigurations;
@@ -1000,12 +1003,15 @@ public class CamelContextFactoryBean extends AbstractCamelContextFactoryBean<Spr
return defaultHystrixConfiguration;
}
+ /**
+ * Hystrix EIP default configuration
+ */
public void setDefaultHystrixConfiguration(HystrixConfigurationDefinition defaultHystrixConfiguration) {
this.defaultHystrixConfiguration = defaultHystrixConfiguration;
}
/**
- * hystrix configurations
+ * Hystrix EIP configurations
*/
public void setHystrixConfigurations(List<HystrixConfigurationDefinition> hystrixConfigurations) {
this.hystrixConfigurations = hystrixConfigurations;
[2/3] camel git commit: CAMEL-11021: Add missing docs
Posted by da...@apache.org.
CAMEL-11021: Add missing docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f9d021a5
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f9d021a5
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f9d021a5
Branch: refs/heads/master
Commit: f9d021a59e8755d5780fb6f4ab468259254871cc
Parents: 6c284f7
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 7 10:29:48 2017 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 7 10:29:48 2017 +0200
----------------------------------------------------------------------
.../camel/model/rest/RestBindingDefinition.java | 39 +++++++-------
.../apache/camel/model/rest/VerbDefinition.java | 56 ++++++++++----------
2 files changed, 47 insertions(+), 48 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/f9d021a5/camel-core/src/main/java/org/apache/camel/model/rest/RestBindingDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/RestBindingDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/RestBindingDefinition.java
index 1c037d4..17f195e 100644
--- a/camel-core/src/main/java/org/apache/camel/model/rest/RestBindingDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/rest/RestBindingDefinition.java
@@ -244,8 +244,8 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
/**
* Adds a default value for the query parameter
*
- * @param paramName query parameter name.
- * @param defaultValue the default value.
+ * @param paramName query parameter name
+ * @param defaultValue the default value
*/
public void addDefaultValue(String paramName, String defaultValue) {
if (defaultValues == null) {
@@ -262,7 +262,7 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param component name of the component that this definition will apply to.
+ * Sets the component name that this definition will apply to
*/
public void setComponent(String component) {
this.component = component;
@@ -273,7 +273,7 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param consumes the HTTP Content Type of the input data, such as {@code application/xml} or {@code application/json}.
+ * To define the content type what the REST service consumes (accept as input), such as application/xml or application/json
*/
public void setConsumes(String consumes) {
this.consumes = consumes;
@@ -284,7 +284,7 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param produces the HTTP Content Type of the output data, such as {@code application/xml} or {@code application/json}.
+ * To define the content type what the REST service produces (uses for output), such as application/xml or application/json
*/
public void setProduces(String produces) {
this.produces = produces;
@@ -295,9 +295,9 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param bindingMode the binding mode to use. The default value is {@code RestBindingMode.off}.
- *
- * @see RestBindingMode
+ * Sets the binding mode to use.
+ * <p/>
+ * The default value is off
*/
public void setBindingMode(RestBindingMode bindingMode) {
this.bindingMode = bindingMode;
@@ -309,9 +309,9 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
/**
* Sets the class name to use for binding from input to POJO for the incoming data
- *
- * @param type the canonical name of the class of the input data. Append a {@code []} to the end
- * of the canonical name if you want the input to be an array of {@code type}.
+ * <p/>
+ * The canonical name of the class of the input data. Append a [] to the end of the canonical name
+ * if you want the input to be an array type.
*/
public void setType(String type) {
this.type = type;
@@ -323,9 +323,9 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
/**
* Sets the class name to use for binding from POJO to output for the outgoing data
- *
- * @param outType the canonical name of the class of the output data. Append a {@code []} to the end
- * of the canonical name if you want the output to be an array of {@code outType}.
+ * <p/>
+ * The canonical name of the class of the input data. Append a [] to the end of the canonical name
+ * if you want the input to be an array type.
*/
public void setOutType(String outType) {
this.outType = outType;
@@ -336,11 +336,8 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param skipBindingOnErrorCode set to {@code true} to ignore the specified binding mode 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.
- *
- * @see VerbDefinition#setBindingMode(RestBindingMode)
+ * 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;
@@ -351,7 +348,9 @@ public class RestBindingDefinition extends OptionalIdentifiedDefinition<RestBind
}
/**
- * @param enableCORS set to {@code true} to enable CORS headers in the HTTP response. The default value is {@code false}.
+ * Whether to enable CORS headers in the HTTP response.
+ * <p/>
+ * The default value is false.
*/
public void setEnableCORS(Boolean enableCORS) {
this.enableCORS = enableCORS;
http://git-wip-us.apache.org/repos/asf/camel/blob/f9d021a5/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java
index 35f66e9..f9c8d3f 100644
--- a/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/rest/VerbDefinition.java
@@ -140,7 +140,7 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param method the HTTP verb name such as {@code get, post, put, patch, delete, head}.
+ * The HTTP verb such as GET, POST, DELETE, etc.
*/
public void setMethod(String method) {
this.method = method;
@@ -151,7 +151,7 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param uri the query path for this REST service, such as {@code /{id}}.
+ * Uri template of this REST service such as /{id}.
*/
public void setUri(String uri) {
this.uri = uri;
@@ -162,8 +162,8 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param consumes the HTTP Content Type of the input data, such as {@code application/xml} or {@code application/json}.
- * This option will override what may be configured on a parent level.
+ * To define the content type what the REST service consumes (accept as input), such as application/xml or application/json.
+ * This option will override what may be configured on a parent level
*/
public void setConsumes(String consumes) {
this.consumes = consumes;
@@ -174,8 +174,8 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param produces the HTTP Content Type of the output data, such as {@code application/xml} or {@code application/json}.
- * This option will override what may be configured on a parent level.
+ * To define the content type what the REST service produces (uses for output), such as application/xml or application/json
+ * This option will override what may be configured on a parent level
*/
public void setProduces(String produces) {
this.produces = produces;
@@ -186,10 +186,10 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param bindingMode the binding mode to use. The default value is {@code RestBindingMode.auto}.
- * This option will override what may be configured on a parent level.
- *
- * @see RestBindingMode
+ * Sets the binding mode to use.
+ * This option will override what may be configured on a parent level
+ * <p/>
+ * The default value is auto
*/
public void setBindingMode(RestBindingMode bindingMode) {
this.bindingMode = bindingMode;
@@ -200,12 +200,9 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param skipBindingOnErrorCode set to {@code true} to ignore the specified binding mode 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.
- * This option will override what may be configured on a parent level.
- *
- * @see VerbDefinition#setBindingMode(RestBindingMode)
+ * 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.
+ * This option will override what may be configured on a parent level
*/
public void setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode) {
this.skipBindingOnErrorCode = skipBindingOnErrorCode;
@@ -216,8 +213,10 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param enableCORS set to {@code true} to enable CORS headers in the HTTP response. The default value is {@code false}.
- * This option will override what may be configured on a parent level.
+ * Whether to enable CORS headers in the HTTP response.
+ * This option will override what may be configured on a parent level
+ * <p/>
+ * The default value is false.
*/
public void setEnableCORS(Boolean enableCORS) {
this.enableCORS = enableCORS;
@@ -230,9 +229,9 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
/**
* Sets the class name to use for binding from input to POJO for the incoming data
* This option will override what may be configured on a parent level.
- *
- * @param type the canonical name of the class of the input data. Append a {@code []} to the end
- * of the canonical name if you want the input to be an array of {@code type}.
+ * <p/>
+ * The canonical name of the class of the input data. Append a [] to the end of the canonical name
+ * if you want the input to be an array type.
*/
public void setType(String type) {
this.type = type;
@@ -244,10 +243,10 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
/**
* Sets the class name to use for binding from POJO to output for the outgoing data
- * This option will override what may be configured on a parent level.
- *
- * @param outType the canonical name of the class of the output data. Append a {@code []} to the end
- * of the canonical name if you want the output to be an array of {@code outType}.
+ * This option will override what may be configured on a parent level
+ * <p/>
+ * The canonical name of the class of the input data. Append a [] to the end of the canonical name
+ * if you want the input to be an array type.
*/
public void setOutType(String outType) {
this.outType = outType;
@@ -258,7 +257,7 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param routeId the route id this rest-dsl is using (read-only).
+ * The route id this rest-dsl is using (read-only)
*/
public void setRouteId(String routeId) {
this.routeId = routeId;
@@ -269,8 +268,9 @@ public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
}
/**
- * @param apiDocs set to {@code true} to include or exclude the VerbDefinition in API documentation.
- * The default value is true.
+ * Whether to include or exclude the VerbDefinition in API documentation.
+ * <p/>
+ * The default value is true.
*/
public void setApiDocs(Boolean apiDocs) {
this.apiDocs = apiDocs;
[3/3] camel git commit: CAMEL-11021: Add missing docs
Posted by da...@apache.org.
CAMEL-11021: Add missing docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/97f442c6
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/97f442c6
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/97f442c6
Branch: refs/heads/master
Commit: 97f442c6dc2f7928a09fcdb8c8c46706d7df067b
Parents: f9d021a
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 7 10:47:44 2017 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 7 10:47:44 2017 +0200
----------------------------------------------------------------------
.../org/apache/camel/model/RouteDefinition.java | 42 ++++++++++++--------
.../tools/apt/CoreEipAnnotationProcessor.java | 7 +++-
2 files changed, 32 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/97f442c6/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
index 2b4a942..5196da8 100644
--- a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
@@ -48,7 +48,6 @@ import org.apache.camel.model.rest.RestBindingDefinition;
import org.apache.camel.model.rest.RestDefinition;
import org.apache.camel.processor.interceptor.HandleFault;
import org.apache.camel.spi.AsEndpointUri;
-import org.apache.camel.spi.Contract;
import org.apache.camel.spi.LifecycleStrategy;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.RouteContext;
@@ -664,8 +663,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* at runtime, camel look for a required {@link Transformer} and apply if exists.
* The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
* is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
- *
- * @see {@link org.apache.camel.spi.Transformer}
+ *
+ * @see org.apache.camel.spi.Transformer
+ *
* @param urn input type URN
* @return the builder
*/
@@ -682,8 +682,10 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
* The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
* is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
- *
- * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+ *
+ * @see org.apache.camel.spi.Transformer
+ * @see org.apache.camel.spi.Validator
+ *
* @param urn input type URN
* @return the builder
*/
@@ -698,8 +700,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* Declare the expected data type of the input message by Java class.
* If the actual message type is different at runtime, camel look for a required
* {@link Transformer} and apply if exists.
- *
- * @see {@link org.apache.camel.spi.Transformer}
+ *
+ * @see org.apache.camel.spi.Transformer
+ *
* @param clazz Class object of the input type
* @return the builder
*/
@@ -714,8 +717,10 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* Declare the expected data type of the input message by Java class with content validation enabled.
* If the actual message type is different at runtime, camel look for a required
* {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
- *
- * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+ *
+ * @see org.apache.camel.spi.Transformer
+ * @see org.apache.camel.spi.Validator
+ *
* @param clazz Class object of the input type
* @return the builder
*/
@@ -731,8 +736,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* at runtime, camel look for a required {@link Transformer} and apply if exists.
* The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
* is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
- *
- * @see {@link org.apache.camel.spi.Transformer}
+ *
+ * @see org.apache.camel.spi.Transformer
+ *
* @param urn output type URN
* @return the builder
*/
@@ -750,7 +756,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
* is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
*
- * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+ * @see org.apache.camel.spi.Transformer
+ * @see org.apache.camel.spi.Validator
+ *
* @param urn output type URN
* @return the builder
*/
@@ -765,8 +773,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* Declare the expected data type of the output message by Java class.
* If the actual message type is different at runtime, camel look for a required
* {@link Transformer} and apply if exists.
- *
- * @see {@link org.apache.camel.spi.Transformer}
+ *
+ * @see org.apache.camel.spi.Transformer
+ *
* @param clazz Class object of the output type
* @return the builder
*/
@@ -782,7 +791,8 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
* If the actual message type is different at runtime, camel look for a required
* {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
*
- * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+ * @see org.apache.camel.spi.Transformer
+ * @see org.apache.camel.spi.Validator
* @param clazz Class object of the output type
* @return the builder
*/
@@ -906,7 +916,7 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
/**
* Whether security mask for Logging is enabled on this route.
*/
- @XmlAttribute @Metadata(defaultValue = "false")
+ @XmlAttribute
public void setLogMask(String logMask) {
this.logMask = logMask;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/97f442c6/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
----------------------------------------------------------------------
diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
index 07e7bf1..73eb1bf 100644
--- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
+++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
@@ -561,11 +561,16 @@ public class CoreEipAnnotationProcessor {
ep = new EipOption("trace", "Trace", "attribute", "java.lang.String", false, "", docComment, false, false, null, false, null, false);
eipOptions.add(ep);
- // trace
+ // message history
docComment = findJavaDoc(elementUtils, null, "messageHistory", null, classElement, true);
ep = new EipOption("messageHistory", "Message History", "attribute", "java.lang.String", false, "true", docComment, false, false, null, false, null, false);
eipOptions.add(ep);
+ // log mask
+ docComment = findJavaDoc(elementUtils, null, "logMask", null, classElement, true);
+ ep = new EipOption("logMask", "Log Mask", "attribute", "java.lang.String", false, "false", docComment, false, false, null, false, null, false);
+ eipOptions.add(ep);
+
// trace
docComment = findJavaDoc(elementUtils, null, "handleFault", null, classElement, true);
ep = new EipOption("handleFault", "Handle Fault", "attribute", "java.lang.String", false, "", docComment, false, false, null, false, null, false);