WebOTX Manual V10.2 (第4版) 目次を表示 |
createQueueSession | メッセージ再配信遅延時間を設定してQueueSessionを生成する |
名称 | createQueueConnection − メッセージ再配信遅延時間を設定してQueueSessionを作成する。 |
形式 | package com.nec.webotx.messaging;
public class ClientQueueConnection {
|
説明 | transactedにはトランザクション制御を行うかどうか、 acknowledgeModeには確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間 (秒) で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。 |
戻り値 | javax.jms.QueueSession |
エラー | javax.jms.JMSException |
createTopicSession | メッセージ再配信遅延時間を設定してTopicSessionを生成する |
名称 | createTopicSession − メッセージ再配信遅延時間を設定してTopicSessionを作成する。 |
形式 | package com.nec.webotx.messaging;
public class ClientTopicConnection {
|
説明 | transactedにトランザクション制御を行うかどうか、 acknowledgeModeに確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間 (秒) で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。 |
戻り値 | javax.jms.TopicSession |
エラー | javax.jms.JMSException |
NO_ACKNOWLEDGE | 確認応答なしモード |
名称 | NO_ACKNOWLEDGE − 確認応答なしモードをあらわす変数。 |
形式 | package com.nec.webotx.messaging;
public interface ClientSession {
|
説明 | Session オブジェクトを生成するときの acknowledgeModeに使用します。 確認応答なしモードのSession オブジェクトを生成するときに指定してください。 |
setDeliveryTime(int) | メッセージ配信遅延時間を相対時間 (秒) で指定する |
setDeliveryTime(java.util.Date) | メッセージ配信遅延時間を絶対時刻 (java.util.Date) で指定する |
名称 | setDeliveryTime − Messageの配信遅延時間を相対時間 (秒) で指定する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class MessageImpl {
|
説明 | delaytimeにMessage配信遅延時間を相対時間 (秒) で指定します。メッセージ送信処理実行後、 実際にコンシューマに配信されるのは delaytime時間経過した後になります。 |
戻り値 | ありません。 |
エラー
|
ありません。
|
名称 | setDeliveryTime − Messageの配信遅延時間を絶対時刻 (java.util.Date) で指定する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class MessageImpl {
|
説明 | dateにMessage配信遅延時間を絶対時刻 (java.util.Date) で指定します。メッセージ送信処理実行後、 実際にコンシューマに配信されるのは dateで指定した時刻になります。 |
戻り値 | ありません。 |
エラー | ありません。 |
createSession | メッセージ再配信遅延時間を設定してSessionを生成する |
setEventListener | コネクションにコネクションイベントリスナを設定する |
setConsumerEventListener | コネクションにコンシューマイベントリスナを設定する |
removeConsumerEventListener | コネクションからコンシューマイベントリスナを削除する |
名称 | createSession − メッセージ再配信遅延時間を設定してSessionを生成する |
形式 | package com.nec.webotx.messaging.jms;
public interface Connection extends javax.jms.Connection {
|
説明 | transactedにはトランザクション制御を行うかどうか、 acknowledgeModeには確認応答モードを指定します。 redeliverytimeにメッセージ再配信遅延時間を相対時間 (秒) で指定します。このメソッドを使って生成したセッションを使ってメッセージの受信処理を行い、リカバリを実行すると実際にコンシューマに再配信されるのは redeliverytime時間経過した後になります。 |
戻り値 | javax.jms.Session |
エラー
|
javax.jms.JMSException
|
名称 | setEventListener − コネクションにコネクションイベントリスナを設定する |
形式 | package com.nec.webotx.messaging.jms;
public interface Connection extends javax.jms.Connection {
|
説明 | コネクションクローズや、コネクション再接続に関するイベントが発生した場合に動作する、コネクションイベントリスナを設定します。
listenerには、このコネクションに設定する、コネクションイベントリスナを指定します。
|
戻り値 | ありません。 |
エラー
|
javax.jms.JMSException
|
名称 | setConsumerEventListener − コネクションにコンシューマイベントリスナを設定する |
形式 | package com.nec.webotx.messaging.jms;
public interface Connection extends javax.jms.Connection {
|
説明 | 送信先に対するコンシューマの有無のイベント通知を受けたときに動作する、コンシューマイベントリスナを設定します。
destには、コンシューマイベント通知の受信対象となる送信先を指定します。
listenerには、このコネクションに設定する、コンシューマイベントリスナを指定します。
|
戻り値 | ありません。 |
エラー
|
javax.jms.JMSException
|
名称 | removeConsumerEventListener − コネクションからコンシューマイベントリスナを削除する |
形式 | package com.nec.webotx.messaging.jms;
public interface Connection extends javax.jms.Connection {
|
説明 | 送信先に対するコンシューマイベントリスナを削除します。
destにはコンシューマイベントリスナを削除する送信先を指定します。
|
戻り値 | ありません。 |
エラー
|
javax.jms.JMSException
|
getEventCode | イベントコードを取得する |
getEventMessage | イベントメッセージを取得する |
getBrokerAddress | コネクションの接続先JMSサーバのアドレスを取得する |
getConnection | イベントと関連付けられているコネクションを取得する |
getJMSException | コネクションのクローズ原因となったJMSExceptionを取得する |
CONNECTION_CLOSED_ERROR | JMSサーバ側のエラーによるクローズを示す定数 |
CONNECTION_CLOSED_KILL | 管理者がコネクションをクローズしたことを示す定数 |
CONNECTION_CLOSED_LOST_CONNECTION | ネットワークやJMSサーバ異常によるコネクションのクローズを示す定数 |
CONNECTION_CLOSED_SHUTDOWN | 管理者がJMSサーバをシャットダウンしたことによるクローズを示す定数 |
名称 | getEventCode − イベントコードを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | このイベントのイベントコードを取得します。ConnectionClosedEventでは、次のいずれかの値が返却されます。
ConnectionClosedEvent.CONNECTION_CLOSED_ERROR ConnectionClosedEvent.CONNECTION_CLOSED_KILL ConnectionClosedEvent.CONNECTION_CLOSED_LOST_CONNECTION ConnectionClosedEvent.CONNECTION_CLOSED_SHUTDOWN |
戻り値 | String /td> |
エラー
|
ありません。
|
名称 | getEventMessage − イベントメッセージを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | このイベントのイベントメッセージを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getBrokerAddress − コネクションの接続先JMSサーバのアドレスを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | コネクションが接続していたJMSサーバのアドレスを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getConnection − イベントを受信したコネクションを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | このイベントに関連付けられているコネクションを取得します。 |
戻り値 | javax.jms.Connection |
エラー
|
ありません。
|
名称 | getJMSException − コネクションのクローズ原因となったJMSExceptionを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | コネクションがクローズされる原因となったJMSException例外オブジェクトを取得します。 |
戻り値 | javax.jms.JMSException |
エラー
|
ありません。
|
名称 | CONNECTION_CLOSED_ERROR − JMSサーバ側のエラーによるクローズを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | ConnectionClosedEventのイベントコードです。 JMSサーバ側のエラー (OutOfMemoryErrorなど) により、コネクションがクローズしたことを示します。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()
|
名称 | CONNECTION_CLOSED_KILL − 管理者がコネクションをクローズしたことを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | ConnectionClosedEventのイベントコードです。 管理者が運用管理操作によりコネクションをクローズしたことを示します。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()
|
名称 | CONNECTION_CLOSED_LOST_CONNECTION − ネットワークやJMSサーバ異常によるコネクションのクローズを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | ConnectionClosedEventのイベントコードです。 ネットワークの問題や、JMSサーバプロセスの異常終了、または、内部エラーによりコネクションがクローズしたことを示します。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()
|
名称 | CONNECTION_CLOSED_SHUTDOWN − 管理者がJMSサーバをシャットダウンしたことによるクローズを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionClosedEvent {
|
説明 | ConnectionClosedEventのイベントコードです。 管理者による停止要求によりコネクションがクローズしたことを示します。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionClosedEvent#getEventCode()
|
getEventCode | イベントコードを取得する |
getEventMessage | イベントメッセージを取得する |
getBrokerAddress | コネクションの再接続先JMSサーバのアドレスを取得する |
getConnection | イベントと関連付けられているコネクションを取得する |
CONNECTION_RECONNECTED | コネクションが再接続したことを示す定数 |
名称 | getEventCode − イベントコードを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectedEvent {
|
説明 | このイベントのイベントコードを取得します。ConnectionReconnectedEventでは、次の値が返却されます。
ConnectionReconnectedEvent.CONNECTION_RECONNECTED |
戻り値 | String |
エラー
|
ありません。
|
名称 | getEventMessage − イベントメッセージを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectedEvent {
|
説明 | このイベントのイベントメッセージを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getBrokerAddress − コネクションの再接続先JMSサーバのアドレスを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectedEvent {
|
説明 | コネクションが再接続したJMSサーバのアドレスを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getConnection − イベントと関連付けられているコネクションを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectedEvent {
|
説明 | このイベントに関連付けられているコネクションを取得します。 |
戻り値 | javax.jms.Connection |
エラー
|
ありません。
|
名称 | CONNECTION_RECONNECTED − コネクションが再接続したことを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectedEvent {
|
説明 | ConnectionReconnectedEventのイベントコードです。 コネクションの自動再接続機能が有効になっている場合に、JMSサーバに再接続したことを示します。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionReconnectedEvent#getEventCode()
|
getEventCode | イベントコードを取得する |
getEventMessage | イベントメッセージを取得する |
getBrokerAddress | コネクションの再接続先JMSサーバのアドレスを取得する |
getConnection | イベントと関連付けられているコネクションを取得する |
getJMSException | コネクション再接続失敗の原因となったJMSExceptionを取得する |
CONNECTION_RECONNECT_FAILED | コネクションの再接続失敗を示す定数 |
名称 | getEventCode − イベントコードを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | このイベントのイベントコードを取得します。ConnectionReconnectFailedEventでは、次の値が返却されます。
ConnectionReconnectFailedEvent.CONNECTION_RECONNECT_FAILED |
戻り値 | String |
エラー
|
ありません。
|
名称 | getEventMessage − イベントメッセージを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | このイベントのイベントメッセージを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getBrokerAddress − コネクションの再接続先JMSサーバのアドレスを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | コネクションが再接続を試みたJMSサーバのアドレスを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getConnection − イベントを受信したコネクションを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | このイベントに関連付けられているコネクションを取得します。 |
戻り値 | javax.jms.Connection |
エラー
|
ありません。
|
名称 | getJMSException − コネクション再接続失敗の原因となったJMSExceptionを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | コネクションの再接続失敗の原因となったJMS例外を取得します。 |
戻り値 | javax.jms.JMSException |
エラー
|
ありません。
|
名称 | CONNECTION_RECONNECT_FAILED − コネクションの再接続失敗を示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConnectionReconnectFailedEvent {
|
説明 | ConnectionClosedEventのイベントコードです。 コネクションの自動再接続機能が有効になっている場合に、JMSサーバへの再接続に失敗したことを示します。再接続に失敗するたびに通知を行います。 なお、例外リスナは、再接続の試行回数が上限に達した場合のみに呼び出されます。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConnectionReconnectFailedEvent#getEventCode()
|
getEventCode | イベントコードを取得する |
getEventMessage | イベントメッセージを取得する |
getBrokerAddress | イベントを送信したJMSサーバのアドレスを取得する |
getConnection | イベントを受信したコネクションを取得する |
getDestination | イベントが発生した送信先を取得する |
CONSUMER_NOT_READY | コンシューマが存在しないことを示す定数 |
CONSUMER_READY | コンシューマが存在することを示す定数 |
名称 | getEventCode − イベントコードを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | このイベントのイベントコードを取得します。ConsumerEventでは、次のいずれかの値が返却されます。
ConsumerEvent.CONSUMER_NOT_READY ConsumerEvent.CONSUMER_READY |
戻り値 | String |
エラー
|
ありません。
|
名称 | getEventMessage − イベントメッセージを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | このイベントのイベントメッセージを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getBrokerAddress − イベントを送信したJMSサーバのアドレスを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | このイベントを送信したJMSサーバのアドレスを取得します。 |
戻り値 | String |
エラー
|
ありません。
|
名称 | getConnection − イベントを受信したコネクションを取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | このイベントを受信したコネクションを取得します。 |
戻り値 | javax.jms.Connection |
エラー
|
ありません。
|
名称 | getDestination − イベントが発生した送信先を取得する |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | このイベントが発生した送信先を取得します。 |
戻り値 | javax.jms.Destination |
エラー
|
ありません。
|
名称 | CONSUMER_NOT_READY − コンシューマの準備ができていないことを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | ConsumerEventのイベントコードです。 コンシューマの準備ができていない (コンシューマが存在している状態から存在しない状態になった) ことを示します。 なお、INACTIVE 状態の永続サブスクリプションは「存在しない」とみなされます。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConsumerEvent#getEventCode()
|
名称 | CONSUMER_READY − コンシューマの準備ができたことを示す定数 |
形式 | package com.nec.webotx.messaging.jmq.jmsclient;
public class ConsumerEvent {
|
説明 | ConsumerEventのイベントコードです。 コンシューマの準備ができた (コンシューマが存在しない状態から存在する状態になった) ことを示します。 なお、INACTIVE 状態の永続サブスクリプションは「存在しない」とみなされます。 |
関連項目
|
com.nec.webotx.messaging.jms.notification.ConsumerEvent#getEventCode()
|