インターフェース QueueSender
- すべてのスーパーインターフェース:
AutoCloseableSE,MessageProducer
public interface QueueSender extends MessageProducer
クライアントはQueueSenderオブジェクトを使用してメッセージをキューに送信します。通常、
Queueは、QueueSenderの作成時に指定されます。この場合、識別されていないQueueSenderにsendメソッドを使用しようとすると、java.lang.UnsupportedOperationExceptionがスローされます。識別されていない
Queueを使用してQueueSenderが作成された場合、Queueが識別されていると想定してsendメソッドを使用しようとすると、java.lang.UnsupportedOperationExceptionがスローされます。sendメソッドの実行中、メッセージはクライアント内の他のスレッドによって変更されてはなりません。メッセージが変更された場合、sendの結果は未定義です。メッセージを送信した後、クライアントは、送信されたメッセージに影響を与えることなく、メッセージを保持および変更できます。同じメッセージオブジェクトが複数回送信される場合があります。
次のメッセージヘッダーは、メッセージ送信の一部として設定されます:
JMSDestination、JMSDeliveryMode、JMSExpiration、JMSPriority、JMSMessageID、JMSTimeStamp。メッセージが送信されると、これらのヘッダーの値は無視されます。sendの完了後、ヘッダーはメッセージを送信するメソッドによって指定された値を保持します。MessageProducer.setDisableMessageIDまたはMessageProducer.setDisableMessageTimestampメソッドによってこれらのヘッダーの設定が明示的に無効にされている場合、sendメソッドがJMSMessageIDおよびJMSTimeStampを設定しない可能性があります。MessageProducerの作成は、QueueSenderの作成と同じ機能を提供します。新しいコードを作成するときは、MessageProducerオブジェクトをお勧めします。QueueSenderは、既存のコードをサポートするために提供されています。- 導入:
- JMS 1.0
- バージョン:
- Jakarta Messaging 2.0
- 関連事項:
MessageProducer,Session.createProducer(Destination),QueueSession.createSender(Queue)
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 QueuegetQueue()このQueueSenderに関連付けられたキューを取得します。voidsend(Message message)メッセージをキューに送信します。voidsend(Message message, int deliveryMode, int priority, long timeToLive)配信モード、優先度、存続時間を指定して、メッセージをキューに送信します。voidsend(Queue queue, Message message)不明なメッセージプロデューサーのキューにメッセージを送信します。voidsend(Queue queue, Message message, int deliveryMode, int priority, long timeToLive)識別されていないメッセージプロデューサーのキューにメッセージを送信し、配信モード、優先度、存続時間を指定します。インターフェース jakarta.jms.MessageProducer から継承されたメソッド
close, getDeliveryDelay, getDeliveryMode, getDestination, getDisableMessageID, getDisableMessageTimestamp, getPriority, getTimeToLive, send, send, send, send, send, send, setDeliveryDelay, setDeliveryMode, setDisableMessageID, setDisableMessageTimestamp, setPriority, setTimeToLive
メソッドの詳細
getQueue
Queue getQueue() throws JMSException
このQueueSenderに関連付けられたキューを取得します。- 戻り値:
- この送信者のキュー
- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがこのQueueSenderのキューの取得に失敗した場合
send
void send(Message message) throws JMSException
メッセージをキューに送信します。QueueSenderのデフォルトの配信モード、優先度、存続時間を使用します。- 次で指定:
- インターフェース
MessageProducerのsend - パラメーター:
message- 送信するメッセージ- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの送信に失敗した場合。MessageFormatException- 無効なメッセージが指定された場合。InvalidDestinationException- クライアントが無効なキューを持つQueueSenderでこのメソッドを使用する場合。UnsupportedOperationExceptionSE- 作成時にキューを指定しなかったQueueSenderでクライアントがこのメソッドを使用する場合。- 関連事項:
MessageProducer.getDeliveryMode(),MessageProducer.getTimeToLive(),MessageProducer.getPriority()
send
void send(Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
配信モード、優先度、存続時間を指定して、メッセージをキューに送信します。- 次で指定:
- インターフェース
MessageProducerのsend - パラメーター:
message- 送信するメッセージdeliveryMode- 使用する配信モードpriority- このメッセージの優先度timeToLive- メッセージの存続期間 (ミリ秒単位)- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの送信に失敗した場合。MessageFormatException- 無効なメッセージが指定された場合。InvalidDestinationException- クライアントが無効なキューを持つQueueSenderでこのメソッドを使用する場合。UnsupportedOperationExceptionSE- 作成時にキューを指定しなかったQueueSenderでクライアントがこのメソッドを使用する場合。- 関連事項:
Session.createProducer(jakarta.jms.Destination)
send
void send(Queue queue, Message message) throws JMSException
不明なメッセージプロデューサーのキューにメッセージを送信します。QueueSenderのデフォルトの配信モード、優先度、存続時間を使用します。通常、メッセージプロデューサーには作成時にキューが割り当てられます。ただし、Jakarta Messaging API は未確認のメッセージプロデューサーもサポートしているため、メッセージが送信されるたびにキューを指定する必要があります。
- パラメーター:
queue- このメッセージを送信するキューmessage- 送信するメッセージ- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの送信に失敗した場合。MessageFormatException- 無効なメッセージが指定された場合。InvalidDestinationException- クライアントが無効なキューでこのメソッドを使用する場合。- 関連事項:
MessageProducer.getDeliveryMode(),MessageProducer.getTimeToLive(),MessageProducer.getPriority()
send
void send(Queue queue, Message message, int deliveryMode, int priority, long timeToLive) throws JMSException
識別されていないメッセージプロデューサーのキューにメッセージを送信し、配信モード、優先度、存続時間を指定します。通常、メッセージプロデューサーには作成時にキューが割り当てられます。ただし、Jakarta Messaging API は未確認のメッセージプロデューサーもサポートしているため、メッセージが送信されるたびにキューを指定する必要があります。
- パラメーター:
queue- このメッセージを送信するキューmessage- 送信するメッセージdeliveryMode- 使用する配信モードpriority- このメッセージの優先度timeToLive- メッセージの存続期間 (ミリ秒単位)- 例外:
JMSException- 内部エラーのために Jakarta Messaging プロバイダーがメッセージの送信に失敗した場合。MessageFormatException- 無効なメッセージが指定された場合。InvalidDestinationException- クライアントが無効なキューでこのメソッドを使用する場合。