From 3f79525907377d9db7c274f671bd575f3588af3a Mon Sep 17 00:00:00 2001 From: Mark Fisher Date: Tue, 19 Aug 2008 16:07:36 +0000 Subject: [PATCH] Updated MessageTarget JavaDoc (INT-331). --- .../integration/message/MessageTarget.java | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/org.springframework.integration/src/main/java/org/springframework/integration/message/MessageTarget.java b/org.springframework.integration/src/main/java/org/springframework/integration/message/MessageTarget.java index be783a7448..aecf0293c2 100644 --- a/org.springframework.integration/src/main/java/org/springframework/integration/message/MessageTarget.java +++ b/org.springframework.integration/src/main/java/org/springframework/integration/message/MessageTarget.java @@ -23,6 +23,21 @@ package org.springframework.integration.message; */ public interface MessageTarget { - boolean send(Message message); + /** + * Send a {@link Message} to this target. May throw a RuntimeException for non-recoverable + * errors. Otherwise, if the Message cannot be sent for a non-fatal reason such as timeout, + * then this method will return 'false', and if the Message is sent successfully, it will + * return 'true'. + * + * @param message the Message to send + * + * @return whether the Message has been sent successfully + * + * @throws MessageRejectedException if this particular Message is not accepted by the target + * (e.g. after consulting a {@link org.springframework.integration.message.selector.MessageSelector}) + * @throws MessageDeliveryException if this target is unable to send the Message due + * to a transport error + */ + boolean send(Message message) throws MessageRejectedException, MessageDeliveryException; }