camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [1/2] camel git commit: Component doc
Date Fri, 24 Apr 2015 13:13:19 GMT
Repository: camel
Updated Branches:
  refs/heads/master c57a42a56 -> 774860517


Component doc


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

Branch: refs/heads/master
Commit: e66df5f26cf315bbc9efd8c35fa45905b3b827f5
Parents: c57a42a
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Fri Apr 24 15:06:40 2015 +0200
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Fri Apr 24 15:06:40 2015 +0200

----------------------------------------------------------------------
 .../component/dropbox/DropboxConfiguration.java | 33 ++++++++++++++++++--
 .../apache/camel/component/rmi/RmiEndpoint.java | 12 +++++--
 .../component/weather/WeatherConfiguration.java | 26 +++++++++++++++
 3 files changed, 66 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/e66df5f2/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxConfiguration.java
b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxConfiguration.java
index 2c9c842..4c3a2a5 100755
--- a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxConfiguration.java
+++ b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxConfiguration.java
@@ -35,7 +35,7 @@ public class DropboxConfiguration {
     @UriPath @Metadata(required = "true")
     private DropboxOperation operation;
     //dropbox auth options
-    @UriParam
+    @UriParam @Metadata(required = "true")
     private String accessToken;
     //local path to put files
     @UriParam
@@ -53,12 +53,15 @@ public class DropboxConfiguration {
     @UriParam
     private DropboxUploadMode uploadMode;
     //id of the app
-    @UriParam
+    @UriParam @Metadata(required = "true")
     private String clientIdentifier;
     //reference to dropboxclient
     @UriParam
     private DbxClient client;
 
+    /**
+     * To use an existing DbxClient instance as DropBox client.
+     */
     public void setClient(DbxClient client) {
         this.client = client;
     }
@@ -80,6 +83,9 @@ public class DropboxConfiguration {
         return accessToken;
     }
 
+    /**
+     * The access token to make API requests for a specific Dropbox user
+     */
     public void setAccessToken(String accessToken) {
         this.accessToken = accessToken;
     }
@@ -88,6 +94,9 @@ public class DropboxConfiguration {
         return localPath;
     }
 
+    /**
+     * Folder or file to upload on Dropbox from the local filesystem.
+     */
     public void setLocalPath(String localPath) {
         this.localPath = localPath;
     }
@@ -96,6 +105,9 @@ public class DropboxConfiguration {
         return remotePath;
     }
 
+    /**
+     * Original file or folder to move
+     */
     public void setRemotePath(String remotePath) {
         this.remotePath = remotePath;
     }
@@ -104,6 +116,9 @@ public class DropboxConfiguration {
         return newRemotePath;
     }
 
+    /**
+     * Destination file or folder
+     */
     public void setNewRemotePath(String newRemotePath) {
         this.newRemotePath = newRemotePath;
     }
@@ -112,6 +127,9 @@ public class DropboxConfiguration {
         return query;
     }
 
+    /**
+     * A space-separated list of substrings to search for. A file matches only if it contains
all the substrings. If this option is not set, all files will be matched.
+     */
     public void setQuery(String query) {
         this.query = query;
     }
@@ -120,6 +138,9 @@ public class DropboxConfiguration {
         return clientIdentifier;
     }
 
+    /**
+     * Name of the app registered to make API requests
+     */
     public void setClientIdentifier(String clientIdentifier) {
         this.clientIdentifier = clientIdentifier;
     }
@@ -128,6 +149,9 @@ public class DropboxConfiguration {
         return operation;
     }
 
+    /**
+     * The specific action (typically is a CRUD action) to perform on Dropbox remote folder.
+     */
     public void setOperation(DropboxOperation operation) {
         this.operation = operation;
     }
@@ -136,6 +160,11 @@ public class DropboxConfiguration {
         return uploadMode;
     }
 
+    /**
+     * Which mode to upload.
+     * in case of "add" the new file will be renamed if a file with the same name already
exists on dropbox.
+     * in case of "force" if a file with the same name already exists on dropbox, this will
be overwritten.
+     */
     public void setUploadMode(DropboxUploadMode uploadMode) {
         this.uploadMode = uploadMode;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/e66df5f2/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
index 51610fb..8c61fa9 100644
--- a/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
+++ b/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiEndpoint.java
@@ -43,11 +43,11 @@ public class RmiEndpoint extends DefaultEndpoint {
     private ClassLoader classLoader;
     private URI uri;
 
-    @UriPath(defaultValue = "localhost")
+    @UriPath(description = "Hostname of RMI server", defaultValue = "localhost")
     private String hostname;
-    @UriPath(defaultValue = "" + Registry.REGISTRY_PORT)
+    @UriPath(description = "Port number of RMI server", defaultValue = "" + Registry.REGISTRY_PORT)
     private int port;
-    @UriPath @Metadata(required = "true")
+    @UriPath(description = "Name to use when binding to RMI server") @Metadata(required =
"true")
     private String name;
     @UriParam
     private List<Class<?>> remoteInterfaces;
@@ -120,6 +120,9 @@ public class RmiEndpoint extends DefaultEndpoint {
         return remoteInterfaces;
     }
 
+    /**
+     * To specific the remote interfaces.
+     */
     public void setRemoteInterfaces(List<Class<?>> remoteInterfaces) {
         this.remoteInterfaces = remoteInterfaces;
         if (classLoader == null && !remoteInterfaces.isEmpty()) {
@@ -151,6 +154,9 @@ public class RmiEndpoint extends DefaultEndpoint {
         return method;
     }
 
+    /**
+     * You can set the name of the method to invoke.
+     */
     public void setMethod(String method) {
         this.method = method;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/e66df5f2/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherConfiguration.java
b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherConfiguration.java
index 2c9d3ef..c77f5f1 100644
--- a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherConfiguration.java
+++ b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherConfiguration.java
@@ -61,6 +61,10 @@ public class WeatherConfiguration {
         return period;
     }
 
+    /**
+     * If null, the current weather will be returned, else use values of 5, 7, 14 days.
+     * Only the numeric value for the forecast period is actually parsed, so spelling, capitalisation
of the time period is up to you (its ignored)
+     */
     public void setPeriod(String period) {
         notNull(period, "period");
         int result = 0;
@@ -86,6 +90,9 @@ public class WeatherConfiguration {
         return mode;
     }
 
+    /**
+     * The output format of the weather data.
+     */
     public void setMode(WeatherMode mode) {
         this.mode = notNull(mode, "mode");
     }
@@ -94,6 +101,9 @@ public class WeatherConfiguration {
         return units;
     }
 
+    /**
+     * The units for temperature measurement.
+     */
     public void setUnits(WeatherUnits units) {
         this.units = notNull(units, "units");
     }
@@ -102,6 +112,13 @@ public class WeatherConfiguration {
         return location;
     }
 
+    /**
+     * If null Camel will try and determine your current location using the geolocation of
your ip address,
+     * else specify the city,country. For well known city names, Open Weather Map will determine
the best fit,
+     * but multiple results may be returned. Hence specifying and country as well will return
more accurate data.
+     * If you specify "current" as the location then the component will try to get the current
latitude and longitude
+     * and use that to get the weather details. You can use lat and lon options instead of
location.
+     */
     public void setLocation(String location) {
         this.location = location;
     }
@@ -110,6 +127,9 @@ public class WeatherConfiguration {
         return headerName;
     }
 
+    /**
+     * To store the weather result in this header instead of the message body. This is useable
if you want to keep current message body as-is.
+     */
     public void setHeaderName(String headerName) {
         this.headerName = headerName;
     }
@@ -118,6 +138,9 @@ public class WeatherConfiguration {
         return lat;
     }
 
+    /**
+     * Latitude of location. You can use lat and lon options instead of location.
+     */
     public void setLat(String lat) {
         this.lat = lat;
     }
@@ -126,6 +149,9 @@ public class WeatherConfiguration {
         return lon;
     }
 
+    /**
+     * Longitude of location. You can use lat and lon options instead of location.
+     */
     public void setLon(String lon) {
         this.lon = lon;
     }


Mime
View raw message