IScheduledEventProvider Interface

[アーティクル]
12/15/2008

イベントプロバイダホストとホストされる定期的なイベントプロバイダとの対話処理で使用されるメソッドを提供します。イベントプロバイダはイベントを収集し、Notification Services アプリケーションに送信します。このアプリケーションでイベントとサブスクリプション情報が照合され、通知が生成されます。

名前空間: Microsoft.SqlServer.NotificationServices
アセンブリ: Microsoft.SqlServer.NotificationServices (microsoft.sqlserver.notificationservices.dll 内)

構文

'宣言
Public Interface IScheduledEventProvider

public interface IScheduledEventProvider

public interface class IScheduledEventProvider

public interface IScheduledEventProvider

public interface IScheduledEventProvider

解説

ホストされるイベントプロバイダは、Notification Services エンジンによってホストされます。ホストされる定期的なイベントプロバイダは、指定されたスケジュールで実行されます。

このインターフェイスは、ホストされる定期的なイベントプロバイダを開発するためのフレームワークです。ホストされる定期的なイベントプロバイダを開発する場合、そのイベントプロバイダには、このインターフェイスを Notification Services エンジンによって制御されるように実装する必要があります。

このインターフェイスには、次のメソッドが用意されています。

Initialize は、プロバイダホストが、実行前に、イベントプロバイダに自身を初期化するように通知します。
Run は、プロバイダホストが、イベントの収集の開始をイベントプロバイダに指示します。
Terminate は、プロバイダホストが、イベントの収集を停止し、保持しているリソースを解放するようにイベントプロバイダに指示します。

プロバイダホストは、システムの起動時に Initialize を呼び出します。このメソッドは、実行開始準備ができるように、必要なパラメータをイベントプロバイダに渡します。

プロバイダホストは、Initialize の呼び出しが正常に終了した後に、Run を呼び出します。Run の呼び出しは、イベントの収集および送信を開始するようにイベントプロバイダに指示します。

プロバイダホストは、Terminate メソッドを呼び出して、イベントプロバイダにイベントの収集を停止するよう、指示します。プロバイダホストは、イベントプロバイダが応答しない場合 (たとえば、プロバイダホストが Run または Initialize の呼び出しを、指定されたタイムアウト時間内に完了しなかった場合)、またはイベントプロバイダが停止を要求した場合に、この呼び出しを実行します。

メモ :
定期的なイベントプロバイダを使用して新しい情報のデータソースをポーリングする場合、どのイベントデータが新しいかを判別する場合に使用できる "ウォーターマーク" 情報を保持することをお勧めします。たとえば、データベースにバッチの最新送信日時を保存することも考えられます。この方法により、システムに障害が発生し、イベントプロバイダの再起動が必要になった場合に参照できるデータが用意されます。

定期的なイベントプロバイダを使用して新しい情報のデータソースをポーリングする場合、どのイベントデータが新しいかを判別する場合に使用できる "ウォーターマーク" 情報を保持することをお勧めします。たとえば、データベースにバッチの最新送信日時を保存することも考えられます。この方法により、システムに障害が発生し、イベントプロバイダの再起動が必要になった場合に参照できるデータが用意されます。

カスタムイベントプロバイダの詳細については、「カスタムイベントプロバイダの開発」を参照してください。

使用例

ホストされる定期的なイベントプロバイダの開発を開始する場合は、次のインターフェイスの宣言を使用します。

public interface IScheduledEventProvider
{
    void Initialize(
            NSApplication nsApplication,
            String providerName,
            StringDictionary args,
            StopHandler stopDelegate);
    Boolean Run();
    void Terminate();
}

次の例では、イベントプロバイダはログファイルを読み込み、種類が Error であるエントリのイベントを作成しています。

using System;
using System.Collections.Specialized;
using Microsoft.SqlServer.NotificationServices;
using System.Diagnostics;

namespace AdventureWorks.Notifications.ScheduleEventProvider
{
    public class EventLogProvider : IScheduledEventProvider
    {
        // Initialize variables.
        NSApplication errorLogApplication = null;
        EventCollector errorEventCollector = null;
        string eventProviderName = null;
        StringDictionary arguments = null;
        string logName = null;
        DateTime eventDate = System.DateTime.Today;
        string eventClassName = null;

        public EventLogProvider()
        {
            //Add constructor logic here if required.
        }


        // Implement the IScheduledEventProvider.Initialize method.
        public void Initialize(NSApplication application,
            string providerName,
            StringDictionary args,
            StopHandler stopDelegate)
        {
            this.eventProviderName = providerName;
            this.arguments = args;
            this.errorLogApplication = application;

            // This event provider requires three arguments: the 
            // event log to check, the date used to filter the events
            // returned, and the name of the event class.
            if (3 == arguments.Count)
            {
                this.logName = arguments["logName"];
                this.eventDate = 
                    System.Convert.ToDateTime(arguments["eventDate"]);
                this.eventClassName = arguments["eventClass"];
            }
            else
            {
                throw new ArgumentException(
                    "Inadequate number of arguments supplied.");
            }

            // If necessary, validate the argument values.

            // Create the event collector.
            this.errorEventCollector = new EventCollector(
                errorLogApplication, eventProviderName);
        }


        // Implement the IScheduledEventProvider.Run method.
        public bool Run()
        {
            bool returnValue = true;
         
            try
            {
                // Open the event log & review the latest entries.
                EventLog selectedLog = new EventLog();
                selectedLog.Log = logName;
                Event errorEvent = new Event();
                errorEvent.Initialize(
                    errorLogApplication, eventClassName);
                foreach(EventLogEntry entry in selectedLog.Entries)
                {
                    if(entry.TimeWritten >= eventDate)
                        if(entry.EntryType == EventLogEntryType.Error)
                        {   
                            //Create an event for the event log data.
                            errorEvent["LogName"] = logName;
                            errorEvent["Message"] = entry.Message;
                            errorEvent["Source"] = entry.Source;
                            errorEventCollector.Write(errorEvent);
                        }
                }

                // Commit the event batch.
                int eventsSubmitted = errorEventCollector.Commit();
                errorEvent = null;
            }
            catch (Exception e)
            {
                // Provide error handling here if needed.
            }
            return returnValue;
        }


        // Implement the IScheduledEventProvider.Terminate method.
        public void Terminate()
        {
            errorEventCollector.Dispose();
        }
    }
}

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

次の方法で共有

IScheduledEventProvider Interface

構文

解説

使用例

プラットフォーム

開発プラットフォーム

対象プラットフォーム

参照

関連項目

その他のリソース