Author: davsclaus
Date: Thu May 22 21:48:02 2008
New Revision: 659422
URL: http://svn.apache.org/viewvc?rev=659422&view=rev
Log:
CAMEL-517: Polished Javadoc
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/AlreadyStoppedException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelTemplate.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateProducerException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidHeaderTypeException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadRuntimeException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidTypeException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeCamelException.java
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/ServiceSupport.java
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/AlreadyStoppedException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/AlreadyStoppedException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/AlreadyStoppedException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/AlreadyStoppedException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Exception thrown in situations when a [EMAIL PROTECTED] Service} has
already been stopped.
+ *
* @version $Revision$
*/
public class AlreadyStoppedException extends CamelException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelException.java
Thu May 22 21:48:02 2008
@@ -17,8 +17,7 @@
package org.apache.camel;
/**
- * Base class for all Camel checked exceptions typically thrown by a
- * [EMAIL PROTECTED] Processor}
+ * Base class for all Camel checked exceptions typically thrown by a [EMAIL
PROTECTED] Processor}
*
* @version $Revision$
*/
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelTemplate.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelTemplate.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelTemplate.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelTemplate.java
Thu May 22 21:48:02 2008
@@ -16,7 +16,6 @@
*/
package org.apache.camel;
-import java.security.spec.ECField;
import java.util.HashMap;
import java.util.Map;
@@ -33,9 +32,9 @@
*/
public class CamelTemplate<E extends Exchange> extends ServiceSupport
implements ProducerTemplate<E> {
private CamelContext context;
- private ProducerCache<E> producerCache = new ProducerCache<E>();
+ private final ProducerCache<E> producerCache = new ProducerCache<E>();
private boolean useEndpointCache = true;
- private Map<String, Endpoint<E>> endpointCache = new HashMap<String,
Endpoint<E>>();
+ private final Map<String, Endpoint<E>> endpointCache = new HashMap<String,
Endpoint<E>>();
private Endpoint<E> defaultEndpoint;
public CamelTemplate(CamelContext context) {
@@ -47,62 +46,26 @@
this.defaultEndpoint = defaultEndpoint;
}
- /**
- * Sends the exchange to the given endpoint
- *
- * @param endpointUri the endpoint URI to send the exchange to
- * @param exchange the exchange to send
- */
public E send(String endpointUri, E exchange) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return send(endpoint, exchange);
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpointUri the endpoint URI to send the exchange to
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange
- */
public E send(String endpointUri, Processor processor) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return send(endpoint, processor);
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpointUri the endpoint URI to send the exchange to
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange. The callback
- * will be called when the exchange is completed.
- */
public E send(String endpointUri, Processor processor, AsyncCallback
callback) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return send(endpoint, processor, callback);
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpointUri the endpoint URI to send the exchange to
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such
as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange
- */
public E send(String endpointUri, ExchangePattern pattern, Processor
processor) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return send(endpoint, pattern, processor);
}
- /**
- * Sends the exchange to the given endpoint
- *
- * @param endpoint the endpoint to send the exchange to
- * @param exchange the exchange to send
- */
public E send(Endpoint<E> endpoint, E exchange) {
//E convertedExchange = endpoint.createExchange(exchange);
E convertedExchange = exchange;
@@ -110,178 +73,65 @@
return convertedExchange;
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpoint the endpoint to send the exchange to
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange
- */
public E send(Endpoint<E> endpoint, Processor processor) {
return producerCache.send(endpoint, processor);
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpoint the endpoint to send the exchange to
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange. The callback
- * will be called when the exchange is completed.
- */
public E send(Endpoint<E> endpoint, Processor processor, AsyncCallback
callback) {
return producerCache.send(endpoint, processor, callback);
}
- /**
- * Sends an exchange to an endpoint using a supplied
- *
- * @param endpoint the endpoint to send the exchange to
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange
- */
public E send(Endpoint<E> endpoint, ExchangePattern pattern, Processor
processor) {
return producerCache.send(endpoint, pattern, processor);
}
- /**
- * Send the body to an endpoint with the given [EMAIL PROTECTED]
ExchangePattern}
- * returning any result output body
- *
- * @param endpoint
- * @param body = the payload
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @return the result
- */
public Object sendBody(Endpoint<E> endpoint, ExchangePattern pattern,
Object body) {
E result = send(endpoint, pattern, createSetBodyProcessor(body));
return extractResultBody(result);
}
- /**
- * Send the body to an endpoint returning any result output body
- *
- * @param endpoint
- * @param body = the payload
- * @return the result
- */
public Object sendBody(Endpoint<E> endpoint, Object body) {
E result = send(endpoint, createSetBodyProcessor(body));
return extractResultBody(result);
}
- /**
- * Send the body to an endpoint
- *
- * @param endpointUri
- * @param body = the payload
- * @return the result
- */
public Object sendBody(String endpointUri, Object body) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return sendBody(endpoint, body);
}
- /**
- * Send the body to an endpoint
- *
- * @param endpointUri
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such
as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @param body = the payload
- * @return the result
- */
public Object sendBody(String endpointUri, ExchangePattern pattern, Object
body) {
Endpoint endpoint = resolveMandatoryEndpoint(endpointUri);
return sendBody(endpoint, pattern, body);
}
- /**
- * Sends the body to an endpoint with a specified header and header value
- *
- * @param endpointUri the endpoint URI to send to
- * @param body the payload send
- * @param header the header name
- * @param headerValue the header value
- * @return the result
- */
public Object sendBodyAndHeader(String endpointUri, final Object body,
final String header,
final Object headerValue) {
return sendBodyAndHeader(resolveMandatoryEndpoint(endpointUri), body,
header, headerValue);
}
- /**
- * Sends the body to an endpoint with a specified header and header value
- *
- * @param endpoint the Endpoint to send to
- * @param body the payload send
- * @param header the header name
- * @param headerValue the header value
- * @return the result
- */
public Object sendBodyAndHeader(Endpoint endpoint, final Object body,
final String header,
final Object headerValue) {
E result = send(endpoint, createBodyAndHeaderProcessor(body, header,
headerValue));
return extractResultBody(result);
}
- /**
- * Sends the body to an endpoint with a specified header and header value
- *
- * @param endpoint the Endpoint to send to
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such
as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @param body the payload send
- * @param header the header name
- * @param headerValue the header value
- * @return the result
- */
public Object sendBodyAndHeader(Endpoint endpoint, ExchangePattern
pattern, final Object body, final String header,
final Object headerValue) {
E result = send(endpoint, pattern, createBodyAndHeaderProcessor(body,
header, headerValue));
return extractResultBody(result);
}
- /**
- * Sends the body to an endpoint with a specified header and header value
- *
- * @param endpoint the Endpoint URI to send to
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such
as
- * [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL
PROTECTED] ExchangePattern#InOut}
- * @param body the payload send
- * @param header the header name
- * @param headerValue the header value
- * @return the result
- */
public Object sendBodyAndHeader(String endpoint, ExchangePattern pattern,
final Object body, final String header,
final Object headerValue) {
E result = send(endpoint, pattern, createBodyAndHeaderProcessor(body,
header, headerValue));
return extractResultBody(result);
}
- /**
- * Sends the body to an endpoint with the specified headers and header
- * values
- *
- * @param endpointUri the endpoint URI to send to
- * @param body the payload send
- * @return the result
- */
public Object sendBodyAndHeaders(String endpointUri, final Object body,
final Map<String, Object> headers) {
return sendBodyAndHeaders(resolveMandatoryEndpoint(endpointUri), body,
headers);
}
- /**
- * Sends the body to an endpoint with the specified headers and header
- * values
- *
- * @param endpoint the endpoint URI to send to
- * @param body the payload send
- * @return the result
- */
public Object sendBodyAndHeaders(Endpoint endpoint, final Object body,
final Map<String, Object> headers) {
E result = send(endpoint, new Processor() {
public void process(Exchange exchange) {
@@ -298,78 +148,26 @@
// Methods using an InOut ExchangePattern
// -----------------------------------------------------------------------
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param processor the processor which will populate the exchange before
sending
- * @return the result
- */
public E request(Endpoint<E> endpoint, Processor processor) {
return send(endpoint, ExchangePattern.InOut, processor);
}
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param body = the payload
- * @return the result
- */
public Object requestBody(Endpoint<E> endpoint, Object body) {
return sendBody(endpoint, ExchangePattern.InOut, body);
}
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param body = the payload
- * @param header
- * @param headerValue
- * @return the result
- */
public Object requestBodyAndHeader(Endpoint<E> endpoint, Object body,
String header, Object headerValue) {
return sendBodyAndHeader(endpoint, ExchangePattern.InOut, body,
header, headerValue);
}
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param processor the processor which will populate the exchange before
sending
- * @return the result
- */
public E request(String endpoint, Processor processor) {
return send(endpoint, ExchangePattern.InOut, processor);
}
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param body = the payload
- * @return the result
- */
public Object requestBody(String endpoint, Object body) {
return sendBody(endpoint, ExchangePattern.InOut, body);
}
- /**
- * Send the body to an endpoint returning any result output body
- * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern
- *
- * @param endpoint
- * @param body = the payload
- * @param header
- * @param headerValue
- * @return the result
- */
public Object requestBodyAndHeader(String endpoint, Object body, String
header, Object headerValue) {
return sendBodyAndHeader(endpoint, ExchangePattern.InOut, body,
header, headerValue);
}
@@ -377,50 +175,22 @@
// Methods using the default endpoint
// -----------------------------------------------------------------------
- /**
- * Sends the body to the default endpoint and returns the result content
- *
- * @param body the body to send
- * @return the returned message body
- */
public Object sendBody(Object body) {
return sendBody(getMandatoryDefaultEndpoint(), body);
}
- /**
- * Sends the exchange to the default endpoint
- *
- * @param exchange the exchange to send
- */
public E send(E exchange) {
return send(getMandatoryDefaultEndpoint(), exchange);
}
- /**
- * Sends an exchange to the default endpoint using a supplied
- *
- * @param processor the transformer used to populate the new exchange
- * [EMAIL PROTECTED] Processor} to populate the exchange
- */
public E send(Processor processor) {
return send(getMandatoryDefaultEndpoint(), processor);
}
- /**
- * Sends an [EMAIL PROTECTED] ExchangePattern#InOnly} exchange to the
default endpoint using the supplied body, header and header value
- * @param body the message body
- * @param header the message header
- * @param headerValue the message header value
- */
public Object sendBodyAndHeader(Object body, String header, Object
headerValue) {
return sendBodyAndHeader(getMandatoryDefaultEndpoint(), body, header,
headerValue);
}
- /**
- * Sends an [EMAIL PROTECTED] ExchangePattern#InOnly} exchange to the
default endpoint
- * @param body the message body
- * @param headers a map with header values
- */
public Object sendBodyAndHeaders(Object body, Map<String, Object> headers)
{
return sendBodyAndHeaders(getMandatoryDefaultEndpoint(), body,
headers);
}
@@ -539,4 +309,5 @@
}
return answer;
}
+
}
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateProducerException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateProducerException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateProducerException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateProducerException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Thrown if Camel failed to create a producer for a given endpoint.
+ *
* @version $Revision$
*/
public class FailedToCreateProducerException extends RuntimeCamelException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidHeaderTypeException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidHeaderTypeException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidHeaderTypeException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidHeaderTypeException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,7 @@
package org.apache.camel;
/**
+ * @deprecated use [EMAIL PROTECTED] InvalidTypeException}
* @version $Revision$
*/
public class InvalidHeaderTypeException extends RuntimeCamelException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Is thrown if the payload from the exchange could not be retrieve because of
being null, wrong class type etc.
+ *
* @version $Revision$
*/
public class InvalidPayloadException extends CamelExchangeException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadRuntimeException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadRuntimeException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadRuntimeException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadRuntimeException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Runtime version of the [EMAIL PROTECTED]
org.apache.camel.InvalidTypeException}.
+ *
* @version $Revision$
*/
public class InvalidPayloadRuntimeException extends RuntimeExchangeException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidTypeException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidTypeException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidTypeException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidTypeException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Is thrown if type conversion failed.
+ *
* @version $Revision$
*/
public class InvalidTypeException extends CamelExchangeException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerTemplate.java
Thu May 22 21:48:02 2008
@@ -26,6 +26,7 @@
* @version $Revision$
*/
public interface ProducerTemplate<E extends Exchange> extends Service {
+
/**
* Sends the exchange to the default endpoint
*
@@ -81,7 +82,7 @@
E send(String endpointUri, E exchange);
/**
- * Sends an exchange to an endpoint using a supplied
+ * Sends an exchange to an endpoint using a supplied processor
*
* @param endpointUri the endpoint URI to send the exchange to
* @param processor the transformer used to populate the new exchange
@@ -90,7 +91,7 @@
E send(String endpointUri, Processor processor);
/**
- * Sends an exchange to an endpoint using a supplied
+ * Sends an exchange to an endpoint using a supplied processor
*
* @param endpointUri the endpoint URI to send the exchange to
* @param pattern the message [EMAIL PROTECTED] ExchangePattern} such
as
@@ -101,6 +102,16 @@
E send(String endpointUri, ExchangePattern pattern, Processor processor);
/**
+ * Sends an exchange to an endpoint using a supplied processor
+ *
+ * @param endpointUri the endpoint URI to send the exchange to
+ * @param processor the transformer used to populate the new exchange
+ * [EMAIL PROTECTED] Processor} to populate the exchange.
+ * @param callback the callback will be called when the exchange is
completed.
+ */
+ E send(String endpointUri, Processor processor, AsyncCallback callback);
+
+ /**
* Sends the exchange to the given endpoint
*
* @param endpoint the endpoint to send the exchange to
@@ -109,7 +120,7 @@
E send(Endpoint<E> endpoint, E exchange);
/**
- * Sends an exchange to an endpoint using a supplied
+ * Sends an exchange to an endpoint using a supplied processor
*
* @param endpoint the endpoint to send the exchange to
* @param processor the transformer used to populate the new exchange
@@ -118,7 +129,7 @@
E send(Endpoint<E> endpoint, Processor processor);
/**
- * Sends an exchange to an endpoint using a supplied
+ * Sends an exchange to an endpoint using a supplied processor
*
* @param endpoint the endpoint to send the exchange to
* @param pattern the message [EMAIL PROTECTED] ExchangePattern} such as
@@ -129,19 +140,29 @@
E send(Endpoint<E> endpoint, ExchangePattern pattern, Processor processor);
/**
- * Send the body to an endpoint
+ * Sends an exchange to an endpoint using a supplied processor
*
- * @param endpoint
- * @param body = the payload
+ * @param endpoint the endpoint to send the exchange to
+ * @param processor the transformer used to populate the new exchange
+ * [EMAIL PROTECTED] Processor} to populate the exchange.
+ * @param callback the callback will be called when the exchange is
completed.
+ */
+ E send(Endpoint<E> endpoint, Processor processor, AsyncCallback callback);
+
+ /**
+ * Send the body to an endpoint returning any result output body
+ *
+ * @param endpoint the endpoint to send the exchange to
+ * @param body the payload
* @return the result
*/
Object sendBody(Endpoint<E> endpoint, Object body);
/**
- * Send the body to an endpoint
+ * Send the body to an endpoint returning any result output body
*
- * @param endpointUri
- * @param body = the payload
+ * @param endpointUri the endpoint URI to send the exchange to
+ * @param body the payload
* @return the result
*/
Object sendBody(String endpointUri, Object body);
@@ -150,21 +171,21 @@
* Send the body to an endpoint with the given [EMAIL PROTECTED]
ExchangePattern}
* returning any result output body
*
- * @param endpoint
- * @param body = the payload
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such as
+ * @param endpoint the endpoint to send the exchange to
+ * @param body the payload
+ * @param pattern the message [EMAIL PROTECTED] ExchangePattern}
such as
* [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL PROTECTED]
ExchangePattern#InOut}
* @return the result
*/
Object sendBody(Endpoint<E> endpoint, ExchangePattern pattern, Object
body);
/**
- * Send the body to an endpoint
+ * Send the body to an endpoint returning any result output body
*
- * @param endpointUri
- * @param pattern the message [EMAIL PROTECTED] ExchangePattern} such as
+ * @param endpointUri the endpoint URI to send the exchange to
+ * @param pattern the message [EMAIL PROTECTED] ExchangePattern}
such as
* [EMAIL PROTECTED] ExchangePattern#InOnly} or [EMAIL PROTECTED]
ExchangePattern#InOut}
- * @param body = the payload
+ * @param body the payload
* @return the result
*/
Object sendBody(String endpointUri, ExchangePattern pattern, Object body);
@@ -246,60 +267,67 @@
// -----------------------------------------------------------------------
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
+ * @param endpoint the Endpoint to send to
* @param processor the processor which will populate the exchange before
sending
* @return the result
*/
E request(Endpoint<E> endpoint, Processor processor);
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
- * @param body = the payload
+ * @param endpoint the Endpoint to send to
+ * @param body the payload
* @return the result
*/
Object requestBody(Endpoint<E> endpoint, Object body);
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
- * @param body = the payload
- * @param header
- * @param headerValue
+ * @param endpoint the Endpoint to send to
+ * @param body the payload
+ * @param header the header name
+ * @param headerValue the header value
* @return the result
*/
Object requestBodyAndHeader(Endpoint<E> endpoint, Object body, String
header, Object headerValue);
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
+ * @param endpointUri the endpoint URI to send to
* @param processor the processor which will populate the exchange before
sending
* @return the result
*/
- E request(String endpoint, Processor processor);
+ E request(String endpointUri, Processor processor);
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
- * @param body = the payload
+ * @param endpointUri the endpoint URI to send to
+ * @param body the payload
* @return the result
*/
- Object requestBody(String endpoint, Object body);
+ Object requestBody(String endpointUri, Object body);
/**
- * Send the body to an endpoint returning any result output body
+ * Send the body to an endpoint returning any result output body.
+ * Uses an [EMAIL PROTECTED] ExchangePattern#InOut} message exchange
pattern.
*
- * @param endpoint
- * @param body = the payload
- * @param header
- * @param headerValue
+ * @param endpointUri the endpoint URI to send to
+ * @param body the payload
+ * @param header the header name
+ * @param headerValue the header value
* @return the result
*/
- Object requestBodyAndHeader(String endpoint, Object body, String header,
Object headerValue);
+ Object requestBodyAndHeader(String endpointUri, Object body, String
header, Object headerValue);
+
}
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeCamelException.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeCamelException.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeCamelException.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeCamelException.java
Thu May 22 21:48:02 2008
@@ -17,6 +17,8 @@
package org.apache.camel;
/**
+ * Base class for all Camel unchecked exceptions.
+ *
* @version $Revision$
*/
public class RuntimeCamelException extends RuntimeException {
Modified:
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/ServiceSupport.java
URL:
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/ServiceSupport.java?rev=659422&r1=659421&r2=659422&view=diff
==============================================================================
---
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/ServiceSupport.java
(original)
+++
activemq/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/ServiceSupport.java
Thu May 22 21:48:02 2008
@@ -88,8 +88,8 @@
}
/**
- * Helper methods so the service knows if it should keep running. Returns
- * false if the service is being stopped or is stopped.
+ * Helper methods so the service knows if it should keep running.
+ * Returns false if the service is being stopped or is stopped.
*
* @return true if the service should continue to run.
*/
