Repository: camel Updated Branches: refs/heads/camel-2.15.x 57738f7f1 -> 31cbc3c1c refs/heads/master 3a98dd9d7 -> 14c865cb1
Add component documentation. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/14c865cb Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/14c865cb Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/14c865cb Branch: refs/heads/master Commit: 14c865cb1060e81e6d1e1c6ea449831ae90cdc0b Parents: 3a98dd9 Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Apr 14 17:30:15 2015 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Apr 14 17:45:14 2015 +0200 ---------------------------------------------------------------------- .../camel/component/splunk/SplunkComponent.java | 5 +- .../component/splunk/SplunkConfiguration.java | 105 ++++++++++++++----- .../camel/component/splunk/SplunkEndpoint.java | 2 +- .../component/velocity/VelocityComponent.java | 3 + .../component/velocity/VelocityEndpoint.java | 8 +- .../camel/component/vertx/VertxComponent.java | 9 ++ .../camel/component/vertx/VertxEndpoint.java | 16 +-- 7 files changed, 111 insertions(+), 37 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkComponent.java b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkComponent.java index d0d7039..73a76d7 100644 --- a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkComponent.java +++ b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkComponent.java @@ -43,7 +43,10 @@ public class SplunkComponent extends UriEndpointComponent { return splunkConfigurationFactory; } - public void setSplunkConfigurationFactory(DefaultSplunkConfigurationFactory splunkConfigurationFactory) { + /** + * To use the {@link SplunkConfigurationFactory} + */ + public void setSplunkConfigurationFactory(SplunkConfigurationFactory splunkConfigurationFactory) { this.splunkConfigurationFactory = splunkConfigurationFactory; } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkConfiguration.java ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkConfiguration.java b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkConfiguration.java index 2864310..94132e8 100644 --- a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkConfiguration.java +++ b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkConfiguration.java @@ -26,13 +26,15 @@ import org.apache.camel.util.ObjectHelper; @UriParams public class SplunkConfiguration { + private SplunkConnectionFactory connectionFactory; + @UriPath(description = "Name has no purpose") @Metadata(required = "true") private String name; - @UriParam + @UriParam(defaultValue = "http") private String scheme = Service.DEFAULT_SCHEME; - @UriParam + @UriParam(defaultValue = "localhost") private String host = Service.DEFAULT_HOST; - @UriParam + @UriParam(defaultValue = "8089") private int port = Service.DEFAULT_PORT; @UriParam private String app; @@ -46,34 +48,29 @@ public class SplunkConfiguration { private int connectionTimeout = 5000; @UriParam private boolean useSunHttpsHandler; - @UriParam + + @UriParam(label = "producer") private String index; - @UriParam + @UriParam(label = "producer") private String sourceType; - @UriParam + @UriParam(label = "producer") private String source; - @UriParam + @UriParam(label = "producer") private int tcpReceiverPort; - // consumer properties - @UriParam + @UriParam(label = "consumer") private int count; - @UriParam + @UriParam(label = "consumer") private String search; - @UriParam + @UriParam(label = "consumer") private String savedSearch; - @UriParam + @UriParam(label = "consumer") private String earliestTime; - @UriParam + @UriParam(label = "consumer") private String latestTime; - @UriParam + @UriParam(label = "consumer") private String initEarliestTime; - private SplunkConnectionFactory connectionFactory; - - /** - * Streaming mode sends exchanges as they are received, rather than in a batch - */ - @UriParam + @UriParam(label = "consumer") private Boolean streaming; public String getName() { @@ -88,6 +85,9 @@ public class SplunkConfiguration { return initEarliestTime; } + /** + * Initial start offset of the first search + */ public void setInitEarliestTime(String initEarliestTime) { this.initEarliestTime = initEarliestTime; } @@ -96,6 +96,9 @@ public class SplunkConfiguration { return count; } + /** + * A number that indicates the maximum number of entities to return. + */ public void setCount(int count) { this.count = count; } @@ -104,6 +107,9 @@ public class SplunkConfiguration { return search; } + /** + * The Splunk query to run + */ public void setSearch(String search) { this.search = search; } @@ -112,6 +118,9 @@ public class SplunkConfiguration { return earliestTime; } + /** + * Earliest time of the search time window. + */ public void setEarliestTime(String earliestTime) { this.earliestTime = earliestTime; } @@ -120,6 +129,9 @@ public class SplunkConfiguration { return latestTime; } + /** + * Latest time of the search time window. + */ public void setLatestTime(String latestTime) { this.latestTime = latestTime; } @@ -128,6 +140,9 @@ public class SplunkConfiguration { return tcpReceiverPort; } + /** + * Splunk tcp receiver port + */ public void setTcpReceiverPort(int tcpReceiverPort) { this.tcpReceiverPort = tcpReceiverPort; } @@ -136,6 +151,9 @@ public class SplunkConfiguration { return sourceType; } + /** + * Splunk sourcetype argument + */ public void setSourceType(String sourceType) { this.sourceType = sourceType; } @@ -144,10 +162,16 @@ public class SplunkConfiguration { return source; } + /** + * Splunk source argument + */ public void setSource(String source) { this.source = source; } + /** + * Splunk index to write to + */ public void setIndex(String index) { this.index = index; } @@ -160,6 +184,9 @@ public class SplunkConfiguration { return host; } + /** + * Splunk host. + */ public void setHost(String host) { this.host = host; } @@ -168,6 +195,9 @@ public class SplunkConfiguration { return port; } + /** + * Splunk port + */ public void setPort(int port) { this.port = port; } @@ -176,6 +206,9 @@ public class SplunkConfiguration { return scheme; } + /** + * Splunk scheme + */ public void setScheme(String scheme) { this.scheme = scheme; } @@ -184,6 +217,9 @@ public class SplunkConfiguration { return app; } + /** + * Splunk app + */ public void setApp(String app) { this.app = app; } @@ -192,6 +228,9 @@ public class SplunkConfiguration { return owner; } + /** + * Splunk owner + */ public void setOwner(String owner) { this.owner = owner; } @@ -200,6 +239,9 @@ public class SplunkConfiguration { return username; } + /** + * Username for Splunk + */ public void setUsername(String username) { this.username = username; } @@ -208,15 +250,13 @@ public class SplunkConfiguration { return password; } + /** + * Password for Splunk + */ public void setPassword(String password) { this.password = password; } - /** - * Returns streaming mode. - * <p> - * Streaming mode sends exchanges as they are received, rather than in a batch. - */ public boolean isStreaming() { return streaming != null ? streaming : false; } @@ -225,8 +265,6 @@ public class SplunkConfiguration { * Sets streaming mode. * <p> * Streaming mode sends exchanges as they are received, rather than in a batch. - * - * @param streaming */ public void setStreaming(boolean streaming) { this.streaming = streaming; @@ -236,6 +274,9 @@ public class SplunkConfiguration { return connectionTimeout; } + /** + * Timeout in MS when connecting to Splunk server + */ public void setConnectionTimeout(int timeout) { this.connectionTimeout = timeout; } @@ -244,6 +285,10 @@ public class SplunkConfiguration { return useSunHttpsHandler; } + /** + * Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. + * Can be useful when running in application servers to avoid app. server https handling. + */ public void setUseSunHttpsHandler(boolean useSunHttpsHandler) { this.useSunHttpsHandler = useSunHttpsHandler; } @@ -252,6 +297,9 @@ public class SplunkConfiguration { return this.savedSearch; } + /** + * The name of the query saved in Splunk to run + */ public void setSavedSearch(String savedSearch) { this.savedSearch = savedSearch; } @@ -260,6 +308,9 @@ public class SplunkConfiguration { return connectionFactory != null ? connectionFactory : createDefaultConnectionFactory(); } + /** + * Splunk connection factory. + */ public void setConnectionFactory(SplunkConnectionFactory connectionFactory) { this.connectionFactory = connectionFactory; } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java index 388d02c..a0625fc 100644 --- a/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java +++ b/components/camel-splunk/src/main/java/org/apache/camel/component/splunk/SplunkEndpoint.java @@ -38,9 +38,9 @@ import org.slf4j.LoggerFactory; public class SplunkEndpoint extends ScheduledPollEndpoint { private static final Logger LOG = LoggerFactory.getLogger(SplunkEndpoint.class); + private Service service; @UriParam private SplunkConfiguration configuration; - private Service service; public SplunkEndpoint() { } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityComponent.java b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityComponent.java index 97f3244..3dfd850 100644 --- a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityComponent.java +++ b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityComponent.java @@ -37,6 +37,9 @@ public class VelocityComponent extends UriEndpointComponent { return velocityEngine; } + /** + * To use the {@link VelocityEngine} otherwise a new engine is created + */ public void setVelocityEngine(VelocityEngine velocityEngine) { this.velocityEngine = velocityEngine; } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java index 21e5c54..82d0c65 100644 --- a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java +++ b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java @@ -125,13 +125,14 @@ public class VelocityEndpoint extends ResourceEndpoint { /** * Enables / disables the velocity resource loader cache which is enabled by default - * - * @param loaderCache a flag to enable/disable the cache */ public void setLoaderCache(boolean loaderCache) { this.loaderCache = loaderCache; } + /** + * Character encoding of the resource content. + */ public void setEncoding(String encoding) { this.encoding = encoding; } @@ -140,6 +141,9 @@ public class VelocityEndpoint extends ResourceEndpoint { return encoding; } + /** + * The URI of the properties file which is used for VelocityEngine initialization. + */ public void setPropertiesFile(String file) { propertiesFile = file; } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxComponent.java b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxComponent.java index 8b2352a..f7b0c61 100644 --- a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxComponent.java +++ b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxComponent.java @@ -56,6 +56,9 @@ public class VertxComponent extends UriEndpointComponent implements EndpointComp return host; } + /** + * Hostname for creating an embedded clustered EventBus + */ public void setHost(String host) { this.host = host; } @@ -64,6 +67,9 @@ public class VertxComponent extends UriEndpointComponent implements EndpointComp return port; } + /** + * Port for creating an embedded clustered EventBus + */ public void setPort(int port) { this.port = port; } @@ -72,6 +78,9 @@ public class VertxComponent extends UriEndpointComponent implements EndpointComp return vertx; } + /** + * To use the given vertx EventBus instead of creating a new embedded EventBus + */ public void setVertx(Vertx vertx) { this.vertx = vertx; } http://git-wip-us.apache.org/repos/asf/camel/blob/14c865cb/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java index 7f29eb5..b116107 100644 --- a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java +++ b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java @@ -78,6 +78,13 @@ public class VertxEndpoint extends DefaultEndpoint { return address; } + /** + * Sets the event bus address used to communicate + */ + public void setAddress(String address) { + this.address = address; + } + public boolean isPubSub() { return pubSub != null && pubSub; } @@ -86,14 +93,11 @@ public class VertxEndpoint extends DefaultEndpoint { return pubSub; } + /** + * Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. + */ public void setPubSub(Boolean pubSub) { this.pubSub = pubSub; } - /** - * Sets the event bus address used to communicate - */ - public void setAddress(String address) { - this.address = address; - } }
