org.seasar.jms.core
インタフェース MessageReceiver

既知の実装クラスの一覧:
MessageReceiverImpl

public interface MessageReceiver

JMSメッセージを受信するコンポーネントのインタフェースです。

受信したメッセージを容易に処理するために次のメソッドを使用することができます。

これらのメソッドは受信したJMS標準メッセージ型のペイロードを戻り値として返します。

受信したJMSメッセージを独自に処理するには次のメソッドを使用することができます。

引数で指定するMessageHandlerにより自由にJMSメッセージを処理することができます。 このメソッドはMessageHandler.handleMessage(MSGTYPE)の戻り値をそのまま返します。

受信したJMSメッセージをそのまま取得するには次のメソッドを使用することができます。

いずれの場合もタイムアウトとした場合はnullを返します。

作成者:
koichik

メソッドの概要
 Message receive()
          JMSメッセージを受信してそのまま返します。
<MSGTYPE extends Message,T>
T
receive(MessageHandler<MSGTYPE,T> messageHandler)
          JMSメッセージを受信してMessageHandlerが処理した結果を返します。
 byte[] receiveBytes()
          JMSのBytesMessageを受信してペイロード(メッセージボディ)をバイト配列として返します。
 Map<String,Object> receiveMap()
          JMSのMapMessageを受信してペイロード(メッセージボディ)をMapとして返します。
 Serializable receiveObject()
          JMSのObjectMessageを受信してペイロード(メッセージボディ)をSerializableオブジェクトとして返します。
 String receiveText()
          JMSのTextMessageを受信してペイロード(メッセージボディ)を文字列として返します。
 

メソッドの詳細

receiveBytes

byte[] receiveBytes()
JMSのBytesMessageを受信してペイロード(メッセージボディ)をバイト配列として返します。

戻り値:
受信したBytesMessageのペイロードです。タイムアウトとした場合はnullを返します。
例外:
ClassCastException - 受信したJMSメッセージがBytesMessageではなかった場合にスローされます。

receiveText

String receiveText()
JMSのTextMessageを受信してペイロード(メッセージボディ)を文字列として返します。

戻り値:
受信したTextMessageのペイロードです。タイムアウトとした場合はnullを返します。
例外:
ClassCastException - 受信したJMSメッセージがTextMessageではなかった場合にスローされます。

receiveObject

Serializable receiveObject()
JMSのObjectMessageを受信してペイロード(メッセージボディ)をSerializableオブジェクトとして返します。

戻り値:
受信したObjectMessageのペイロードです。タイムアウトとした場合はnullを返します。
例外:
ClassCastException - 受信したJMSメッセージがObjectMessageではなかった場合にスローされます。

receiveMap

Map<String,Object> receiveMap()
JMSのMapMessageを受信してペイロード(メッセージボディ)をMapとして返します。

戻り値:
受信したMapMessageのペイロードです。タイムアウトとした場合はnullを返します。
例外:
ClassCastException - 受信したJMSメッセージがMapMessageではなかった場合にスローされます。

receive

<MSGTYPE extends Message,T> T receive(MessageHandler<MSGTYPE,T> messageHandler)
JMSメッセージを受信してMessageHandlerが処理した結果を返します。

型パラメータ:
MSGTYPE - JMSメッセージの型
T - JMSメッセージを処理した結果の型
パラメータ:
messageHandler - 受信したメッセージを処理するMessageHandler
戻り値:
受信したJMSメッセージをMessageHandlerが処理した結果です。タイムアウトとした場合はnullを返します。

receive

Message receive()
JMSメッセージを受信してそのまま返します。

戻り値:
受信したJMSメッセージです。タイムアウトとした場合はnullを返します。


Copyright © 2005-2007 The Seasar Foundation. All Rights Reserved.