CORBA ノーティフィケーション・サービス API のリファレンス

次のいずれかの問題を示します。
Tobj_Events::SUB_INVALID_FILTER_EXPRESSION Tobj_Events::SUB_UNSUPPORTED_QOS_VALUE

次のいずれかの問題を示します。
Tobj_Events::SUB_DOMAIN_BEGINS_WITH_SYSEV Tobj_Events::SUB_EMPTY_DOMAIN Tobj_Events::SUB_EMPTY_TYPE Tobj_Events::SUB_DOMAIN_AND_TYPE_TOO_LONG Tobj_Events::SUB_FILTER_TOO_LONG Tobj_Events::SUB_NAME_TO_LONG Tobj_Events::TRANSIENT_ONLY_CONFIGURATION

CORBA::INV_OBJREF

次の問題を示します。
Tobj_Events::SUB_NIL_CALLBACK_REF

一意のサブスクリプション識別子が返されます。このオペレーションの結果は即時には現れません。このオペレーションからの復帰とイベント配信の実際の開始の間には遅延があります。遅延期間の長さは、コンフィギュレーション次第ではかなり長くなります。この遅延期間に影響する要素の詳細については、データベースの同期を参照してください。

説明

このオペレーションを使用すると、イベントをサブスクライブできます。このオペレーションは、特定のイベントのサブスクリプションを作成するために、ノーティフィケーション・サービスのサブスクライバ・アプリケーションによって呼び出されます。サブスクリプション名、ドメイン名、型名、データ・フィルタ、サービスの品質、およびサブスクライバのコールバック・オブジェクトのオブジェクト・リファレンスが渡されます。コールバック・オブジェクトでは、CosNotifyComm::StructuredPushConsumer IDL インターフェイスがインプリメントされます。

注記シャットダウンおよび再起動するサブスクライバについては、subscription_id を永続ストレージに書き込む必要があります。

データのフィルタ処理を利用するか、あるいは BEA Tuxedo システム・イベントまたは BEA Tuxedo アプリケーションでポストされたイベントをサブスクライブするには、イベントの FML フィールド・テーブル・ファイルの作成およびBEA Tuxedo アプリケーションとの相互運用性を参照してください。

戻り値

注記 1 度だけ起動およびシャットダウンされるノーティフィケーション・サービス・アプリケーションでは、subscription_id を使用してサブスクリプションが自動的にまたはシステム管理者によって取り消されているかどうかを確認できます。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

subscription_id = channel->subscribe(　
          subscription_name,　
          "News", // ドメイン
          "Sports",   // 型
          "",     // データ・フィルタなし
          qos,　
          news_consumer.in()　
        );

Java コード例

Channel::unsubscribe

CORBA IDL

void unsubscribe( in SubscriptionID id );

パラメータ

subscription_id

サブスクリプション識別子

例外

次の問題を示します。
Tobj_Events::INVALID_SUBSCRIPTION_ID

注記このオペレーションの結果は即時には現れません。このオペレーションからの復帰後も、サブスクライバでは一定の期間は継続してイベントを受信できます。その期間は、コンフィギュレーション次第ではかなり長くなります。この期間に影響する要素の詳細については、データベースの同期を参照してください。

説明

アンサブスクライブに使用します。サブスクライバ・アプリケーションでは、このオペレーションを使用してサブスクリプションを終了します。このオペレーションから復帰すると、それ以降にイベントは配信できません。入力パラメータは、サブスクライブ時に取得した SubscriptionID 1 つです。

例

C++ コード例

channel->unsubscribe(subscription_id);

Java コード例

channel.unsubscribe(subscription_id);

Channel::push_structured_event

CORBA IDL

void push_structured_event(
      in   CosNotification::StructuredEvent   notification
);

パラメータ

notification

このパラメータは、CosNotification サービス仕様で定義されている構造化イベントを格納します。

例外

CORBA_IMP_LIMIT

サブスクリプションに関する次のいずれかの問題を示します。
Tobj_Events::POST_UNSUPPORTED_VALUE_IN_ANY Tobj_Events::POST_UNSUPPORTED_PRIORITY_VALUE Tobj_Events::POST_DOMAIN_CONTAINS_SEPARATOR Tobj_Events::POST_TYPE_CONTAINS_SEPARATOR Tobj_Events::POST_SYSTEM_EVENTS_UNSUPPORTED Tobj_Events::POST_EMPTY_DOMAIN Tobj_Events::POST_EMPTY_TYPE Tobj_Events::POST_DOMAIN_AND_TYPE_TOO_LONG

説明

ノーティフィケーション・サービスにイベントをポストするためにポスト元アプリケーションで使用されます。

注記このオペレーションには、トランザクションのコンテキストで使用される際のトランザクションの振る舞いがあります。詳細については、トランザクションの使い方を参照してください。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、イベントの作成とポストを参照してください。

C++ コード例

channel->push_structured_event(notification);

Java コード例

channel.push_structured_event(notification);

Channel::exists

CORBA IDL

boolean exists(in SubscriptionID subscription_id);

パラメータ

subscription_id

サブスクリプション識別子

例外

次の問題を示します。
Tobj_Events::INVALID_SUBSCRIPTION_ID

subscription_id が CosNotification サービス API を使用して作成されたサブスクリプションの識別子ではない場合は、常にこの例外が返されます。

説明

サブスクリプションが存在するかどうかを確認するためにサブスクライバ・アプリケーションによって使用されます。システム管理者はサブスクリプションを手動で削除でき、ノーティフィケーション・サービスでは一時的なサブスクリプションを自動的に削除できるので、サブスクライバ・アプリケーションでは必要に応じてサブスクリプションを再作成できるようにこのオペレーションを使用する必要があります。このオペレーションで使用する subscription_id は、サブスクライブ時に取得した同じ識別子です。

戻り値

サブスクリプションが存在する場合は true、存在しない場合は false が返されます。

例

C++ コード例

if channel->exists (subscription_id) {
    // サブスクリプションは依然として有効
} else {
  // サブスクリプションはもう存在しない

Java コード例

if channel.exists (subscription_id) {
    // サブスクリプションは依然として有効
} else {
  // サブスクリプションはもう存在しない

TOBJ_SimpleEvents::ChannelFactory インターフェイス

ChannelFactory インターフェイスは、イベント・チャネルの検索に使用します。このインターフェイスには、find_channel という 1 つのオペレーションがあります。

このインターフェイスの CORBA IDL は次のとおりです。

module Tobj_SimpleEvents
{
  typedef long   ChannelID;

interface ChannelFactory
{
 Channel find_channel(
   in ChannelID channel_id // DEFAULT_CHANNEL でなければならない
  );
 };
};

Channel_Factory::find_channel

CORBA IDL

Channel find_channel(
      in  ChannelID  channel_id );

パラメータ

このリリースの BEA Tuxedo では、イベント・チャネルは 1 つだけです。したがって、ChannelID は Tobj_SimpleEvents::DEFAULT_CHANNEL (C++) または Tobj_SimpleEvents.DEFAULT_CHANNEL.Value (Java) に設定する必要があります。

例外

次の問題を示します。
Tobj_Events::INVALID_CHANNEL_ID

説明

ポスト元アプリケーションとサブスクライバ・アプリケーションによって使用されます。このオペレーションを使用すると、イベント・チャネルを見つけて、ポスト元ではイベントをポストし、サブスクライバではイベントをサブスクライブおよびアンサブスクライブできます。

戻り値

デフォルト・イベント・チャネルのオブジェクト・リファレンスが返されます。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、イベント・チャネルの取得を参照してください。

C++ コード例

channel_factory->find_channel(
               Tobj_SimpleEvents::DEFAULT_CHANNEL);

Java コード例

channel_factory.find_channel(DEFAULT_CHANNEL.value);

CosNotification サービス API

この節では、BEA Tuxedo CORBA ノーティフィケーション・サービスによってインプリメントされる CosNotification サービスで定義されるオペレーションについて説明します。それらのオペレーションは、オペレーション・セット全体のサブセットです。このサブセットは、BEA シンプル・イベント API の代わりとして使用できる機能的に完全な API です。

この API は、BEA シンプル・イベント API よりも複雑です。それには、2 つの理由があります。まず、CosNotification サービス API がより複雑になっています。次に、CosNotification サービス API の BEA Tuxedo インプリメンテーションでは、サポートされるオペレーションに制限が追加されます。このように複雑でも、性能または柔軟性の点で利点はないので、できる限りに BEA シンプル・イベント API を使用することをお勧めします。

CosNotification API は、可搬性を実現するため、できる限り標準の API を使用する必要がある場合のために用意されています。この API では、機能の点で、シンプル・イベント API を上回る利点は提供されません。この API を使用して開発されたアプリケーションは、ほぼ可搬性がありますが、完全ではありません。その理由は、完全な可搬性を実現できるほど CosNotification サービス API が十分にサポートされていないことです。たとえば、CORBA ベースのノーティフィケーション・サービスで使用するフィルタ処理の文法は COS Trader 文法に基づいています。BEA Tuxedo ではこの文法がサポートされていず、BEA Tuxedo EventBroker の文法に基づく別の文法がサポートされているので、フィルタ処理を必要とするアプリケーションは可搬になりません。同じことが QoS についても言えます。つまり、CosNotification サービス API では CORBA ベースのノーティフィケーション・サービスの標準のサービス品質がサポートされていず、別のサービス品質がサポートされています。

サポートされている CosNotification サービスのクラスの概要

図 2-3 は、このリリースの BEA Tuxedo で (完全または部分的に) インプリメントされている CosNotification サービスのクラスとそれらの関係を示しています。

図2-3 インプリメントされている CosNotification サービスのクラス

各クラスでサポートされているオペレーションについては、以下に要約があります。詳細については、CosNotification サービスのクラスの詳しい説明を参照してください。

CosNotifyChannelAdmin::EventChannelFactory クラス
このクラスは、イベント・ポスト元とサブスクライバ・アプリケーションによって使用されます。このクラスでは、イベントをポスト、サブスクライブ、およびアンサブスクライブするときにチャネル・ファクトリを取得するために使用される get_channel_factory オペレーションがサポートされています。
CosNotifyChannelAdmin::EventChannel クラス
このクラスは、イベント・ポスト元とサブスクライバ・アプリケーションによって使用されます。このクラスでは、次の 3 つのオペレーションがサポートされています。
CosNotifyChannelAdmin::SupplierAdmin クラス
このクラスは、イベント・ポスト元アプリケーションによって使用されます。このクラスでは、obtain_notification_push_consumer オペレーションがサポートされています。ポスト元アプリケーションでは、このオペレーションを使用して、ノーティフィケーション・サービスにイベントをポストするために使用するプロキシ・プッシュ・コンシューマ・オブジェクトを作成します。
CosNotifyChannelAdmin::StructuredProxyPushConsumer クラス
このクラスは、イベント・ポスト元アプリケーションによって使用されます。このクラスでは、次のオペレーションがサポートされています。
CosNotifyFilter::FilterFactory クラス
このクラスは、フィルタ・オブジェクトを作成するためにイベント・サブスクライバ・アプリケーションによって使用されます。このクラスでは、create_filter オペレーションがサポートされています。フィルタ・オブジェクトでは、ドメイン、型、およびフィルタ処理可能データを含めたすべてのデータのフィルタ処理が提供されます。
CosNotifyFilter::Filter クラス
このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスでは、次のオペレーションがサポートされています。
- add_contraints オペレーション－フィルタのドメイン、型、およびデータ・フィルタを設定するために使用します。
- destroy オペレーション－フィルタ・オブジェクトを破棄するために使用します。
CosNotifyChannelAdmin::ConsumerAdmin クラス
このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスでは、次のオペレーションがサポートされています。
- obtain_notification_push_supplier －サブスクライバのコールバック・オブジェクトにイベントを配信するために使用されるプロキシ・プッシュ・サプライヤ・オブジェクトを作成するためにイベント・サブスクライバ・アプリケーションによって使用されます。
- get_proxy_supplier －プロキシ・プッシュ・サプライヤ・オブジェクトのオブジェクト・リファレンスを取得するためにイベント・サブスクライバ・アプリケーションによって使用されます。このオペレーションは、サブスクライバ・アプリケーションがシャットダウンして再起動し、サブスクリプションを取り消す場合にのみ使用されます。その理由は、サブスクライバでは最初の実行のオブジェクト・リファレンスを破棄し、次の実行でオブジェクト・リファレンスを再び取得する必要があるからです。サブスクライバでは、実行をまたがってオブジェクト・リファレンスを再利用することはできません。
CosNotifyChannelAdmin::StructuredProxyPushSupplier クラス
このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスでは、次のオペレーションがサポートされています。
CosNotifyComm::StructuredPushConsumer
このインターフェイスは、イベント・サブスクライバ・アプリケーションによってインプリメントされます。このインターフェイスでは、push_structured_event オペレーションがサポートされています。ノーティフィケーション・サービスでは、このオペレーションを呼び出してイベントをサブスクライバに配信します。

CosNotification サービスのクラスの詳しい説明

この節では、このリリースの BEA Tuxedo でインプリメントされる CosNotification サービスのクラスについて説明します。それらのクラスは、tuxdir\include ディレクトリにある CosNotification サービスの IDL ファイルで完全に記述されています。

注記サポートされていないクラス・オペレーションを使用すると、CORBA::NO_IMPLEMENT 例外が発生します。

CosNotifyFilter::Filter クラス

このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyFilter
{
interface Filter { 
     ConstraintInfoSeq add_constraints (
             in ConstraintExpSeq constraint)
          raises (InvalidConstraint);

      void destroy();
    };
}; //CosNotifyFilter

CosNotifyFilter::Filter::add_constraints

概要

フィルタ・オブジェクトでドメイン、型、およびデータ・フィルタの各パラメータを設定します。

OMG IDL

ConstraintInfoSeq add_constraints (
             in ConstraintExpSeq constraint)
          raises (InvalidConstraint);

例外

CosNotifyFilter::InvalidConstraint

発生することはありません。

次の問題を示します。
Tobj_Events::SUB_INVALID_FILTER_EXPRESSION.

CORBA_IMP_LIMIT

次のいずれかの問題を示します。
Tobj_Notification::SUB_ADD_CONS_ON_TIMED_OUT_FILTER Tobj_Notification::SUB_MULTIPLE_CALLS_TO_ADD_CONS Tobj_Notification::SUB_MULTIPLE_CONSTRAINTS_IN_LIST Tobj_Notification::SUB_MULTIPLE_TYPES_IN_CONSTRAINT Tobj_Notification::SUB_SYSTEM_EVENTS_UNSUPPORTED Tobj_Events::SUB_DOMAIN_BEGINS_WITH_SYSEV Tobj_Events::SUB_EMPTY_DOMAIN Tobj_Events::SUB_EMPTY_TYPE Tobj_Events::SUB_FILTER_TOO_LONG

サブスクライブするときに使用します。このオペレーションは、サブスクライブするイベントの種類を定義するためにサブスクライバ・アプリケーションで使用されます。フィルタ・オブジェクトのドメイン、型、およびデータ・フィルタの各パラメータを設定します。これらのパラメータの説明については、サブスクリプションの作成時に使用するパラメータを参照してください。

説明

注記 add_constraints オペレーションの BEA Tuxedo インプリメンテーションは、呼び出しが 1 回限りであり、プロキシ・オブジェクトにフィルタが追加される前に呼び出す必要があり、イベント型が 1 つの 1 つの制約のみで構成される必要があります。

戻り値

空のリストが返されます。呼び出し側では無視することをお勧めします。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

// フィルタ処理パラメータを設定
// (ドメイン = "News"、型、およびデータ・フィルタなし)
CosNotifyFilter::ConstraintExpSeq constraints;
constraints.length(1);
constraints[0].event_types.length(1);
constraints[0].event_types[0].domain_name =
    CORBA::string_dup("News");
constraints[0].event_types[0].type_name = 
                CORBA::string_dup ("Sports");
// データ・フィルタなし
constraints[0].constraint_expr = CORBA::string_dup("");
CosNotifyFilter::ConstraintInfoSeq_var
add_constraints_results = // この戻り値は無視
     filter->add_constraints(constraints);

Java コード例

CosNotifyFilter::Filter::destroy

概要

フィルタ・オブジェクトを破棄します。

OMG IDL

void destroy();

例外

次の問題を示します。
Tobj_Events::SUB_INVALID_FILTER_EXPRESSION.

説明

アンサブスクライブするときに使用します。このオペレーションは、フィルタ・オブジェクトを破棄するためにサブスクライバ・アプリケーションで使用されます。

注記対応するサブスクリプションを取り消す準備ができるまでは、フィルタ・オブジェクトを破棄しないでください。

CosNotifyFilter::FilterFactory クラス

このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyFilter
{
interface FilterFactory {
   Filter create_filter (
          in string constraint_grammar)
      raises (InvalidGrammar);
   destroy();
  }; 
}; //CosNotifyFilter

CosNotifyFilter::FilterFactory::create_filter

概要

どのイベントがサブスクリプションに配信されるのかを指定します。

OMG IDL

Filter create_filter (
          in string constraint_grammar)
      raises (InvalidGrammar);

例外

CosNotifyFilter::InvalidGrammar

constraint_grammar がサポートされていないことを示します。

説明

新しいフィルタ・オブジェクトを作成するためにサブスクライバ・アプリケーションで使用されます。このフィルタは、どのイベントがサブスクリプションに配信されるのかを指定するために使用します。サブスクライバでは、フィルタを設定して 5 分以内にプロキシに追加する必要があります。5 分以内に追加しないと、フィルタは破棄されます。フィルタの文法は、Tobj_Notification::Constraint_grammar に設定する必要があります。そうしないと、InvalidGrammar 例外が発生します。

戻り値

新しいフィルタのオブジェクト・リファレンスが返されます。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

filter_factory->create_filter(
      Tobj_Notification::CONSTRAINT_GRAMMAR
);

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier クラス

このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyChannelAdmin { interface StructuredProxyPushSupplier : ProxySupplier, CosNotifyComm::StructuredPushSupplier {

    void connect_structured_push_consumer (
           in CosNotifyComm::StructuredPushConsumer push_consumer)
         raises(CosEventChannelAdmin::AlreadyConnected,
                 CosEventChannelAdmin::TypeError );
    };
    // 次のオペレーションが継承される
    void set_qos(in QoSProperties qos) 
         raises (UnsupportedQoS);
    FilterID add_filter (in Filter new_filter );
    Filter get_filter( in FilterID filter )
         raises ( FilterNotFound);
    void disconnect_structured_push_supplier();
    readonly attribute ProxyType     MyType;
  };
}; //CosNotifyChannelAdmin

CosNotifyChannelAdmin::StructuredProxyPushSupplier:: connect_structured_push_consumer

概要

サブスクリプションを完了します。

OMG IDL

void connect_structured_push_consumer (
       in CosNotifyComm::StructuredPushConsumer push_consumer)
     raises(CosEventChannelAdmin::AlreadyConnected,
            CosEventChannelAdmin::TypeError );

例外

CosEventChannelAdmin::TypeError

発生することはありません。

CORBA::INV_OREF

Tobj_Events::SUB_NIL_CALLBACK_REF

次のいずれかの問題を示します。
Tobj_Events::SUB_DOMAIN_AND_TYPE_TOO_LONG Tobj_Events::SUB_NAME_TO_LONG Tobj_Events::TRANSIENT_ONLY_CONFIGURATION Tobj_Notification::SUBSCRIPTION_DOESNT_EXIST.

CORBA::OBJECT_NOT_EXIST

プロキシが存在しません。

CosEventChannelAdmin::AlreadyConnected

connect_structured_push_consumer オペレーションが既に呼び出されていることを示します。

注記例外の定義および対応するマイナー・コードについては、例外のマイナー・コードを参照してください。

説明

このオペレーションは、サブスクライブするときに使用します。このオペレーションは、イベントをサブスクライブするためにサブスクライバ・アプリケーションで使用されます。push_consumer パラメータは、サブスクライバのコールバック・オブジェクトを識別します。

connect_structured_push_consumer が呼び出されると、ノーティフィケーション・サービスはコールバック・オブジェクトの push_structured_event オペレーションを呼び出してサブスクライバにイベントを送信します。connect_structured_push_consumer が既に呼び出されている場合は、AlreadyConnected 例外が発生します。

注記 set_qos と add_filter は、connect_structured_push_consumer を呼び出す前に呼び出す必要があります。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

subscription->connect_structured_push_consumer(
    news_consumer.in()
);

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier::set_qos

概要

サブスクリプションの QoS を設定します。

OMG IDL

void set_qos(in QoSProperties qos) 
         raises (UnsupportedQoS);

Exceptions

UnsupportedQoS

発生することはありません。

ORBA::IMP_LIMIT

次のいずれかの問題を示します。
Tobj_Notification::SUB_MULTIPLE_CALLS_TO_SET_QOS Tobj_Notification::SUB_CANT_SET_QOS_AFTER_CONNECT Tobj_Notification::SUBSCRIPTION_DOESNT_EXIST Tobj_Notification::SUB_UNSUPPORTED_QOS_VALUE

QoS は、サブスクリプションの種類とサブスクリプションの名前という 2 つ要素で構成されます。サブスクリプションの種類は、名前と値のペアを作成して設定します。その名前は Tobj_Notification::SUBSCRIPTION_TYPE で、値は Tobj_Notification::PERSISTENT_SUBSCRIPTION または Tobj_Notification::TRANSIENT_SUBSCRIPTION です。詳細については、サービスの品質を参照してください。

説明

サブスクライブするときに使用します。このオペレーションは、サブスクリプションの QoS を設定するためにサブスクライバ・アプリケーションで使用されます。このオペレーションは、サブスクライバが要求しているサービス品質プロパティ設定をカプセル化する名前と値のペアのシーケンスを入力パラメータとしてとります。

サブスクリプションの名前は、名前と値のペアを作成して設定します。その名前は Tobj_Notification::SUBSCRIPTION_NAME で、値はユーザ定義の文字列です。

このパラメータの詳細については、サブスクリプションの作成時に使用するパラメータを参照してください。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

CosNotification::QoSProperties qos;
qos.length(2);
qos[0].name =
    CORBA::string_dup(Tobj_Notification::SUBSCRIPTION_NAME);
qos[0].value <<= "MySubsription";
qos[1].name =
    CORBA::string_dup(Tobj_Notification::SUBSCRIPTION_TYPE);
qos[1].value <<=
    Tobj_Notification::TRANSIENT_SUBSCRIPTION;

subscription->set_qos(qos);

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier::add_filter

概要

サブスクライバのコールバック・オブジェクトでフィルタ・オブジェクトを設定します。

OMG IDL

add_filter(
      in Filter new_filter
);

例外

次のいずれかの問題を示します。
Tobj_Notification::SUB_MULTIPLE_CALLS_TO_SET_FILTER Tobj_Notification::SUB_ADD_FILTER_AFTER_CONNECT Tobj_Notification::SUB_NIL_FILTER_REF Tobj_Notification::SUB_NO_CUSTOM_FILTERS

CORBA::OBJECT_NOT_EXIST

サブスクリプションが存在しないことを示します。

説明

サブスクライブするときに使用します。このオペレーションは、サブスクライバのコールバック・オブジェクトのフィルタ・オブジェクトを設定するためにサブスクライバ・アプリケーションで使用されます。このオペレーションを使用するアプリケーションがシャットダウンされて再起動される場合は、filter_id を永続ストレージに書き込む必要があります。

注記このオペレーションは、サブスクライバのコールバック・オブジェクトが接続された後に呼び出すことはできません (上記の connect_structured_push_consumer を参照)。また、複数回呼び出すこともできません。さらに、このオペレーションを呼び出すときには、フィルタの制約式が既にフィルタに存在していなくてはなりません (CosNotifyFilter::Filter add_constraints を参照)。

注記イベント・チャネルのデフォルト・フィルタ・ファクトリで作成されたフィルタのみ追加することができます。

戻り値

filter_id が返されます。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

CosNotifyFilter::FilterID filter_id =
      subscription->add_filter(filter.in());

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier::get_filter

概要

サブスクライバのコールバック・オブジェクトに現在関連付けられているフィルタのオブジェクト・リファレンスを取得します。

OMG IDL

Filter get_filter( in FilterID filter )
      raises ( FilterNotFound);

例外

CosNotifyChannelAdmin::FilterNotFound

フィルタを見つけることができなかったことを示します。

説明

再起動可能なサブスクライバでアンサブスクライブする必要があるときに使用します。このオペレーションは、サブスクライバのコールバック・オブジェクトと現在関連付けられているフィルタのオブジェクト・リファレンスを取得するためにサブスクライバ・アプリケーションで使用されます。渡される FilterID は、サブスクライバの StructuredProxyPushSupplier オブジェクトで有効でなければなりません。FilterID がイベント・チャネルと関連付けられているプロキシ・オブジェクトで有効ではない場合は、FilterNotFound 例外がスローされます。このオペレーションは、シャットダウンして再起動されるサブスクライバでのみ使用されます。

制限

このオペレーションでは、次の制限とガイドラインが適用されます。

このオペレーションから返されるフィルタのオブジェクト・リファレンスは、比較操作では使用できません。
このオペレーションから返されるフィルタのオブジェクト・リファレンスは、CosNotifyFilter::Filter::destroy オペレーションで使用できますが、修正したりプロキシ・オブジェクトに追加したりできないのでほとんど役に立ちません。

戻り値

サブスクライバのコールバック・オブジェクトに現在関連付けられているフィルタのオブジェクト・リファレンスが返されます。

例

C++ コード例

CosNotify::Filter_var filter = 
     subscription->get_filter( filter_id() );

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier::
disconnect_structured_push_supplier

概要

アンサブスクライブに使用します。

OMG IDL

void disconnect_structured_push_supplier();

例外

CORBA::OBJECT_NOT_EXIST

接続を解除するサブスクリプションが存在しないことを示します。

説明

アンサブスクライブするときにサブスクライバ・アプリケーションによって使用されます。このオペレーションは、ノーティフィケーション・サービスとサブスクライバのコールバック・オブジェクトの接続を終了するためにサブスクライバ・アプリケーションで使用されます。

注記このオペレーションで、イベントの配信が即座に停止することはありません。このオペレーションからの復帰後も、サブスクライバでは一定の期間は継続してイベントを受信できます。

例

C++ コード例

subscription->disconnect_structured_push_supplier();

Java コード例

CosNotifyChannelAdmin::StructuredProxyPushSupplier::MyType

概要

常に CosNotifyChannelAdmin::PUSH_STRUCTURED プロキシを返します。

OMG IDL

readonly attribute ProxyType MyType

説明

常に CosNotifyChannelAdmin::PUSH_STRUCTURED プロキシを返します。

CosNotifyChannelAdmin::StructuredProxyPushConsumer クラス

このクラスは、イベント・ポスト元アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyChannelAdmin { interface StructuredProxyPushConsumer : ProxyConsumer, CosNotifyComm::StructuredPushConsumer {

    void connect_structured_push_supplier (
          in CosNotifyComm::StructuredPushSupplier push_supplier)
       raises(CosEventChannelAdmin::AlreadyConnected);
    // 次のオペレーションが継承される
    readonly attribute MyType;
    void push_structured_event(
          in CosNotification::StructuredEvent notification ) 
       raises( CosEventComm::Disconnected );
    void disconnect_structured_push_consumer();
   }; 
}; \\StructuredProxyPushConsumer

CosNotifyChannelAdmin::StructuredProxyPushConsumer::
connect_structured_push_supplier

概要

イベントを受信するようにノーティフィケーション・サービスを準備をします。

OMG IDL

void connect_structured_push_supplier (
          in CosNotifyComm::StructuredPushSupplier push_supplier)
       raises(CosEventChannelAdmin::AlreadyConnected);

例外

CosEventChannelAdmin::AlreadyConnected

発生することはありません。

説明

イベントのポスト時にポスト元アプリケーションによって使用されます。このオペレーションを呼び出さないと、ノーティフィケーション・サービスではイベント受信の準備ができません。また、このオペレーションを使用するときには NIL を渡す必要があります。次の順序で使用します。

プロキシを作成します。
このオペレーションを使用してノーティフィケーション・サービスに接続し、NIL を渡します。
イベントをポストします。
ポスト元プログラムを終了する前に、接続を解除します。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、イベントの作成とポストを参照してください。

C++ コード例

proxy_push_consumer->connect_structured_push_supplier(
      CosNotifyComm::StructuredPushSupplier::_nil()
    );

Java コード例

proxy_push_consumer.connect_structured_push_supplier(null);

CosNotifyChannelAdmin::StructuredProxyPushConsumer::
push_structured_event

概要

イベント・チャネルにイベントをポストします。

OMG IDL

void push_structured_event(
        in CosNotification::StructuredEvent notification ) 
     raises( CosEventComm::Disconnected );

例外

CosEventComm::Disconnected

発生することはありません。

次のいずれかの問題を示します。
Tobj_Events::POST_UNSUPPORTED_VALUE_IN_ANY Tobj_Events::POST_UNSUPPORTED_PRIORITY_VALUE Tobj_Events::POST_DOMAIN_CONTAINS_SEPARATOR Tobj_Events::POST_TYPE_CONTAINS_SEPARATOR Tobj_Events::POST_SYSTEM_EVENTS_UNSUPPORTED Tobj_Events::POST_EMPTY_DOMAIN Tobj_Events::POST_EMPTY_TYPE Tobj_Events::POST_DOMAIN_AND_TYPE_TOO_LONG

説明

イベントをポストするときに使用します。このオペレーションは、イベント・チャネルにイベントをポストするためにポスト元アプリケーションで使用されます。

注記このオペレーションは、次の点で標準の CORBA 定義とは異なります。

イベントの Variable ヘッダの優先順位は、(指定する場合は) 1 ～ 100 の範囲の short 値でなければなりません。
(ドメインと型のみのフィルタ処理ではなく) イベントのフィルタ処理可能データのフィルタ処理が必要な場合、またはイベントが BEA Tuxedo サブスクライバによって受信される場合は、制限が追加されます。構造化イベントのフィールド、型、およびフィルタおよびBEA Tuxedo アプリケーションとの相互運用性を参照してください。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、イベントの作成とポストを参照してください。

C++ コード例

proxy_push_consumer->push_structured_event(notification);

Java コード例

proxy_push_consumer.push_structured_event(notification);

CosNotifyChannelAdmin::StructuredProxyPushConsumer::
disconnect_structured_push_consumer

概要

イベントのポストを停止します。

OMG IDL

void disconnect_structured_push_consumer();

説明

イベントをポストするときに使用します。このオペレーションは、イベントのポストを停止するためにポスト元アプリケーションによって使用されます。入力パラメータは不要で、値は返されません。次の順序で使用することをお勧めします。

プロキシを作成します。
ポスト元アプリケーションの実行ごとに接続し接続を解除します。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、イベントの作成とポストを参照してください。

C++ コード例

proxy_push_consumer->disconnect_structured_push_consumer();

Java コード例

proxy_push_consumer.disconnect_structured_push_consumer();

CosNotifyChannelAdmin::StructuredProxyPushConsumer::MyType

概要

常に CosNotifyChannelAmdmin::PUSH_STRUCTURED プロキシを返します。

OMG IDL

readonly attribute ProxyType MyType

説明

常に CosNotifyChannelAmdmin::PUSH_STRUCTURED プロキシを返します。

CosNotifyChannelAdmin::ConsumerAdmin クラス

このクラスは、イベント・サブスクライバ・アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyChannelAdmin
{ interface ConsumerAdmin :

CosNotification::QoSAdmin, CosNotifyComm::NotifySubscribe, CosNotifyFilter::FilterAdmin, CosEventChannelAdmin::ConsumerAdmin {

    ProxySupplier obtain_notification_push_supplier (
           in ClientType ctype,
           out ProxyID proxy_id)
         raises ( AdminLimitExceeded )

    ProxySupplier get_proxy_supplier (
           in ProxyID proxy_id )
        raises ( ProxyNotFound );

  }; 
}; //CosNotifyChannelAdmin

CosNotifyChannelAdmin::ConsumerAdmin::
obtain_notification_push_supplier

概要

プロキシ・プッシュ・サプライヤ・オブジェクトを作成します。

OMG IDL

ProxySupplier obtain_notification_push_supplier (
           in ClientType ctype,
           out ProxyID proxy_id)
         raises ( AdminLimitExceeded )

例外

CosNotifyChannelAdmin::AdminLimitExceeded

発生することはありません。

次の問題を示します。
Tobj_Notification::SUB_UNSUPPORTED_CLIENT_TYPE

説明

サブスクライブするときに使用します。このオペレーションは、プロキシ・プッシュ・サプライヤ・オブジェクトを作成するためにサブスクライバ・アプリケーションで使用されます。構造化イベントのみがサポートされています。つまり、ANY_EVENT と SEQUENCE_EVENT ClientTypes はサポートされていません。したがって、ClientType 入力パラメータは CosNotifyComm::STRUCTURED_EVENT に設定する必要があります。サブスクライバをシャットダウンして再起動する場合で、サブスクリプションがプログラムの複数の実行にまたがって存続する場合は、このオペレーションで返される ProxyID を永続的に保存する必要があります。サブスクライバでは、プロキシ・サプライヤを CosNotifyChannelAdmin::StructuredProxyPushSupplier にナロー変換する必要があります。必要なすべてのオペレーションは 5 分間で完了する必要があります。

注記 1 度だけ起動およびシャットダウンされるノーティフィケーション・サービス・アプリケーションでは、proxy_id を使用してサブスクリプションが自動的にまたはシステム管理者によって取り消されているかどうかを確認できます。

戻り値

このオペレーションでは、新しいプロキシのオブジェクト・リファレンスが返されます。新しい proxy_id も、proxy_id 出力パラメータを通じて返されます。

例

注記ここで紹介するコード例は全体の一部分です。完全なコード例については、サブスクリプションの作成を参照してください。

C++ コード例

CosNotifyChannelAdmin::ProxySupplier_var generic_proxy =
       consumer_admin->obtain_notification_push_supplier(
          CosNotifyChannelAdmin::STRUCTURED_EVENT,
          proxy_id
        );

CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy =
      CosNotifyChannelAdmin::StructuredProxyPushSupplier::_narrow(
            generic_proxy.in ()
          );

Java コード例

CosNotifyChannelAdmin::ConsumerAdmin::get_proxy_supplier

概要

コンシューマ管理オブジェクトの obtain_notification_push_supplier オペレーションを使用して作成されたプロキシ・プッシュ・サプライヤ・オブジェクトを返します。

OMG IDL

    ProxySupplier get_proxy_supplier (
           in ProxyID proxy_id )
        raises ( ProxyNotFound );

例外

CosNotifyChannelAdmin::ProxyNotFound

ProxyID を見つけることができなかったことを示します。

説明

アンサブスクライブするときに使用します。このオペレーションは、コンシューマ管理オブジェクトの obtain_notification_push_supplier オペレーションを使用して作成されたプロキシ・プッシュ・サプライヤ・オブジェクトを返すためにサブスクライバ・アプリケーションで使用されます。ProxyID 入力パラメータは、プロキシ・オブジェクトを一意に識別します。呼び出し側では、一時的なサブスクリプションの配信エラーまたは ntsadmin 管理コマンドによってプロキシ・オブジェクトが破棄される可能性があることを認識していなければなりません。プロキシ・オブジェクトが破棄されると、関連付けられている ProxyID が無効になります。ProxyID が無効な場合は、ProxyNotFound 例外が発生します。サブスクライバでは、プロキシ・サプライヤを CosNotifyChannelAdmin::StructuredProxyPushSupplier にナロー変換する必要があります。

戻り値

既存のプロキシのオブジェクト・リファレンスが返されます。

例

C++ コード例

CosNotifyChannelAdmin::ProxySupplier_var generic_proxy =
        m_consumer_admin->get_proxy_supplier(
          m_subscription_info.news_proxy_id()
        );

CosNotifyChannelAdmin::StructuredProxyPushSupplier_var proxy =
      CosNotifyChannelAdmin::StructuredProxyPushSupplier::_narrow(
          generic_proxy.in()
      );

Java コード例

CosNotifyChannelAdmin::SupplierAdmin クラス

このクラスは、イベント・ポスト元アプリケーションによって使用されます。このクラスの OMG IDL は次のとおりです。

Module CosNotifyChannelAdmin
{ interface SupplierAdmin : CosNotification::QoSAdmin, CosNotifyComm::NotifyPublish, CosNotifyFilter::FilterAdmin, CosEventChannelAdmin::SupplierAdmin {

     ProxyConsumer obtain_notification_push_consumer (
               in ClientType ctype,
               out ProxyID proxy_id)
        raises ( AdminLimitExceeded );
  }; 
}; //SupplierAdmin

CosNotifyChannelAdmin::SupplierAdmin::
obtain_notification_push_consumer

概要

プロキシ・プッシュ・コンシューマ・オブジェクトを作成します。

OMG IDL

ProxyConsumer obtain_notification_push_consumer (
             in ClientType ctype,
             out ProxyID proxy_id)
        raises ( AdminLimitExceeded );

例外

CosNotifyChannelAdmin::AdminLimitExceeded

発生することはありません。