org.seasar.jms.core.message.impl
クラス AbstractMessageHandler<MSGTYPE extends Message,PAYLOADTYPE>

java.lang.Object
  上位を拡張 org.seasar.jms.core.message.impl.AbstractMessageHandler<MSGTYPE,PAYLOADTYPE>
型パラメータ:
MSGTYPE - JMSメッセージの型
PAYLOADTYPE - JMSメッセージのペイロードの型
すべての実装されたインタフェース:
MessageHandler<MSGTYPE,PAYLOADTYPE>
直系の既知のサブクラス:
BytesMessageHandler, MapMessageHandler, ObjectMessageHandler, TextMessageHandler

public abstract class AbstractMessageHandler<MSGTYPE extends Message,PAYLOADTYPE>
extends Object
implements MessageHandler<MSGTYPE,PAYLOADTYPE>

受信したJMSメッセージを処理するコンポーネントの抽象クラスです。

受信したJMSメッセージはhandleMessage(MSGTYPE)で受け取りインスタンスフィールドで保持します。 本クラスは受信したJMSメッセージのヘッダおよびプロパティにアクセスするメソッドを提供します。

このクラスおよびサブクラスはインスタンスモードPROTOTYPEで使われることを想定しており、スレッドセーフではありません。

作成者:
koichik

フィールドの概要
protected  MSGTYPE message
          受信したJMSメッセージ
 
コンストラクタの概要
AbstractMessageHandler()
          インスタンスを構築します。
 
メソッドの概要
 void acknowledge()
          受信したJMSメッセージのAcknowledge(応答)を返します。
 String getCorrelationID()
          JMSメッセージのcorrelationID ヘッダの値を文字列で返します。
 byte[] getCorrelationIDAsBytes()
          JMSメッセージのcorrelationID ヘッダの値をバイト列で返します。
 int getDeliveryMode()
          JMSメッセージのdeliveryMode ヘッダの値を返します。
 Destination getDestination()
          JMSメッセージのdestination ヘッダの値を返します。
 long getExpiration()
          JMSメッセージのexpiration ヘッダの値を返します。
 MSGTYPE getMessage()
          JMSメッセージを返します。
 String getMessageID()
          JMSメッセージのmessageID ヘッダの値を返します。
abstract  PAYLOADTYPE getPayload()
          JMSメッセージのペイロードを返します。
 int getPriority()
          JMSメッセージのpriority ヘッダの値を返します。
 Map<String,Object> getProperties()
          JMSメッセージのプロパティをMapで返します。
 boolean getRedelivered()
          JMSメッセージのredelivered ヘッダの値を返します。
 Destination getReplyTo()
          JMSメッセージのreplyTo ヘッダの値を返します。
 long getTimestamp()
          JMSメッセージのtimestamp ヘッダの値を返します。
 String getType()
          JMSメッセージの型(Message.getJMSType()の戻り値)を返します。
 PAYLOADTYPE handleMessage(MSGTYPE message)
          JMSメッセージを処理してペイロードを返します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース org.seasar.jms.core.message.MessageHandler から継承されたメソッド
getMessageType, getPayloadType
 

フィールドの詳細

message

protected MSGTYPE extends Message message
受信したJMSメッセージ

コンストラクタの詳細

AbstractMessageHandler

public AbstractMessageHandler()
インスタンスを構築します。

メソッドの詳細

handleMessage

public PAYLOADTYPE handleMessage(MSGTYPE message)
JMSメッセージを処理してペイロードを返します。

定義:
インタフェース MessageHandler<MSGTYPE extends Message,PAYLOADTYPE> 内の handleMessage
パラメータ:
message - 受信したJMSメッセージ
戻り値:
JMSメッセージのペイロード

getPayload

public abstract PAYLOADTYPE getPayload()
                                throws JMSException
JMSメッセージのペイロードを返します。

戻り値:
JMSメッセージのペイロード
例外:
JMSException - ペイロードを取得できなかった場合にスローされます

getMessage

public MSGTYPE getMessage()
JMSメッセージを返します。

戻り値:
JMSメッセージ

acknowledge

public void acknowledge()
受信したJMSメッセージのAcknowledge(応答)を返します。

例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getCorrelationID

public String getCorrelationID()
JMSメッセージのcorrelationID ヘッダの値を文字列で返します。

戻り値:
JMSメッセージのcorrelationIDヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getCorrelationIDAsBytes

public byte[] getCorrelationIDAsBytes()
JMSメッセージのcorrelationID ヘッダの値をバイト列で返します。

戻り値:
JMSメッセージのcorrelationIDヘッダの値のバイト列
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getDeliveryMode

public int getDeliveryMode()
JMSメッセージのdeliveryMode ヘッダの値を返します。

戻り値:
JMSメッセージのdeliveryModeヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getDestination

public Destination getDestination()
JMSメッセージのdestination ヘッダの値を返します。

戻り値:
JMSメッセージのdestinationヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getExpiration

public long getExpiration()
JMSメッセージのexpiration ヘッダの値を返します。

戻り値:
JMSメッセージのexpirationヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getMessageID

public String getMessageID()
JMSメッセージのmessageID ヘッダの値を返します。

戻り値:
JMSメッセージのmessageIDヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getPriority

public int getPriority()
JMSメッセージのpriority ヘッダの値を返します。

戻り値:
JMSメッセージのpriorityヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getRedelivered

public boolean getRedelivered()
JMSメッセージのredelivered ヘッダの値を返します。

戻り値:
JMSメッセージのredeliveredヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getReplyTo

public Destination getReplyTo()
JMSメッセージのreplyTo ヘッダの値を返します。

戻り値:
JMSメッセージのreplyToヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getTimestamp

public long getTimestamp()
JMSメッセージのtimestamp ヘッダの値を返します。

戻り値:
JMSメッセージのtimestampヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getType

public String getType()
JMSメッセージの型(Message.getJMSType()の戻り値)を返します。

戻り値:
JMSメッセージのtimestampヘッダの値
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます

getProperties

public Map<String,Object> getProperties()
JMSメッセージのプロパティをMapで返します。

戻り値:
JMSメッセージのプロパティ
例外:
SJMSRuntimeException - JMS実装で例外が発生した場合にスローされます


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