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/28 08:07:45 UTC
[5/5] camel git commit: Component docs
Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9dd120a5
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9dd120a5
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9dd120a5
Branch: refs/heads/master
Commit: 9dd120a53914fa169796181f005cf9822a91535d
Parents: aff019f
Author: Claus Ibsen <da...@apache.org>
Authored: Tue Apr 28 08:10:46 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Tue Apr 28 08:10:46 2015 +0200
----------------------------------------------------------------------
.../component/javaspace/JavaSpaceComponent.java | 2 +-
.../component/javaspace/JavaSpaceEndpoint.java | 80 +++++++++++---------
2 files changed, 44 insertions(+), 38 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9dd120a5/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceComponent.java b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceComponent.java
index cea22a0..69849f3 100644
--- a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceComponent.java
+++ b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceComponent.java
@@ -40,7 +40,7 @@ public class JavaSpaceComponent extends UriEndpointComponent {
@Override
protected Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception {
- JavaSpaceEndpoint endpoint = new JavaSpaceEndpoint(uri, remaining, parameters, this);
+ JavaSpaceEndpoint endpoint = new JavaSpaceEndpoint(uri, remaining, this);
endpoint.setExchangePattern(ExchangePattern.InOnly);
return endpoint;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/9dd120a5/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
index 4b9e6ff..f05d882 100644
--- a/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
+++ b/components/camel-javaspace/src/main/java/org/apache/camel/component/javaspace/JavaSpaceEndpoint.java
@@ -34,43 +34,30 @@ import org.apache.camel.spi.UriPath;
@UriEndpoint(scheme = "javaspace", title = "JavaSpace", syntax = "javaspace:url", consumerClass = JavaSpaceConsumer.class, label = "messaging")
public class JavaSpaceEndpoint extends DefaultEndpoint {
- private final Map<?, ?> parameters;
-
@UriPath @Metadata(required = "true")
private final String url;
- @UriParam(defaultValue = "1")
- private int concurrentConsumers = 1;
- @UriParam
+ @UriParam @Metadata(required = "true")
private String spaceName;
+ @UriParam(label = "consumer", defaultValue = "1")
+ private int concurrentConsumers = 1;
+ @UriParam(label = "consumer", defaultValue = "take", enums = "take,read")
+ private String verb = "take";
+ @UriParam(label = "consumer")
+ private String templateId;
@UriParam
private boolean transactional;
@UriParam
private long transactionTimeout = Long.MAX_VALUE;
- @UriParam(defaultValue = "take")
- private String verb = "take";
- @UriParam
- private String templateId;
- public JavaSpaceEndpoint(String endpointUri, String remaining, Map<?, ?> parameters, JavaSpaceComponent component) {
+ public JavaSpaceEndpoint(String endpointUri, String remaining, JavaSpaceComponent component) {
super(endpointUri, component);
this.url = remaining;
- this.parameters = parameters;
- }
-
- public boolean isTransactional() {
- return transactional;
}
- public String getVerb() {
- return verb;
- }
-
- public void setVerb(String verb) {
- this.verb = verb;
- }
-
- public void setTransactional(boolean transactional) {
- this.transactional = transactional;
+ public Consumer createConsumer(Processor processor) throws Exception {
+ JavaSpaceConsumer answer = new JavaSpaceConsumer(this, processor);
+ configureConsumer(answer);
+ return answer;
}
public Producer createProducer() throws Exception {
@@ -86,28 +73,38 @@ public class JavaSpaceEndpoint extends DefaultEndpoint {
return true;
}
+ public String getVerb() {
+ return verb;
+ }
+
/**
- * @deprecated use {@link #getUrl()}
+ * Specifies the verb for getting JavaSpace entries.
*/
- @Deprecated
- public String getRemaining() {
- return url;
+ public void setVerb(String verb) {
+ this.verb = verb;
}
- public String getUrl() {
- return url;
+ public boolean isTransactional() {
+ return transactional;
}
- public Map<?, ?> getParameters() {
- return parameters;
+ /**
+ * If true, sending and receiving entries is performed within a transaction.
+ */
+ public void setTransactional(boolean transactional) {
+ this.transactional = transactional;
}
- public Consumer createConsumer(Processor processor) throws Exception {
- JavaSpaceConsumer answer = new JavaSpaceConsumer(this, processor);
- configureConsumer(answer);
- return answer;
+ /**
+ * The URL to the JavaSpace server
+ */
+ public String getUrl() {
+ return url;
}
+ /**
+ * Specifies the number of concurrent consumers getting entries from the JavaSpace.
+ */
public void setConcurrentConsumers(int concurrentConsumers) {
this.concurrentConsumers = concurrentConsumers;
}
@@ -120,6 +117,9 @@ public class JavaSpaceEndpoint extends DefaultEndpoint {
return spaceName;
}
+ /**
+ * Specifies the JavaSpace name.
+ */
public void setSpaceName(String spaceName) {
this.spaceName = spaceName;
}
@@ -128,6 +128,9 @@ public class JavaSpaceEndpoint extends DefaultEndpoint {
return templateId;
}
+ /**
+ * If present, this option specifies the Spring bean ID of the template to use for reading/taking entries.
+ */
public void setTemplateId(String templateId) {
this.templateId = templateId;
}
@@ -136,6 +139,9 @@ public class JavaSpaceEndpoint extends DefaultEndpoint {
return transactionTimeout;
}
+ /**
+ * Specifies the transaction timeout in millis. By default there is no timeout.
+ */
public void setTransactionTimeout(long transactionTimeout) {
this.transactionTimeout = transactionTimeout;
}