camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject camel git commit: Component docs
Date Mon, 27 Apr 2015 08:33:48 GMT
Repository: camel
Updated Branches:
  refs/heads/master 4f0feb7a2 -> fe823e345


Component docs


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

Branch: refs/heads/master
Commit: fe823e345c185ad4e46fe74afa5353f13e81b146
Parents: 4f0feb7
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Mon Apr 27 10:36:12 2015 +0200
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Mon Apr 27 10:36:12 2015 +0200

----------------------------------------------------------------------
 .../camel/component/irc/IrcComponent.java       |  2 +-
 .../camel/component/irc/IrcConfiguration.java   | 70 +++++++++++++++++++-
 .../camel/component/ldap/LdapEndpoint.java      | 27 +++++---
 3 files changed, 88 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/fe823e34/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcComponent.java
b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcComponent.java
index edf4dc0..1c2b09e 100644
--- a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcComponent.java
+++ b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcComponent.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
  */
 public class IrcComponent extends UriEndpointComponent {
     private static final Logger LOG = LoggerFactory.getLogger(IrcComponent.class);
-    private final Map<String, IRCConnection> connectionCache = new HashMap<String,
IRCConnection>();
+    private final transient Map<String, IRCConnection> connectionCache = new HashMap<String,
IRCConnection>();
 
     public IrcComponent() {
         super(IrcEndpoint.class);

http://git-wip-us.apache.org/repos/asf/camel/blob/fe823e34/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcConfiguration.java
b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcConfiguration.java
index 0a71a27..7a214d7 100644
--- a/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcConfiguration.java
+++ b/components/camel-irc/src/main/java/org/apache/camel/component/irc/IrcConfiguration.java
@@ -46,7 +46,7 @@ public class IrcConfiguration implements Cloneable {
     private List<IrcChannel> channels = new ArrayList<IrcChannel>();
     @UriPath @Metadata(required = "true")
     private String hostname;
-    @UriPath
+    @UriPath(defaultValue = "6667,6668,6669")
     private int port;
     private int[] ports = {6667, 6668, 6669};
     @UriParam
@@ -197,6 +197,9 @@ public class IrcConfiguration implements Cloneable {
         return null;
     }
 
+    /**
+     * The trust manager used to verify the SSL server's certificate.
+     */
     public void setTrustManager(SSLTrustManager trustManager) {
         this.trustManager = trustManager;
     }
@@ -217,6 +220,9 @@ public class IrcConfiguration implements Cloneable {
         return hostname;
     }
 
+    /**
+     * Hostname for the IRC chat server
+     */
     public void setHostname(String hostname) {
         this.hostname = hostname;
     }
@@ -225,6 +231,9 @@ public class IrcConfiguration implements Cloneable {
         return password;
     }
 
+    /**
+     * The IRC server password.
+     */
     public void setPassword(String password) {
         this.password = password;
     }
@@ -233,6 +242,9 @@ public class IrcConfiguration implements Cloneable {
         return nickname;
     }
 
+    /**
+     * The nickname used in chat.
+     */
     public void setNickname(String nickname) {
         this.nickname = nickname;
     }
@@ -241,6 +253,9 @@ public class IrcConfiguration implements Cloneable {
         return realname;
     }
 
+    /**
+     * The IRC user's actual name.
+     */
     public void setRealname(String realname) {
         this.realname = realname;
     }
@@ -249,6 +264,9 @@ public class IrcConfiguration implements Cloneable {
         return username;
     }
 
+    /**
+     * The IRC server user name.
+     */
     public void setUsername(String username) {
         this.username = username;
     }
@@ -257,6 +275,9 @@ public class IrcConfiguration implements Cloneable {
         return ports;
     }
 
+    /**
+     * Port numbers for the IRC chat server
+     */
     public void setPorts(int[] ports) {
         this.ports = ports;
     }
@@ -265,6 +286,9 @@ public class IrcConfiguration implements Cloneable {
         return port;
     }
 
+    /**
+     * Port number for the IRC chat server
+     */
     public void setPort(int port) {
         this.port = port;
     }
@@ -273,6 +297,11 @@ public class IrcConfiguration implements Cloneable {
         return persistent;
     }
 
+    /**
+     * Use persistent messages.
+     * @deprecated not in use
+     */
+    @Deprecated
     public void setPersistent(boolean persistent) {
         this.persistent = persistent;
     }
@@ -281,6 +310,9 @@ public class IrcConfiguration implements Cloneable {
         return colors;
     }
 
+    /**
+     * Whether or not the server supports color codes.
+     */
     public void setColors(boolean colors) {
         this.colors = colors;
     }
@@ -289,6 +321,9 @@ public class IrcConfiguration implements Cloneable {
         return onNick;
     }
 
+    /**
+     * Handle nickname change events.
+     */
     public void setOnNick(boolean onNick) {
         this.onNick = onNick;
     }
@@ -297,6 +332,9 @@ public class IrcConfiguration implements Cloneable {
         return onQuit;
     }
 
+    /**
+     * Handle user quit events.
+     */
     public void setOnQuit(boolean onQuit) {
         this.onQuit = onQuit;
     }
@@ -305,6 +343,9 @@ public class IrcConfiguration implements Cloneable {
         return onJoin;
     }
 
+    /**
+     * Handle user join events.
+     */
     public void setOnJoin(boolean onJoin) {
         this.onJoin = onJoin;
     }
@@ -313,6 +354,9 @@ public class IrcConfiguration implements Cloneable {
         return onKick;
     }
 
+    /**
+     * Handle kick events.
+     */
     public void setOnKick(boolean onKick) {
         this.onKick = onKick;
     }
@@ -321,6 +365,9 @@ public class IrcConfiguration implements Cloneable {
         return onMode;
     }
 
+    /**
+     * Handle mode change events.
+     */
     public void setOnMode(boolean onMode) {
         this.onMode = onMode;
     }
@@ -329,6 +376,9 @@ public class IrcConfiguration implements Cloneable {
         return onPart;
     }
 
+    /**
+     * Handle user part events.
+     */
     public void setOnPart(boolean onPart) {
         this.onPart = onPart;
     }
@@ -337,6 +387,9 @@ public class IrcConfiguration implements Cloneable {
         return onReply;
     }
 
+    /**
+     * Whether or not to handle general responses to commands or informational messages.
+     */
     public void setOnReply(boolean onReply) {
         this.onReply = onReply;
     }
@@ -345,6 +398,9 @@ public class IrcConfiguration implements Cloneable {
         return onTopic;
     }
 
+    /**
+     * Handle topic change events.
+     */
     public void setOnTopic(boolean onTopic) {
         this.onTopic = onTopic;
     }
@@ -353,6 +409,9 @@ public class IrcConfiguration implements Cloneable {
         return onPrivmsg;
     }
 
+    /**
+     * Handle private message events.
+     */
     public void setOnPrivmsg(boolean onPrivmsg) {
         this.onPrivmsg = onPrivmsg;
     }
@@ -361,6 +420,9 @@ public class IrcConfiguration implements Cloneable {
         return autoRejoin;
     }
 
+    /**
+     * Whether to auto re-join when being kicked
+     */
     public void setAutoRejoin(boolean autoRejoin) {
         this.autoRejoin = autoRejoin;
     }
@@ -369,6 +431,12 @@ public class IrcConfiguration implements Cloneable {
         return sslContextParameters;
     }
 
+    /**
+     * Used for configuring security using SSL.
+     * Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry.
+     * This reference overrides any configured SSLContextParameters at the component level.
+     * Note that this setting overrides the trustManager option.
+     */
     public void setSslContextParameters(SSLContextParameters sslContextParameters) {
         this.sslContextParameters = sslContextParameters;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/fe823e34/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
index 61a5fda..f8ed247 100644
--- a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
+++ b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java
@@ -43,7 +43,7 @@ public class LdapEndpoint extends DefaultEndpoint {
     private String dirContextName;
     @UriParam(defaultValue = SYSTEM_DN)
     private String base = SYSTEM_DN;
-    @UriParam(defaultValue = SUBTREE_SCOPE)
+    @UriParam(defaultValue = SUBTREE_SCOPE, enums = "object,onelevel,subtree")
     private String scope = SUBTREE_SCOPE;
     @UriParam
     private Integer pageSize;
@@ -84,14 +84,25 @@ public class LdapEndpoint extends DefaultEndpoint {
         this.dirContextName = dirContextName;
     }
 
+    /**
+     * When specified the ldap module uses paging to retrieve all results (most LDAP Servers
throw an exception when trying to retrieve more than 1000 entries in one query).
+     * To be able to use this a LdapContext (subclass of DirContext) has to be passed in
as ldapServerBean (otherwise an exception is thrown)
+     */
     public void setPageSize(Integer pageSize) {
         this.pageSize = pageSize;
     }
 
+    public int getPageSize() {
+        return pageSize;
+    }
+
     public String getBase() {
         return base;
     }
 
+    /**
+     * The base DN for searches.
+     */
     public void setBase(String base) {
         this.base = base;
     }
@@ -100,22 +111,20 @@ public class LdapEndpoint extends DefaultEndpoint {
         return scope;
     }
 
+    /**
+     * Specifies how deeply to search the tree of entries, starting at the base DN.
+     */
     public void setScope(String scope) {
         this.scope = scope;
     }
 
-    public int getPageSize() {
-        return pageSize;
-    }
-
-    public void setPageSize(int pageSize) {
-        this.pageSize = pageSize;
-    }
-
     public String getReturnedAttributes() {
         return returnedAttributes;
     }
 
+    /**
+     * Comma-separated list of attributes that should be set in each entry of the result
+     */
     public void setReturnedAttributes(String returnedAttributes) {
         this.returnedAttributes = returnedAttributes;
     }


Mime
View raw message