CAMEL-7999: More components include documentation
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/28586940 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/28586940 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/28586940 Branch: refs/heads/master Commit: 28586940f06ae677cb38e698bc1e7ed2ff769103 Parents: eab6ebb Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Dec 2 09:57:39 2014 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Dec 2 09:57:39 2014 +0100 ---------------------------------------------------------------------- .../java/org/apache/camel/component/atom/AtomComponent.java | 4 ++++ .../java/org/apache/camel/component/atom/AtomEndpoint.java | 4 +++- .../java/org/apache/camel/component/feed/FeedComponent.java | 9 +++++++-- .../java/org/apache/camel/component/feed/FeedEndpoint.java | 9 +++++++++ .../java/org/apache/camel/component/rss/RssComponent.java | 4 ++++ .../java/org/apache/camel/component/rss/RssEndpoint.java | 4 +++- 6 files changed, 30 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java index 5296da0..53e4050 100644 --- a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java +++ b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomComponent.java @@ -33,6 +33,10 @@ import org.apache.camel.util.URISupport; */ public class AtomComponent extends FeedComponent { + public AtomComponent() { + super(AtomEndpoint.class); + } + @Override protected FeedEndpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception { return new AtomEndpoint(uri, this, null); http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java index e8ec3e4..5d071b2 100644 --- a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java +++ b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java @@ -24,12 +24,14 @@ import org.apache.camel.Processor; import org.apache.camel.component.feed.FeedComponent; import org.apache.camel.component.feed.FeedEndpoint; import org.apache.camel.component.feed.FeedPollingConsumer; +import org.apache.camel.spi.UriEndpoint; /** - * An <a href="http://camel.apache.org/atom.html";>Atom Endpoint</a>. + * Atom is used for polling atom feeds * * @version */ +@UriEndpoint(scheme = "atom", consumerClass = FeedPollingConsumer.class, label = "feeds") public class AtomEndpoint extends FeedEndpoint { public AtomEndpoint() { http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedComponent.java b/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedComponent.java index 5491778..e83bb3c 100644 --- a/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedComponent.java +++ b/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedComponent.java @@ -18,12 +18,17 @@ package org.apache.camel.component.feed; import java.util.Map; -import org.apache.camel.impl.DefaultComponent; +import org.apache.camel.Endpoint; +import org.apache.camel.impl.UriEndpointComponent; /** * A base class for feed (atom, RSS) components. */ -public abstract class FeedComponent extends DefaultComponent { +public abstract class FeedComponent extends UriEndpointComponent { + + public FeedComponent(Class<? extends Endpoint> endpointClass) { + super(endpointClass); + } protected abstract FeedEndpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception; http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedEndpoint.java b/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedEndpoint.java index 28c9a7e..9d8daa0 100644 --- a/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedEndpoint.java +++ b/components/camel-atom/src/main/java/org/apache/camel/component/feed/FeedEndpoint.java @@ -23,6 +23,8 @@ import org.apache.camel.Exchange; import org.apache.camel.Processor; import org.apache.camel.Producer; import org.apache.camel.impl.DefaultPollingEndpoint; +import org.apache.camel.spi.UriParam; +import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** @@ -30,12 +32,19 @@ import org.apache.camel.util.ObjectHelper; */ public abstract class FeedEndpoint extends DefaultPollingEndpoint { + @UriPath protected String feedUri; + @UriParam(defaultValue = "true") protected boolean splitEntries = true; + @UriParam protected Date lastUpdate; + @UriParam(defaultValue = "true") protected boolean filter = true; + @UriParam(defaultValue = "true") private boolean feedHeader = true; + @UriParam(defaultValue = "false") private boolean sortEntries; + @UriParam(defaultValue = "true") private boolean throttleEntries = true; public FeedEndpoint() { http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssComponent.java b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssComponent.java index 01df5e0..3b2de23 100644 --- a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssComponent.java +++ b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssComponent.java @@ -31,6 +31,10 @@ import org.apache.camel.util.URISupport; */ public class RssComponent extends FeedComponent { + public RssComponent() { + super(RssEndpoint.class); + } + protected FeedEndpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception { return new RssEndpoint(uri, this, null); } http://git-wip-us.apache.org/repos/asf/camel/blob/28586940/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java index 3678dab..2977e23 100644 --- a/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java +++ b/components/camel-rss/src/main/java/org/apache/camel/component/rss/RssEndpoint.java @@ -26,12 +26,14 @@ import org.apache.camel.Producer; import org.apache.camel.component.feed.FeedComponent; import org.apache.camel.component.feed.FeedEndpoint; import org.apache.camel.component.feed.FeedPollingConsumer; +import org.apache.camel.spi.UriEndpoint; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An <a href="http://camel.apache.org/rss.html";>RSS Endpoint</a>. + * Is used for polling rss feeds. */ +@UriEndpoint(scheme = "rss", consumerClass = RssEntryPollingConsumer.class, label = "feeds") public class RssEndpoint extends FeedEndpoint { protected static final Logger LOG = LoggerFactory.getLogger(RssEndpoint.class);
