| Oracle® Fusion Middleware Oracle Identity Manager開発者ガイド 11g リリース1(11.1.1) B66705-01 |
|
 前 |
 次 |
Oracle Identity Managerには、ジョブ実行としてスケジュールできる一連のスケジュール済タスクが含まれています。例として、パスワードの期限切れをユーザーに電子メールで送信するパスワード警告タスクをあげることができます。
Oracle Identity Managerには、独自のスケジュール済タスクを作成する機能もあります。事前定義されたスケジュール済タスクがニーズに合わない場合は、要件に合わせてスケジュール済タスクを作成できます。
たとえば、ターゲット・システムで定期的に新しい情報をチェックしてOracle Identity Managerに同じデータを複製するスケジュール済タスクを使用して、リコンシリエーション実行を構成できます。
この章では、カスタム・スケジュール済タスクを作成および実装する方法について説明します。内容は次のとおりです。
この項では、スケジュール済タスクの作成における重要な手順を概説し、プロセスを示す例を紹介します。この後の項では、各手順について詳しく説明します。
新しいスケジュール済タスクを作成する基本手順は、次のとおりです。
Oracle Identity Managerの事前定義されたスケジュール済タスクを確認して、カスタム・タスクが必要かどうかを決定します。
事前定義されたタスクの詳細は、Oracle Fusion Middleware Oracle Identity Managerシステム管理者ガイドのスケジュール済タスクの管理に関する説明を参照してください。
タスク名、タスクが実行するアクションを制御するパラメータなど、スケジュール済タスクの主要な機能を決定します。
詳細は、第6.2項「スケジュール済タスクのメタデータの定義」を参照してください。
タスク・メタデータをスケジュール済タスクXMLファイルに追加します。
詳細は、第6.3項「スケジュール済タスクXMLファイルの構成」を参照してください。
スケジュール済タスクJavaクラスを開発します。
詳細は、第6.4項「スケジュール済タスク・クラスの開発」を参照してください。
新しいスケジュール済タスクをプラグインとして宣言します。
詳細は、第6.5項「プラグインXMLファイルの構成」を参照してください。
Oracle Identity Managerがファイルを検出し、タスクをジョブで使用できるようにするために、タスク・ファイルをパッケージ化します。
詳細は、第6.6項「スケジュール済タスクのディレクトリ構造の作成」を参照してください。
スケジュール済タスクの開発の手順を示すために、特定のITリソースの特定の部門に属する従業員レコードを取得するスケジュール済タスク例を使用します。
また、このスケジュール済タスクでは、ユーザーが取得するレコード数や、無効なレコードを取得に含めるかどうかを指定できる必要があります。
各スケジュール済タスクは、次のメタデータ情報を含みます。
スケジュール済タスクの名前
スケジュール済タスクを実装するJavaクラスの名前
説明
再試行間隔
(オプション)スケジュール済タスクを受け入れるパラメータ。各パラメータには次の追加情報が含まれます。
パラメータ名
パラメータのデータ型
必須/オプション・パラメータ
ヘルプ・テキスト
スケジュール済タスクXMLファイルの構成では、カスタム・スケジュール済タスクの定義が含まれたXMLファイルの更新が伴います。この項では、新しいカスタム・スケジュール済タスクの詳細を使用してタスクXMLファイルを更新する方法について説明します。
Oracle Identity Manager MDSスキーマの/dbネームスペースにあるtask.xmlファイルを変更するか、またはカスタム・スケジュール済タスク・ファイルを作成できます。カスタム・ファイルを作成する場合、そのファイル名はスケジュール済タスク名と同じで、拡張子が.xmlである必要があります。Oracle Identity Manager MDSスキーマの/dbネームスペースに、カスタム・スケジュール済タスク・ファイルをインポートする必要があります。
|
注意: スケジュール済タスクXMLファイルは、Oracle WebLogic Serverのインポート・ユーティリティを使用してMDSにインポートできます。クラスタ環境では、MDSにファイルを含めることで、クラスタの各ノード上のファイルをコピーする必要がなくなります。 MDSへのファイルのインポートの詳細は、第33章「MDSユーティリティとユーザーが修正可能なメタデータ・ファイル」を参照してください。 |
XMLファイル内の要素は、第6.2項「スケジュール済タスクのメタデータの定義」で説明したタスク・パラメータを反映します。
例6-1に、前述の段落で説明したスケジュール済タスクのサンプルXMLコードを示します。この例では、すべてのパラメータが必須パラメータとして宣言されていることに注意してください。
例6-1 スケジュール済タスクのサンプルXML
<scheduledTasks xmlns="http://xmlns.oracle.com/oim/scheduler">
<task>
<name>Test_scheduled_task</name>
<class>oracle.iam.scheduler.TestScheduler</class>
<description>Retrieve Employee Records For Given Department</description>
<retry>5</retry>
<parameters>
<string-param required="true" helpText="Name of the department">Department Name</string-param>
<string-param required="true" encrypted="false" helpText="Name of the department">Department Name</string-param>
<number-param required="true" helpText="Number of Records to Be Retrieved">Number of Records</number-param>
<boolean-param required="false" helpText="Retrieve disabled employee records?">Get Disabled Employees</boolean-param>
</parameters>
</task>
</scheduledTasks>
これは、基本的に、MDSからtask.xmlをエクスポートし、それに必須タグを追加して、MDSにインポートして戻す作業となります。
MDSからtask.xmlファイルをエクスポートし、このファイルに必須タグを追加した後、MDSにインポートして戻す必要があります。MDSファイルのエクスポートおよびインポートの詳細は、第33章「MDSユーティリティとユーザーが修正可能なメタデータ・ファイル」を参照してください。
次の手順では、Javaクラスを作成して、メタデータがXMLファイルで定義されたタスクを実行します。スケジュール済タスクを実装するJavaクラスは、スケジュール済タスク・クラスと呼ばれます。
スケジュール済タスクのJavaクラスを開発するには、次の手順を実行します。
スケジュール済タスクをプラグインとして宣言するには、plugin.xmlファイルを構成する必要があります。プラグインの詳細は、第7章「プラグインの開発」を参照してください。
|
注意: 1つのスケジュール済タスクに対して1つのplugin.xmlファイルを作成することをお薦めします。これは、プラグインが登録解除されると、対応するパッケージが削除されるためです。 |
plugin.xmlファイルを構成するには、次の手順を実行します。
任意のテキスト・エディタを使用して、plugin.xmlファイルを作成します。
|
注意: plugin.xmlファイルは、そのようなファイルがない場合にのみ作成します。既存のプラグインがある場合は、新しいプラグイン用の新しいプラグイン要素を追加します。 |
プラグイン要素のpluginpoint属性の値をoracle.iam.scheduler.vo.TaskSupportに変更して、スケジュール済タスクのプラグイン・ポイントを指定します。
plugin.xmlファイルの次のXMLコード・ブロックは、プラグイン要素内に入力された値を示しています。
<plugins pluginpoint="oracle.iam.scheduler.vo.TaskSupport">
|
注意: スケジュール済タスクの場合、<plugins>要素は、すべてのスケジュール済タスクで同じままです。 |
<plugin>要素を、追加する各スケジュール済タスクに追加します。
プラグイン(この場合はスケジュール済タスク)を実装するクラスを指定するには、プラグイン要素のpluginclass属性の値を、スケジュール済タスクを実装するJavaクラスの名前に変更します。plugin.xmlファイルの次のXMLコード・ブロックは、プラグイン要素内に入力されたサンプル値を示しています。
<plugin pluginclass= "oracle.iam.scheduler.TestScheduler" version="1.0.1" name="scheduler element"/>
変更後、plugin.xmlファイルは次のようになります。
<?xml version="1.0" encoding="UTF-8"?> <oimplugins xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <plugins pluginpoint="oracle.iam.scheduler.vo.TaskSupport"> <plugin pluginclass= "oracle.iam.scheduler.TestScheduler" version="1.0.1" name="scheduler element"> </plugin> </plugins> </oimplugins>
plugin.xmlファイルを保存して閉じます。
スケジュール済タスクの構成の最後の手順は、例6-2で指定したディレクトリ構造のplugin.zipファイルを作成することです。この例では単一のプラグインが追加されますが、複数のプラグインをplugin.zipファイルに含めることができます。スケジューラでは、ファイルが、特定の構造で圧縮され、特定のネーミング規則に従って命名されている必要があります。これにより、Oracle Identity Managerでカスタム・スケジュール済タスクが識別され、ジョブ作成時にそのタスクをOracle Identity Manager管理およびユーザー・コンソールで使用できるようにになります。
次のことに注意してください。
プラグインのXMLファイルは、plugin.xmlという名前である必要があります。
lib/ディレクトリには.JARファイルのみが含まれている必要があります。lib/ディレクトリは、プラグイン・ロジックを実装するクラスが含まれたJARファイル、および依存ライブラリのJARファイルで構成されています。ほとんどの場合、このディレクトリは、plugin.xmlに指定されたすべてのプラグインの実装を含む1つのJARファイルで構成されます。ディレクトリ構造の詳細は、「プラグインの開発」を参照してください。
スケジュール済タスクのディレクトリには、次のファイルが格納されている必要があります。
プラグイン用のXML
JARファイル
作成するすべてのプラグインに対して1つのplugin.zipファイルが存在します。
前述の例では、CLASS_NAME.JARが、第6.4項「スケジュール済タスク・クラスの開発」で作成したJARファイルです。
plugin.zipファイルを作成した後でクラスタ環境にデプロイする場合は、適切なAPIを使用して、そのプラグインをデータベースに登録します。APIを使用してOracle Identity Managerにプラグインを登録する方法の詳細は、APIを使用したプラグインの登録および登録解除に関する説明を参照してください。
|
注意: プラグインのXMLは、plugin.xmlという名前である必要があります。libディレクトリにJARファイルのみが含まれていることを確認してください。 |
