Oracle Messaging Cloud Service REST API

すべてのRESTエンドポイント

接続

接続は、クライアントとOracle Messaging Cloud Service間のメッセージの送信および受信に必要になります。接続は、クライアントとメッセージング・プラットフォームの間の直接通信に必要とされるリソースの開始点です。

クライアントは通常、その送信および受信操作のすべてに1つの接続を使用しますが、必要ならば複数の接続を使用することもできます。 Oracle Messaging Cloud Serviceの各インスタンスには同時に使用される接続の割当て制限があります。あるインスタンスがその接続割当て制限の100%を使用中の場合、新規の接続を作成しようとする試みは失敗します。

新しい接続は次の状況で使用されます。

接続がREST APIによって作成されている
JMS接続がJavaライブラリによって作成されている
メッセージ・プッシュ・リスナーが作成されている

接続の作成: メソッド: put
パス: /connections/{connectionName}
接続の削除: メソッド: delete
パス: /connections/{connectionName}
接続プロパティの更新: メソッド: post
パス: /connections/{connectionName}

永続サブスクリプション

指定されたリクエスト・パラメータに応じて、1つ以上の永続サブスクリプションに関する情報を返します。

永続サブスクリプションのリスト: メソッド: get
パス: /subscriptions

リスナー

メッセージ・プッシュ・リスナー(MPL)は、Oracle Messaging Cloud Serviceインスタンス内に存在するユーザー作成のリソースです。 MPLは、1つのキュー、トピックまたは永続サブスクリプションからメッセージを非同期に受信して、別の宛先にメッセージを送信するか、ユーザー定義URLにHTTPリクエストとしてプッシュします。

リスナーの作成: メソッド: put
パス: /listeners/{listenerName}
リスナーの削除: メソッド: delete
パス: /listeners/{listenerName}
リスナー・プロパティの取得: メソッド: get
パス: /listeners/{listenerName}
リスナーのリスト: メソッド: get
パス: /listeners

メッセージング・コンテキスト

メッセージング・コンテキストは接続、セッション、プロデューサ、コンシューマ、一時宛先およびキュー・ブラウザなどの一時オブジェクトのコンテナです。

メッセージング・コンテキストは、JSESSIONIDクッキーによって識別されます。メッセージング・コンテキストのみに固有のAPIは、メッセージング・コンテキストの有効期限を制御する非アクティブ最大間隔(MII)を取得および設定するためのAPIです。メッセージング・コンテキストが期限切れになると、そこに含まれている一時オブジェクトはすべて閉じて削除されますが、別のメッセージング・コンテキストで作成された一時宛先は例外です。一時宛先が閉じられるのは、その一時宛先を作成した接続が閉じられた場合のみです。

メッセージング・コンテキストの作成は暗黙的な操作です。これは、認証を渡すOracle Messaging Cloud Serviceへの最初のアクセスによって作成されます。

非アクティブ最大間隔の取得: メソッド: get
パス: /maxInactiveInterval
非アクティブ最大間隔の設定: メソッド: post
パス: /maxInactiveInterval

キュー・ブラウザ

キュー・ブラウザは、キュー上のメッセージを削除せずに参照する際に使用されます。キュー・ブラウザはセッションから作成されます。

キュー・ブラウザは、キュー内のすべてのメッセージ、またはメッセージ・セレクタに一致するメッセージのみを参照する際に使用される可能性があります。キューに対するブラウザが作成された後にメッセージがそのキューに送信される場合、そのメッセージはキュー・ブラウザで表示できない可能性があるので注意してください。

メッセージの参照: メソッド: post
パス: /queueBrowsers/{browserName}
キュー・ブラウザの作成: メソッド: put
パス: /queueBrowsers/{browserName}
キュー・ブラウザの削除: メソッド: delete
パス: /queueBrowsers/{browserName}
キュー・ブラウザのプロパティの取得: メソッド: get
パス: /queueBrowsers/{browserName}

キュー

キューは、ポイント・ツー・ポイント通信をサポートする、メッセージを送信できる宛先です。

キューの作成: メソッド: put
パス: /queues/{queueName}
キューの削除: メソッド: delete
パス: /queues/{queueName}
キューのプロパティの取得: メソッド: get
パス: /queues/{queueName}
キューのリスト: メソッド: get
パス: /queues

メッセージの受信

クライアントは、コンシューマを作成するセッションを使用して、メッセージを受信します。 1つのセッションは複数のコンシューマを保有できます。コンシューマは、それらが閉じるか、それらが作成されたセッションが閉じるまで保持されます。

コンシューマは、メッセージがサービスから受信される方法を定義します。コンシューマはメッセージが受信される元の宛先を指定する必要があります。

オプションで、コンシューマでセレクタを指定することによって、受信するメッセージのサブセットを指定できます。セレクタの構文は、URL: javax.jms.Messageclassでjavax.jms.Messageクラスに対するJava APIリファレンスのメッセージ・セレクタに関する項を参照してください。

コンシューマの作成: メソッド: put
パス: /consumers/{consumerName}
コンシューマの削除: メソッド: delete
パス: /consumers/{consumerName}
メッセージの受信: メソッド: post
パス: /consumers/{consumerName}/messages

メッセージの送信

クライアントは、プロデューサを作成するセッションを使用して、メッセージを送信します。 1つのセッションは複数のプロデューサを保有できます。プロデューサは、それらが閉じるか、それらが作成されたセッションが閉じるまで保持されます。

プロデューサは、プロデューサ経由で送信されるメッセージのデフォルトの特性を定義します。プロデューサは、すべてのメッセージが送信される宛先、送信されたメッセージがサービスで格納される方法、送信されたメッセージが期限切れになるまでサービスで格納される期間を指定できます。

プロデューサの作成: メソッド: put
パス: /producers/{producerName}
プロデューサの削除: メソッド: delete
パス: /producers/{producerName}
メッセージの送信: メソッド: post
パス: /producers/{producerName}/messages
プロデューサのプロパティの設定: メソッド: post
パス: /producers/{producerName}

セッション

メッセージを送信または受信するには、事前にセッションを作成する必要があります。セッションでは、メッセージの送信および受信をアトミックなユニットにグループ化したり、取り消したり、再実行することができます。

1つの接続は複数のセッションを保有できます。セッションは、それらが閉じるか、それらが作成された接続が閉じるまで保持されます。

セッションの承認、コミット、ロールバックまたはリカバリ: メソッド: post
パス: /sessions/{sessionName}/state
セッションの作成: メソッド: put
パス: /sessions/{sessionName}
永続サブスクリプションの削除: メソッド: delete
パス: /sessions/{sessionName}/subscriptions/{subscriptionName}
セッションの削除: メソッド: delete
パス: /sessions/{sessionName}

一時キュー

一時キューは、接続が存続する間に作成されるキューです。メッセージは一時キューからのみ、それが作成された接続を通して消費される可能性があります。

一時キューの作成: メソッド: post
パス: /temporaryQueues
一時キューの削除: メソッド: delete
パス: /temporaryQueues/{queueName}
一時キューのリスト: メソッド: get
パス: /temporaryQueues
一時キューのプロパティの取得: メソッド: get
パス: /temporaryQueues/{queueName}

一時トピック

一時トピックは、接続が存続する間に作成されるトピックです。メッセージは一時トピックからのみ、それが作成された接続を通して消費される可能性があります。

一時トピックの作成: メソッド: post
パス: /temporaryTopics
一時トピックの削除: メソッド: delete
パス: /temporaryTopics/{topicName}
一時トピックのリスト: メソッド: get
パス: /temporaryTopics
一時トピックのプロパティの取得: メソッド: get
パス: /temporaryTopics/{topicName}

トピック

トピックは、メッセージを送信できる宛先として、パブリッシュ/サブスクライブや1対多通信をサポートします。

トピックの作成: メソッド: put
パス: /topics/{topicName}
トピックの削除: メソッド: delete
パス: /topics/{topicName}
トピックのプロパティの取得: メソッド: get
パス: /topics/{topicName}
トピックのリスト: メソッド: get
パス: /topics

トポロジ

トポロジAPIにより、クライアントは現在サービス・インスタンスに存在するすべての一時オブジェクト(メッセージング・コンテキスト、接続、セッション、プロデューサ、コンシューマ、キュー・ブラウザおよび一時宛先)を認識できます。

すべてのメッセージング・コンテキストのトポロジの取得: メソッド: get
パス: /messagingcontexts
特定のメッセージング・コンテキストのトポロジの取得。: メソッド: get
パス: /messagingcontexts/{messagingContextID}

使用状況

使用状況APIにより、サービス・インスタンスで特定のリソースを使用している量と、インスタンスに許可される、そのようなリソースの最大量に関する情報が示されます。

リソースの使用状況および制限のXMLまたはJSON表現: メソッド: get
パス: /usage