Author: jstrachan
Date: Wed Apr 25 04:09:36 2007
New Revision: 532316
URL: http://svn.apache.org/viewvc?view=rev&rev=532316
Log:
removed some cruft from the API and tidied up the javadocs somewhat
Added:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
(contents, props changed)
- copied, changed from r532226,
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Provider.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html
(with props)
Removed:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Provider.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RouteBuilderFinder.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RouteFactory.java
Modified:
activemq/camel/trunk/camel-core/pom.xml
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Component.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Consumer.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Expression.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Predicate.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Service.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/TypeConverter.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
activemq/camel/trunk/pom.xml
Modified: activemq/camel/trunk/camel-core/pom.xml
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/pom.xml?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
--- activemq/camel/trunk/camel-core/pom.xml (original)
+++ activemq/camel/trunk/camel-core/pom.xml Wed Apr 25 04:09:36 2007
@@ -18,7 +18,7 @@
-->
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd";
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xmlns="http://maven.apache.org/POM/4.0.0";>
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xmlns="http://maven.apache.org/POM/4.0.0";>
<modelVersion>4.0.0</modelVersion>
@@ -81,7 +81,7 @@
</executions>
</plugin>
- <plugin>
+ <plugin>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<childDelegation>false</childDelegation>
@@ -92,6 +92,47 @@
<excludes>
<exclude>**/PojoRouteTest.*</exclude>
</excludes>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <groups>
+ <group>
+ <title>Camel API</title>
+ <packages>org.apache.camel</packages>
+ </group>
+ <group>
+ <title>Fluent API for building routes</title>
+
<packages>org.apache.camel.builder:org.apache.camel.builder.*</packages>
+ </group>
+ <group>
+ <title>Strategy APIs for implementors to extend Camel</title>
+ <packages>org.apache.camel.spi</packages>
+ </group>
+ <group>
+ <title>Processors to implement the Enterprise Integration
Patterns</title>
+
<packages>org.apache.camel.processor:org.apache.camel.processor.*</packages>
+ </group>
+ <group>
+ <title>Camel Components</title>
+ <packages>org.apache.camel.component.*</packages>
+ </group>
+ <group>
+ <title>Camel Runtime</title>
+
<packages>org.apache.camel.impl:org.apache.camel.impl.*</packages>
+ </group>
+ <group>
+ <title>Type conversion helper classes</title>
+
<packages>org.apache.camel.converter:org.apache.camel.converter.*</packages>
+ </group>
+ <group>
+ <title>Utility classes for component implementors</title>
+ <packages>org.apache.camel.util:org.apache.camel.view</packages>
+ </group>
+ </groups>
</configuration>
</plugin>
</plugins>
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
Wed Apr 25 04:09:36 2007
@@ -18,8 +18,8 @@
package org.apache.camel;
import org.apache.camel.builder.RouteBuilder;
-import org.apache.camel.spi.Injector;
import org.apache.camel.spi.ExchangeConverter;
+import org.apache.camel.spi.Injector;
import java.util.Collection;
import java.util.List;
@@ -80,19 +80,44 @@
// Route Management Methods
//-----------------------------------------------------------------------
+
+ /**
+ * Returns the current routes in this context
+ *
+ * @return the current routes in this context
+ */
List<Route> getRoutes();
+ /**
+ * Sets the routes for this context, replacing any current routes
+ *
+ * @param routes the new routes to use
+ */
void setRoutes(List<Route> routes);
- void addRoutes(List<Route> routes);
+ /**
+ * Adds a collection of routes to this context
+ *
+ * @param routes the routes to add
+ */
+ void addRoutes(Collection<Route> routes);
+ /**
+ * Adds a collection of routes to this context using the given builder
+ * to build them
+ *
+ * @param builder the builder which will create the routes and add them to
this context
+ * @throws Exception if the routes could not be created for whatever reason
+ */
void addRoutes(RouteBuilder builder) throws Exception;
- void addRoutes(RouteFactory factory) throws Exception;
-
-
// Properties
//-----------------------------------------------------------------------
+
+ /**
+ * Returns the converter of exchanges from one type to another
+ * @return
+ */
ExchangeConverter getExchangeConverter();
/**
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Component.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Component.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Component.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Component.java
Wed Apr 25 04:09:36 2007
@@ -18,7 +18,7 @@
/**
- * Represents a component which manages a set of [EMAIL PROTECTED] Endpoint}
objects.
+ * A <a href="http://activemq.apache.org/camel/component.html";>component</a>
is a factory of [EMAIL PROTECTED] Endpoint} objects.
*
* @version $Revision: 519901 $
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Consumer.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Consumer.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Consumer.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Consumer.java
Wed Apr 25 04:09:36 2007
@@ -18,7 +18,7 @@
package org.apache.camel;
/**
- * Represents a consumer of an endpoint
+ * A consumer of message exchanges from an [EMAIL PROTECTED] Endpoint}
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Endpoint.java
Wed Apr 25 04:09:36 2007
@@ -18,9 +18,11 @@
/**
- * Implements the <a
href="http://activemq.apache.org/camel/message-endpoint.html";>Message
Endpoint</a>
+ * An <a href="http://activemq.apache.org/camel/endpoint.html";>endpoint</a>
implements the
+ * <a href="http://activemq.apache.org/camel/message-endpoint.html";>Message
Endpoint</a>
* pattern and represents an endpoint that can send and receive message
exchanges
*
+ * @see Exchange, Message
* @version $Revision$
*/
public interface Endpoint<E extends Exchange> {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Exchange.java
Wed Apr 25 04:09:36 2007
@@ -19,7 +19,9 @@
import java.util.Map;
/**
- * Represents the base exchange interface providing access to the request,
response and fault [EMAIL PROTECTED] Message} instances.
+ * The base message exchange interface providing access to the request,
response and fault [EMAIL PROTECTED] Message} instances.
+ * Different providers such as JMS, JBI, CXF and HTTP can provide their own
derived API to expose the underlying transport
+ * semantics to avoid the leaky abstractions of generic APIs.
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Expression.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Expression.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Expression.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Expression.java
Wed Apr 25 04:09:36 2007
@@ -17,7 +17,13 @@
package org.apache.camel;
/**
- * Represents an arbitrary expression evaluated on a message exchange
+ * An <a href="http://activemq.apache.org/camel/expression.html";>expression</a>
+ * provides a plugin strategy for evaluating expressions on a message exchange
to support things like
+ * <a
href="http://activemq.apache.org/camel/scripting-languages.html";>scripting
languages</a>,
+ * <a href="http://activemq.apache.org/camel/xquery.html";>XQuery</a>
+ * or <a href="http://activemq.apache.org/camel/sql.html";>SQL</a> as well
+ * as any arbitrary Java expression.
+ *
*
* @version $Revision: $
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Predicate.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Predicate.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Predicate.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Predicate.java
Wed Apr 25 04:09:36 2007
@@ -17,7 +17,12 @@
package org.apache.camel;
/**
- * Evaluates a binary predicate on the message exchange
+ * Evaluates a binary <a
href="http://activemq.apache.org/camel/predicate.html";>predicate</a>
+ * on the message exchange to support things like
+ * <a
href="http://activemq.apache.org/camel/scripting-languages.html";>scripting
languages</a>,
+ * <a href="http://activemq.apache.org/camel/xquery.html";>XQuery</a>
+ * or <a href="http://activemq.apache.org/camel/sql.html";>SQL</a> as well
+ * as any arbitrary Java expression.
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
Wed Apr 25 04:09:36 2007
@@ -17,8 +17,11 @@
package org.apache.camel;
/**
- * Implements the <a
href="http://activemq.apache.org/camel/event-driven-consumer.html";>Event Driven
Consumer</a>
- * pattern to process message exchanges
+ * A <a href="http://activemq.apache.org/camel/processor.html";>processor</a>
+ * is used to implement the
+ * <a href="http://activemq.apache.org/camel/event-driven-consumer.html";>Event
Driven Consumer</a>
+ * and <a
href="http://activemq.apache.org/camel/message-transformer.html";>Message
Transformer</a>
+ * patterns and to process message exchanges.
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java
Wed Apr 25 04:09:36 2007
@@ -18,7 +18,7 @@
package org.apache.camel;
/**
- * Provides a channel on which clients can create and invoke exchanges on the
endpoint
+ * Provides a channel on which clients can create and invoke message exchanges
on an [EMAIL PROTECTED] Endpoint}
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
Wed Apr 25 04:09:36 2007
@@ -21,8 +21,9 @@
import java.util.Map;
/**
- * A route defines the processing used on an inbound message exchange
- * from a specific [EMAIL PROTECTED] Endpoint}
+ * A <a href="http://activemq.apache.org/camel/routes.html";>Route</a>
+ * defines the processing used on an inbound message exchange
+ * from a specific [EMAIL PROTECTED] Endpoint} within a [EMAIL PROTECTED]
CamelContext}
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Service.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Service.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
--- activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Service.java
(original)
+++ activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Service.java
Wed Apr 25 04:09:36 2007
@@ -24,7 +24,17 @@
*/
public interface Service {
+ /**
+ * Starts the service
+ *
+ * @throws Exception
+ */
void start() throws Exception;
+ /**
+ * Stops the service
+ *
+ * @throws Exception
+ */
void stop() throws Exception;
}
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/TypeConverter.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/TypeConverter.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/TypeConverter.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/TypeConverter.java
Wed Apr 25 04:09:36 2007
@@ -18,8 +18,9 @@
package org.apache.camel;
/**
- * A pluggable strategy to be able to convert objects <a
href="http://activemq.apache.org/camel/type-converter.html";>to different
types</a>
- * such as to and from String, InputStream/OutputStream, Reader/Writer,
Document, byte[], ByteBuffer etc
+ * A pluggable strategy to be able to convert objects
+ * <a href="http://activemq.apache.org/camel/type-converter.html";>to different
types</a>
+ * such as to and from String, InputStream/OutputStream, Reader/Writer,
Document, byte[], ByteBuffer etc
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
Wed Apr 25 04:09:36 2007
@@ -17,26 +17,7 @@
*/
package org.apache.camel.impl;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.Callable;
-
-import org.apache.camel.CamelContext;
-import org.apache.camel.Component;
-import org.apache.camel.Consumer;
-import org.apache.camel.Endpoint;
-import org.apache.camel.Exchange;
-import org.apache.camel.Processor;
-import org.apache.camel.ResolveEndpointFailedException;
-import org.apache.camel.Route;
-import org.apache.camel.RouteFactory;
-import org.apache.camel.RuntimeCamelException;
-import org.apache.camel.Service;
-import org.apache.camel.TypeConverter;
+import org.apache.camel.*;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.impl.converter.DefaultTypeConverter;
import org.apache.camel.spi.ComponentResolver;
@@ -47,6 +28,14 @@
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ServiceHelper;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.Callable;
+
/**
* Represents the context used to configure routes and the policies to use.
*
@@ -208,7 +197,7 @@
this.routes = routes;
}
- public void addRoutes(List<Route> routes) {
+ public void addRoutes(Collection<Route> routes) {
if (this.routes == null) {
this.routes = new ArrayList<Route>(routes);
}
@@ -221,15 +210,6 @@
// lets now add the routes from the builder
builder.setContext(this);
addRoutes(builder.getRouteList());
- }
-
- public void addRoutes(final RouteFactory factory) throws Exception {
- RouteBuilder builder = new RouteBuilder(this) {
- public void configure() {
- factory.build(this);
- }
- };
- addRoutes(builder);
}
// Properties
Copied:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
(from r532226,
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Provider.java)
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java?view=diff&rev=532316&p1=activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Provider.java&r1=532226&p2=activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java&r2=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/Provider.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
Wed Apr 25 04:09:36 2007
@@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.camel;
+package org.apache.camel.spi;
/**
* A provider of newly constructed objects
Propchange:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/spi/Provider.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html?view=auto&rev=532316
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html
(added)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html
Wed Apr 25 04:09:36 2007
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+Helper class to help with the <a
href="http://activemq.apache.org/visualisation.html";>Visualisation</a> of Routes
+
+</body>
+</html>
Propchange:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/view/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: activemq/camel/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/pom.xml?view=diff&rev=532316&r1=532315&r2=532316
==============================================================================
--- activemq/camel/trunk/pom.xml (original)
+++ activemq/camel/trunk/pom.xml Wed Apr 25 04:09:36 2007
@@ -477,9 +477,6 @@
<reporting>
<plugins>
<plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- </plugin>
- <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
</plugin>
@@ -527,6 +524,7 @@
<linksource>true</linksource>
<maxmemory>900m</maxmemory>
<source>1.5</source>
+ <aggregate>true</aggregate>
</configuration>
</plugin>
</plugins>
