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 2015/04/23 16:56:04 UTC

camel git commit: Component doc

Repository: camel
Updated Branches:
  refs/heads/master 4118be401 -> 56823320c


Component doc


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/56823320
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/56823320
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/56823320

Branch: refs/heads/master
Commit: 56823320c21edf4e569623d7ecfd0c5dbc5dc910
Parents: 4118be4
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Apr 23 16:59:22 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Apr 23 16:59:22 2015 +0200

----------------------------------------------------------------------
 .../camel/component/docker/DockerComponent.java |  6 +++
 .../component/docker/DockerConfiguration.java   | 44 ++++++++++++++++++--
 2 files changed, 47 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/56823320/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerComponent.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerComponent.java
index 35f641d..3f0cef2 100644
--- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerComponent.java
+++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerComponent.java
@@ -70,6 +70,9 @@ public class DockerComponent extends DefaultComponent {
         this.configuration = configuration;
     }
 
+    /**
+     * To use the shared docker configuration
+     */
     protected DockerConfiguration getConfiguration() {
         return configuration;
     }
@@ -78,6 +81,9 @@ public class DockerComponent extends DefaultComponent {
         return clients.get(clientProfile);
     }
 
+    /**
+     * To use the given docker client
+     */
     public void setClient(DockerClientProfile clientProfile, DockerClient client) {
         clients.put(clientProfile, client);
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/56823320/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
index c1434e6..af1a32c 100644
--- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
+++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
@@ -31,10 +31,10 @@ public class DockerConfiguration implements Cloneable {
     @UriPath @Metadata(required = "true")
     private DockerOperation operation;
 
-    @UriParam(defaultValue = "localhost")
+    @UriParam(defaultValue = "localhost") @Metadata(required = "true")
     private String host = "localhost";
 
-    @UriParam(defaultValue = "2375")
+    @UriParam(defaultValue = "2375") @Metadata(required = "true")
     private Integer port = 2375;
 
     @UriParam
@@ -70,6 +70,9 @@ public class DockerConfiguration implements Cloneable {
         return host;
     }
 
+    /**
+     * Docker host
+     */
     public void setHost(String host) {
         this.host = host;
     }
@@ -78,6 +81,9 @@ public class DockerConfiguration implements Cloneable {
         return port;
     }
 
+    /**
+     * Docker port
+     */
     public void setPort(Integer port) {
         this.port = port;
     }
@@ -86,6 +92,9 @@ public class DockerConfiguration implements Cloneable {
         return username;
     }
 
+    /**
+     * User name to authenticate with
+     */
     public void setUsername(String username) {
         this.username = username;
     }
@@ -94,6 +103,9 @@ public class DockerConfiguration implements Cloneable {
         return password;
     }
 
+    /**
+     * Password to authenticate with
+     */
     public void setPassword(String password) {
         this.password = password;
     }
@@ -102,6 +114,9 @@ public class DockerConfiguration implements Cloneable {
         return email;
     }
 
+    /**
+     * Email address associated with the user
+     */
     public void setEmail(String email) {
         this.email = email;
     }
@@ -110,6 +125,9 @@ public class DockerConfiguration implements Cloneable {
         return serverAddress;
     }
 
+    /**
+     * Server address for docker registry.
+     */
     public void setServerAddress(String serverAddress) {
         this.serverAddress = serverAddress;
     }
@@ -118,6 +136,9 @@ public class DockerConfiguration implements Cloneable {
         return requestTimeout;
     }
 
+    /**
+     * Request timeout for response (in seconds)
+     */
     public void setRequestTimeout(Integer requestTimeout) {
         this.requestTimeout = requestTimeout;
     }
@@ -126,6 +147,9 @@ public class DockerConfiguration implements Cloneable {
         return secure;
     }
 
+    /**
+     * Use HTTPS communication
+     */
     public void setSecure(Boolean secure) {
         this.secure = secure;
     }
@@ -134,6 +158,9 @@ public class DockerConfiguration implements Cloneable {
         return certPath;
     }
 
+    /**
+     * Location containing the SSL certificate chain
+     */
     public void setCertPath(String certPath) {
         this.certPath = certPath;
     }
@@ -142,6 +169,9 @@ public class DockerConfiguration implements Cloneable {
         return maxTotalConnections;
     }
 
+    /**
+     * Maximum total connections
+     */
     public void setMaxTotalConnections(Integer maxTotalConnections) {
         this.maxTotalConnections = maxTotalConnections;
     }
@@ -150,15 +180,20 @@ public class DockerConfiguration implements Cloneable {
         return maxPerRouteConnections;
     }
 
+    /**
+     * Maximum route connections
+     */
     public void setMaxPerRouteConnections(Integer maxPerRouteConnections) {
         this.maxPerRouteConnections = maxPerRouteConnections;
     }
 
-
     public Map<String, Object> getParameters() {
         return parameters;
     }
 
+    /**
+     * Additional configuration parameters as key/value pairs
+     */
     public void setParameters(Map<String, Object> parameters) {
         this.parameters = parameters;
     }
@@ -167,6 +202,9 @@ public class DockerConfiguration implements Cloneable {
         return operation;
     }
 
+    /**
+     * Which operation to use
+     */
     public void setOperation(DockerOperation operation) {
         this.operation = operation;
     }