Repository: camel Updated Branches: refs/heads/master e3b63706d -> 65b7a5ce2
CAMEL-10037: ServiceCall EIP - Add missing documentation Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/65b7a5ce Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/65b7a5ce Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/65b7a5ce Branch: refs/heads/master Commit: 65b7a5ce2e48ad868a12c84668f073b2ff28f538 Parents: e3b6370 Author: lburgazzoli <[email protected]> Authored: Tue Jun 14 13:53:36 2016 +0200 Committer: lburgazzoli <[email protected]> Committed: Tue Jun 14 14:12:23 2016 +0200 ---------------------------------------------------------------------- .../remote/ConsulConfigurationDefinition.java | 27 ++++++++++++++++++++ .../remote/DnsConfigurationDefinition.java | 9 +++++-- .../remote/EtcdConfigurationDefinition.java | 15 +++++++++++ .../ServiceCallConfigurationDefinition.java | 13 ++++++++++ .../model/remote/ServiceCallDefinition.java | 9 +++++++ 5 files changed, 71 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/65b7a5ce/camel-core/src/main/java/org/apache/camel/model/remote/ConsulConfigurationDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/remote/ConsulConfigurationDefinition.java b/camel-core/src/main/java/org/apache/camel/model/remote/ConsulConfigurationDefinition.java index f7174a4..7128d3f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/remote/ConsulConfigurationDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/remote/ConsulConfigurationDefinition.java @@ -138,46 +138,73 @@ public class ConsulConfigurationDefinition extends ServiceCallConfigurationDefin // Fluent API // ------------------------------------------------------------------------- + /** + * The Consul agent URL + */ public ConsulConfigurationDefinition url(String url) { setUrl(url); return this; } + /** + * The data center + */ public ConsulConfigurationDefinition dc(String dc) { setDc(dc); return this; } + /** + * Sets the ACL token to be used with Consul + */ public ConsulConfigurationDefinition aclToken(String aclToken) { setAclToken(aclToken); return this; } + /** + * Sets the username to be used for basic authentication + */ public ConsulConfigurationDefinition userName(String userName) { setUserName(userName); return this; } + /** + * Sets the password to be used for basic authentication + */ public ConsulConfigurationDefinition password(String password) { setPassword(password); return this; } + /** + * Connect timeout for OkHttpClient + */ public ConsulConfigurationDefinition connectTimeoutMillis(Long connectTimeoutMillis) { setConnectTimeoutMillis(connectTimeoutMillis); return this; } + /** + * Read timeout for OkHttpClient + */ public ConsulConfigurationDefinition readTimeoutMillis(Long readTimeoutMillis) { setReadTimeoutMillis(readTimeoutMillis); return this; } + /** + * Write timeout for OkHttpClient + */ public ConsulConfigurationDefinition writeTimeoutMillis(Long writeTimeoutMillis) { setWriteTimeoutMillis(writeTimeoutMillis); return this; } + /** + * The second to wait for a watch event, default 10 seconds + */ public ConsulConfigurationDefinition blockSeconds(Integer blockSeconds) { setBlockSeconds(blockSeconds); return this; http://git-wip-us.apache.org/repos/asf/camel/blob/65b7a5ce/camel-core/src/main/java/org/apache/camel/model/remote/DnsConfigurationDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/remote/DnsConfigurationDefinition.java b/camel-core/src/main/java/org/apache/camel/model/remote/DnsConfigurationDefinition.java index 9af18a3..7075ced 100644 --- a/camel-core/src/main/java/org/apache/camel/model/remote/DnsConfigurationDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/remote/DnsConfigurationDefinition.java @@ -65,16 +65,21 @@ public class DnsConfigurationDefinition extends ServiceCallConfigurationDefiniti this.domain = domain; } - // ------------------------------------------------------------------------- // Fluent API // ------------------------------------------------------------------------- - + + /** + * The transport protocol of the desired service. + */ public DnsConfigurationDefinition proto(String proto) { setProto(proto); return this; } + /** + * The domain name; + */ public DnsConfigurationDefinition domain(String domain) { setDomain(domain); return this; http://git-wip-us.apache.org/repos/asf/camel/blob/65b7a5ce/camel-core/src/main/java/org/apache/camel/model/remote/EtcdConfigurationDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/remote/EtcdConfigurationDefinition.java b/camel-core/src/main/java/org/apache/camel/model/remote/EtcdConfigurationDefinition.java index 1edd5f0..21599b3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/remote/EtcdConfigurationDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/remote/EtcdConfigurationDefinition.java @@ -98,26 +98,41 @@ public class EtcdConfigurationDefinition extends ServiceCallConfigurationDefinit // Fluent API // ------------------------------------------------------------------------- + /** + * The URIs the client can connect to. + */ public EtcdConfigurationDefinition uris(String uris) { setUris(uris); return this; } + /** + * The user name to use for basic authentication. + */ public EtcdConfigurationDefinition userName(String userName) { setUserName(userName); return this; } + /** + * The password to use for basic authentication. + */ public EtcdConfigurationDefinition password(String password) { setPassword(password); return this; } + /** + * To set the maximum time an action could take to complete. + */ public EtcdConfigurationDefinition timeout(Long timeout) { setTimeout(timeout); return this; } + /** + * The path to look for for service discovery + */ public EtcdConfigurationDefinition servicePath(String servicePath) { setServicePath(servicePath); return this; http://git-wip-us.apache.org/repos/asf/camel/blob/65b7a5ce/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallConfigurationDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallConfigurationDefinition.java b/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallConfigurationDefinition.java index 562e0df..9fe5ea9 100644 --- a/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallConfigurationDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallConfigurationDefinition.java @@ -85,6 +85,9 @@ public abstract class ServiceCallConfigurationDefinition extends IdentifiedType return loadBalancerRef; } + /** + * Sets a reference to a custom {@link org.apache.camel.spi.ServiceCallLoadBalancer} to use. + */ public void setLoadBalancerRef(String loadBalancerRef) { this.loadBalancerRef = loadBalancerRef; } @@ -101,6 +104,9 @@ public abstract class ServiceCallConfigurationDefinition extends IdentifiedType return serverListStrategyRef; } + /** + * Sets a reference to a custom {@link org.apache.camel.spi.ServiceCallServerListStrategy} to use. + */ public void setServerListStrategyRef(String serverListStrategyRef) { this.serverListStrategyRef = serverListStrategyRef; } @@ -117,6 +123,13 @@ public abstract class ServiceCallConfigurationDefinition extends IdentifiedType return properties; } + /** + * Set client properties to use. + * <p/> + * These properties are specific to what service call implementation are in + * use. For example if using ribbon, then the client properties are define + * in com.netflix.client.config.CommonClientConfigKey. + */ public void setProperties(List<PropertyDefinition> properties) { this.properties = properties; } http://git-wip-us.apache.org/repos/asf/camel/blob/65b7a5ce/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallDefinition.java b/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallDefinition.java index 131f881..7766250 100644 --- a/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/remote/ServiceCallDefinition.java @@ -233,6 +233,9 @@ public class ServiceCallDefinition extends NoOutputDefinition<ServiceCallDefinit return serviceCallConfigurationRef; } + /** + * Refers to a ServiceCall configuration to use + */ public void setServiceCallConfigurationRef(String serviceCallConfigurationRef) { this.serviceCallConfigurationRef = serviceCallConfigurationRef; } @@ -253,6 +256,9 @@ public class ServiceCallDefinition extends NoOutputDefinition<ServiceCallDefinit return loadBalancerRef; } + /** + * Sets a reference to a custom {@link org.apache.camel.spi.ServiceCallLoadBalancer} to use. + */ public void setLoadBalancerRef(String loadBalancerRef) { this.loadBalancerRef = loadBalancerRef; } @@ -269,6 +275,9 @@ public class ServiceCallDefinition extends NoOutputDefinition<ServiceCallDefinit return serverListStrategyRef; } + /** + * Sets a reference to a custom {@link org.apache.camel.spi.ServiceCallServerListStrategy} to use. + */ public void setServerListStrategyRef(String serverListStrategyRef) { this.serverListStrategyRef = serverListStrategyRef; }
