Sun Java ロゴ     前へ      目次      索引      次へ     

Sun ロゴ
Sun Java™ System Identity Manager 7.0 ワークフロー、フォーム、およびビュー 

第 2 章
ワークフローサービス

この章では、カスタムワークフローを修正または作成している Identity Manager の実装者が利用できる、Identity Manager のワークフローサービスについて説明します。

Identity Manager には、ユーザーアカウントのプロビジョニングと操作を目的とするプロセスを定義するために、デフォルトのワークフローが用意されています。実装時にこれらのワークフローを変更し、独自のビジネスルールを反映させることができます。ワークフローを使用することで、アカウントプロビジョニングに関する独自のビジネスルールを Identity Manager に実装できます。

関連する章


ワークフローの組み込み変数

ワークフローエンジンは、いくつかの組み込み変数を使用します。これらの変数のほとんどは、ワークフロー内で宣言する必要はありません。組み込み変数は、ワークフローの実行状態の確認に使用できます。また、多くの変数は、ワークフローサービスの影響を受けて設定されます。

表 2-1 ワークフローの組み込み変数 

名前

説明

WF_ACTION_ERROR

直前に実行されたアクションが、エラーを含む結果を返したり、例外をスローしたりした場合は、組み込み変数は true に設定されます。

WF_ACTION_RESULT

この組み込み変数には、直前のアクションから返される WavesetResult オブジェクトが設定されます。この変数は、アクションの WavesetResult を取り込み、それをグローバル TaskInstance の結果に追加せずに処理したい場合に使用します。この変数はリソースのリトライをサポートするために追加されたのが始まりです。リトライのたびにタスク結果にリソースのエラーメッセージを追加することは必ずしも望ましくはないためです。あまり頻繁に使用される変数ではありませんが、アクションの結果をタスク結果に追加する前に調整する場合には便利です。

WF_ACTION_SUPPRESSED

この組み込み変数は、<Condition> 式の評価が false であるためにアクションが実行されない場合に true に設定されます。

WF_ACTION_TIMEOUT

この組み込み変数は、直前に実行されたアクションがタイムアウトになった場合に true に設定されます。

WF_CASE_OWNER

この組み込み変数には、ワークフロータスクを呼び出した管理者の名前が設定されます。

WF_CASE_RESULT

この組み込み変数には、TaskInstance の WavesetResult が設定されます。これは XPRESS または JavaScript で実装されるアクションにおいて結果を取得するために使用されます。WorkflowApplication クラスとして実装されるアクションは WorkflowContext を経由して結果を取り込むことも可能です。WorkflowContext の全体は WF_CONTEXT 変数を使って参照できるため、この変数は絶対に必要であるとは言えませんが、便利ではあります。

WF_CONTEXT

この組み込み変数には、WorkflowContext オブジェクトが設定されます。これは XPRESS または JavaScript で実装されるアクションにおいて結果を取得するために使用されます。WorkflowApplication クラスとして実装されるアクションでは、コンテキストは排除されます。


一般的なセッションワークフローサービスの呼び出しの構造

ワークフローサービスは、ワークフローアクションから呼び出されます。次のコード例は、セッションワークフローサービスアクションの一般的な形式を示しています。

コード例 2-1

<Action class='com.waveset.session.WorkflowServices'>
   <Condition/>
   <Argument name='op' value=workflowServiceOp/>
   <Argument name=argname1>
      <expression>value1expression</expression>
   </Argument>
   <Argument name=argname2>
      <expression>value2expression</expression>
   </Argument>
         br>    <Argument name=argnameN>
      <expression>valueNexpression</expression>
   </Argument>
</Action>

サポートされる各ワークフローサービスには、それぞれ異なる数の、必須および省略可能な引数があります。

サポートされるセッションワークフローサービス

現在、Identity Manager でサポートされるセッションワークフローサービスは次のとおりです。セッションワークフローサービスの呼び出しに指定する op 引数は、次のいずれかの値である必要があります。

op 引数に上記以外の値を指定した場合、ワークフローサービスは次の結果を返します。

'Unknown WorkflowServices op'

また、ワークフローコンテキスト変数 WF_ACTION_ERROR は、NULL 以外の値に設定されます。

addDeferredTask セッションワークフローサービス

Deferred Task Scanner タスクによって認識されるプロパティーを設定するために使用されます。通常、Deferred Task Scanner は、特定のプロパティーを見つけるために、WSUser オブジェクトごとに繰り返し処理を行います。

この方法でユーザーに延期タスクを設定するときは、taskDefinition 引数を使用して任意の値を設定できます。この引数は、任意の値を持つオブジェクトである必要があります。これらの値は、延期タスクが開始されるときに実行されるワークフローに渡されます。

同一タスク定義の複数バージョンの追加

このメソッドによって、同じタスク定義の複数のバージョンをユーザーに追加することができます。

taskDefinition 属性の値として追加引数を渡すことができるのは、taskDefinition が汎用オブジェクトとして定義されている場合に限られます。taskDefinitionmap または List として定義することはできません。


datedescription などの組み込み引数は、呼び出されたワークフローですでに使用できる状態になっています。


表 2-2 AddDeferredTask メソッドの引数 

名前

必要性

有効値

説明

type

なし

タイプのリスト

 

延期タスクが追加されるオブジェクトのタイプを指定します。指定しない場合は、デフォルトのタイプである user と見なされます。

name

あり

 

延期タスクが追加されるオブジェクトの名前を指定します。

task

なし

 

実行する TaskDefinition の名前を指定します。taskDefinition 引数が文字列である場合は、この引数は、プロパティーリストに配置される汎用オブジェクトの名前となります。

taskDefinition

なし

 

タスク定義を指定します。文字列または汎用オブジェクトのいずれかを指定できます。

文字列 -- この引数が文字列である場合は、タスク定義またはタスクテンプレートのいずれかの名前を定義しています。task 引数は、プロパティーリストに配置される汎用オブジェクトの名前です。

汎用オブジェクト -- taskDefinition 引数が汎用オブジェクトである場合は、この引数は、事前に構築されているプロパティー、listObject です。

instanceName

なし

 

作成する TaskInstance の名前を指定します。

date

なし

java.util.Date オブジェクト、または通常形式の文字列のいずれかです。

延期タスクを実行する日付を指定します。

organization

なし

 

TaskInstance を割り当てる組織を指定します。

owner

なし

 

TaskInstance の有効な所有者の名前を指定します (後の管理で使用される)。

description

なし

 

タスク管理ページに表示するために TaskInstance に割り当てるオプションの説明文を指定します。

executeOnce

なし

 

true に設定した場合、延期タスクの実行が1回でも成功すれば次の実行は行われません。

タスクの実行時にエラーが発生しても、タスクが 1 回成功する、または removeDeferredTask メソッドの呼び出しによって手動で削除されるまで、タスクは延期タスクスキャナによって実行され続けます。

audit セッションワークフローサービス

Identity Manager の監査サービスを使用して監査イベントを記録するように、Identity Manager に要求します。監査は、ワークフローを呼び出したワークフロー管理者 (WF_CASE_OWNER) の下に記録されます。

表 2-3 audit メソッドの引数 

名前

必要性

有効値

説明

op

あり

audit

 

type

あり

「タイプ名」を参照

監査対象オブジェクトの Identity Manager タイプ。

logResultErrors

なし

true/false

false の場合、このメソッドは、別のパラメータによって示される 1 つのエラーを記録します。true の場合は、タスク結果に含まれる各エラーメッセージのログレコードを作成します。タスクの結果は、ワークフローコンテキストから取得されます。これは、ワークフローの実行中に発生するすべてのエラーを記録する場合に便利です。

name

なし

 

監査対象のオブジェクトの名前を指定します。

status

なし

success

failure

監査の状態を指定します。状態が伝達されない場合は、失敗と見なされます。

reason

なし

 

現時点では、DATABASE_ACCESS_FAILED にハードコードされています (指定したすべての値は無視される)。

action

あり

「アクション名」を参照

監査対象となる Identity Manager アクションを指定します。

resource

なし

 

監査対象のリソースを指定します。

accountId

なし

 

監査対象の accountId を指定します。

error

なし

 

監査対象のエラーを指定します。

parameters

なし

 

名前と値のペアを持つ java.util.Map オブジェクトである必要があります。このペアは、各イベントに固有です。たとえば、RoleName というパラメータは、通常はユーザーに関連するログレコードで設定されます。

attributes

なし

 

名前と値のペアを持つ java.util.Map オブジェクトである必要があります。これは、監査システムによって、name1=value1;; name2=value2;; という形式でログレコードに記録されます。

通常は、特定のアカウント属性に対する変更の記録に使用されます。

organizations

なし

 

監査対象オブジェクトに関連付けられている組織のリスト (ObjectGroups) を指定します。

戻り値と副作用

指定された情報を持つ監査ログが追加されます。

authorize セッションワークフローサービス

ワークフローの対象が、指定したオブジェクトに対して指定したアクションを実行する、指定した権限を持つかどうかを調べるように、Identity Manager に要求します。ワークフローの対象は、ワークフローを実行している管理者です。これは、組み込み変数 WF_CASE_OWNER の値です。

表 2-4 authorize メソッドの引数

名前

必要性

有効値

説明

op

あり

authorize

 

type

あり

「タイプ名」を参照

認可対象のオブジェクトのタイプを指定します。

name

あり

 

認可対象のオブジェクトの名前を指定します。

right

あり

「権限名」を参照

認可する権限を指定します。

action

あり

「アクション名」を参照

認可するアクションを指定します。

戻り値と副作用

指定したオブジェクトに対して、指定した権限またはアクションが WF_CASE_OWNER に認められない場合、WF_ACTION_ERRORtrue となります。WavesetResult にエラーが格納されます。

checkStringQualityPolicy セッションワークフローサービス

指定したポリシーに対して、文字列の品質を確認します。

表 2-5 checkStringQualityPolicy メソッドの引数

名前

必要性

有効値

説明

policy

あり

 

ポリシーを指定します (String)。

map

なし

 

文字列に含まれてはならないデータのマップを提供します (Map)。

returnNull -- (省略可能) true に設定すると、このメソッドは成功時に NULL オブジェクトを返します。

value

あり

 

調査する文字列の値を指定します (Object)。

pwdhistory

なし

 

ユーザーの過去のパスワードを、大文字の、暗号化された形式で一覧表示します。

owner

あり

 

調査対象となる文字列値のユーザーを指定します。

戻り値と副作用

このメソッドは、checkPolicyResult オブジェクトを返します。true という値は、文字列がポリシーのテストに合格したことを示します。文字列がポリシーテストに合格しなかった場合、このメソッドはエラーメッセージを返します。map パラメータの returnNull オプションを true に設定した場合は、成功時に NULL オブジェクトが返されます。

checkinObject セッションワークフローサービス

指定したオブジェクトが、現時点でメモリ内でどのように表されているかを保持します。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトをチェックインする権限を持っているかどうかを確認します。


オブジェクトを使用するよりも、ビューを使用するほうが便利です。オブジェクトの修正には、ビューを使用してみてください。ビューについては、「Identity Manager のビュー」の章を参照してください。


表 2-6 checkinObject メソッドの引数

名前

必要性

有効値

説明

op

あり

checkinObject

 

object

なし

 

チェックイン対象のオブジェクトを指定します。オブジェクトを指定しない場合、ワークフローサービスは機能しません。

lockedBy

なし

 

オブジェクトのロックに使用された代替ロック名を指定します。

戻り値と副作用

指定したオブジェクトがチェックインされます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

checkinView セッションワークフローサービス

ビューをチェックインします。

表 2-7 checkinView メソッドの引数

名前

必要性

有効値

説明

op

あり

checkinView

 

view

 

なし

 

チェックインするビューを指定します。ビューを指定しない場合、checkinView ワークフローサービスは機能しません。

戻り値と副作用

指定したビューは、Identity Manager のリポジトリにチェックインされます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

checkoutObject セッションワークフローサービス

持続的な Identity Manager オブジェクトを取得し、それをロックします。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトをチェックアウトする権限を持っているかどうかを確認します。


オブジェクトを使用するよりも、ビューを使用するほうが便利です。オブジェクトの修正には、ビューを使用してみてください。ビューについては、「Identity Manager のビュー」を参照してください。


表 2-8 checkOutObject メソッドの引数 

名前

必要性

有効値

説明

op

あり

checkoutObject

 

type

あり

 

チェックアウト対象のオブジェクトのタイプを指定します。

name

あり

 

チェックアウト対象のオブジェクトの名前を指定します。

lockedBy

なし

 

ロックの記録に使用する代替名を指定します。

lockWait

なし

 

ロックに競合がある場合の待機時間を、秒単位で指定します。

戻り値と副作用

チェックアウトに成功すると、チェックアウトされたオブジェクトは object 変数に格納されます。ロックがタイムアウトした場合は、チェックアウトアクションのために WF_ACTION_TIMEOUT が true に設定されます。エラーが発生した場合は (管理者にオブジェクトをチェックアウトする権限がない場合を含む)、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

checkoutView セッションワークフローサービス

Identity Manager ビューをフェッチし、それをロックします。

表 2-9 checkoutView メソッドの引数 

名前

必要性

有効値

説明

op

あり

checkoutView

 

viewid

なし

 

チェックアウトするビューの ID を指定します。この引数を指定しない場合は、タイプと ID の両方を指定してください。ワークフローでは、タイプと ID を使用するほうが容易な場合があります。

name

あり

 

チェックアウト対象のオブジェクトの名前を指定します。

type

なし

 

ビューのタイプを指定します。

id

なし

 

ビューで操作されるオブジェクトの ID。たとえば、アカウントオブジェクトを操作するビューを作成するときは、これは accountId となります。

raiseViewErrors

なし

 

display.errorsWF_ACTION_ERROR に昇格させることを指定します。true に設定すると、ビューの display.errors 属性に含まれるエラーが自動的に抽出され、ワークフローエンジンにエラーとして返されます。WF_ACTION_ERROR ワークフローの変数が設定されます。

subject

なし

 

ビューのチェックアウトを行う Identity Manager 管理者。これを指定しない場合は、ワークフローを呼び出した管理者 (WF_CASE_OWNER) が使用されます。

options

なし

 

ビューに固有のオプション。渡すことができる値は、使用するビューによって異なります。もっとも一般的な値は、ユーザービューです。オプションは、session.UserViewConstants にあります。単純なビューでは、*Viewer.java ファイルでオプションの定数を宣言してください。ワークフローで使用される、その次に一般的なビューは ProcessViewer で、以後、PasswordViewer、DisableViewer、EnableViewer、および RenameViewer が続きます。これらのビューのオプションは、比較的少数です。

戻り値と副作用

チェックアウトに成功すると、チェックアウトされたビューは view 変数に格納されます。ロックがタイムアウトした場合は、チェックアウトアクションのために WF_ACTION_TIMEOUTtrue に設定されます。エラーが発生した場合は (管理者にビューをチェックアウトする権限がない場合を含む)、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

createView セッションワークフローサービス

適切なフォームを使用して、指定したタイプの空のオブジェクトを作成します。

表 2-10 createView メソッドの引数

名前

必要性

有効値

説明

op

あり

createView

 

 

viewid

なし

 

作成するビューの ID を指定します。この引数を指定しない場合は、タイプと ID の両方を指定してください。ワークフローでは、タイプと ID を使用するほうが容易な場合があります。

type

なし

 

ビューのタイプを指定します。

id

なし

 

ビューで操作されるオブジェクトの ID を指定します。たとえば、アカウントオブジェクトを操作するビューを作成するときは、これは accountId となります。

options

なし

 

ビューに固有のオプションを指定します。渡すことができる値は、使用するビューによって異なります。もっとも一般的な値は、ユーザービューです。オプションは、session.UserViewConstants にあります。単純なビューでは、Viewer.java ファイルでオプションの定数を宣言してください。ワークフローで使用される、その次に一般的なビューは ProcessViewer で、以後、PasswordViewer、DisableViewer、EnableViewer、および RenameViewer が続きます。これらのビューのオプションは、比較的少数です。

戻り値と副作用

正しく作成されたビューは view 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

disableUser セッションワークフローサービス

1 つまたは複数の、ユーザーのリソースアカウントを無効にします。

アカウントの無効化には、3 つの方法があります。

2 番目と 3 番目の方法は、基本的には同じです。2 番目の方法では、チェックアウトと、Disable ビューへのチェックインを行います。これは、Identity Manager インタフェースでユーザーを無効にするのと同じです。副次的な影響として、この場合は Disable User ワークフローが呼び出されます。

カスタマイズした Disable User プロセスを実装する場合は、provision.WorkflowServices メソッドを使用します。その他のプロセスを実装する場合に、標準の Disable User プロセスを使用して無効化を行うときは、別の方法のいずれかを使用します。


デフォルトでは、Identity Manager はアカウントを無効にします。アカウントを無効化しないようにするには、disableUser ワークフローに次の引数を追加します。

<Argument name='doWaveset' value='false'/>


表 2-11 disableUser メソッドの引数 

名前

必要性

有効値

説明

op

あり

disableUser

作成するビューの ID を指定します。この引数を指定しない場合は、タイプと ID の両方を指定してください。ワークフローでは、タイプと ID を使用するほうが容易な場合があります。

doWaveset

なし

true/false

無効にするリソースのリストを指定します。アカウントを無効化しないようにするには、この引数を false に設定します。

<Argument name='doWaveset' value='false'/>

services

なし

 

作成するビューの ID を指定します。この引数を指定しない場合は、タイプと ID の両方を指定してください。ワークフローでは、タイプと ID を使用するほうが容易な場合があります。

戻り値と副作用

指定したリソースアカウントは無効化されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

enableUser セッションワークフローサービス

1 つまたは複数の、ユーザーのリソースアカウントを有効にします。

表 2-12 enableUser メソッドの引数

名前

必要性

有効値

説明

op

あり

enableUser

 

accountId

あり

 

アカウントを有効にする Identity Manager ユーザーを指定します。

doWaveset

なし

true/false

true の場合は、Identity Manager アカウントは、このユーザーで有効化されます。値を指定しない場合は、デフォルトとして true が適用され、アカウントは有効化されます。

services

なし

 

有効にするリソースのリストを指定します。この引数を指定しない場合は、ユーザーのすべてのリソースアカウントが有効化されます。

戻り値と副作用

指定したリソースアカウントは有効化されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。


findUser セッションワークフローサービス

Identity Manager リポジトリからユーザーを検索します。この機能は、より柔軟な query メソッドワークフローサービスより古いものです。query メソッドワークフローサービスの使用を検討してください。

表 2-13 findUser メソッドの引数

名前

必要性

有効値

説明

op

あり

findUser

 

attribute Name

あり

 

ユーザーの検索に使用する、Identity Manager の検索可能な属性の名前を指定します。

attribute Value

あり

true/false

ユーザーの検索に使用する、検索可能な属性の値を指定します。

戻り値と副作用

指定した属性の指定した値を持つ、最初に見つかったユーザーの accountId は、accountId 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

getObject セッションワークフローサービス

指定した名前とタイプを持つ Identity Manager オブジェクトを返します。ワークフローを呼び出した管理者 (WF_CASE_OWNER) は、オブジェクトを取得する権限を持つかどうかが確認されます。


オブジェクトを使用するよりも、ビューを使用するほうが便利です。オブジェクトの表示には、ビューを使用してみてください。詳細については、「Identity Manager のビュー」を参照してください。


表 2-14 getObject メソッドの引数

名前

必要性

有効値

説明

op

あり

getObject

 

type

あり

「タイプ名」を参照

Identity Manager からフェッチされるオブジェクトのタイプを指定します。

name

あり

 

Identity Manager からフェッチされるオブジェクトの名前を指定します。

戻り値と副作用

指定したタイプと名前を持つ Identity Manager オブジェクトは、object 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

getProperty セッションワークフローサービス

Identity Manager オブジェクトからプロパティー値を取得します。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトを表示する権限を持っているかどうかを確認します。

表 2-15 getProperty メソッドの引数

名前

必要性

有効値

説明

name

あり

getObject

プロパティーを取得するオブジェクトの名前を指定します。

propertyName

なし

「タイプ名」を参照

オブジェクトから取得するプロパティーの名前を指定します。propertyName を指定しない場合、サービスに効果または戻り値はありません。

戻り値と副作用

オブジェクトに propertyName が見つかると、プロパティーの値が propertyValue 変数に格納されます。エラーが発生した場合は (管理者にオブジェクトを表示する権限がない場合を含む)、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

getResourceObject セッションワークフローサービス

指定したリソースから、タイプと ID によって指定されるリソースオブジェクトを取得します。

表 2-16 getResourceObject メソッドの引数 

名前

必要性

有効値

説明

resourceId

あり

 

有効なリソースオブジェクトを指定します。

objectType

なし

「タイプ名」を参照

リソースの <ObjectType> セクションに定義される、有効なオブジェクトタイプを指定します。

objectId

 

 

このリソースの、有効な完全修飾オブジェクト識別子 (たとえば、dn) を指定します。

options

 

 

要求の動作を制御します。

有効なキーには、取得するオブジェクトの objectType に固有の属性名のリストを示す searchAttrsToGet などがあります。

戻り値と副作用

指定したリソースから、objectTypeobjectId によって指定されるオブジェクトを返します。

getView セッションワークフローサービス

Identity Manager ビューをフェッチします。ワークフローを呼び出した管理者 (WF_CASE_OWNER) は、オブジェクトを表示する権限を持つかどうかが確認されます。

表 2-17 getView メソッドの引数 

名前

必要性

有効値

説明

op

あり

getView

 

viewId

なし

 

フェッチするビューの ID を指定します。この引数を指定しない場合は、タイプと ID の両方を指定してください。ワークフローでは、タイプと ID を使用するほうが容易な場合があります。

type

なし

 

ビューのタイプを識別します。

id

なし

 

ビューでフェッチされるオブジェクトの ID を指定します。たとえば、アカウントオブジェクトを表示するビューをフェッチするときは、これは accountId となります。

raiseViewErrors

なし

true または false

display.errorsWF_ACTION_ERROR に昇格させることを指定します。true に設定すると、ビューの display.errors 属性に含まれるエラーが自動的に抽出され、ワークフローエンジンにエラーとして返されます。WF_ACTION_ERROR ワークフローの変数が設定されます。

options

なし

getView

ビューに固有のオプションを指定します。渡すことができる値は、使用するビューによって異なります。もっとも一般的な値は、ユーザービューです。これらのオプションは、session.UserViewConstants にあります。単純なビューでは、*Viewer.java ファイルでオプションの定数を宣言してください。ワークフローで使用される、その次に一般的なビューは ProcessViewer で、以後、PasswordViewer、DisableViewer、EnableViewer、および RenameViewer が続きます。これらのビューのオプションは、比較的少数です。

戻り値と副作用

正しくフェッチされたビューは view 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

getViewForm セッションワークフローサービス

指定したビューと関連付けられているフォームを返します。

表 2-18 getViewForm メソッドの引数

名前

必要性

有効値

説明

form

なし

 

formId に置き換えられた引数を指定します。

formId

なし

 

取得するフォームの名前または ID を指定します。

op

あり

getViewForm

 

view

なし

 

フォームからフェッチするビューを指定します。この引数を指定しない場合、getViewForm ワークフローサービスは機能しません。

戻り値と副作用

正しくフェッチされたフォームは form 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERROR は true となり、WavesetResult にエラーが格納されます。

listResourceObjects セッションワークフローサービス

指定した resourceIds のリストから、指定したリソースオブジェクトタイプのリソースオブジェクト名のリストを返します。

表 2-19 listResourceObjects メソッドの引数

名前

必要性

有効値

説明

objectType

あり

 

指定されているこの resourceId の、有効なオブジェクトクラスの名前を指定します。NULL の場合は、次の条件で定義されるすべてのオブジェクトタイプのオブジェクトが返されます。

指定した検索コンテナに含まれる、指定した resId

検索範囲と、指定した検索フィルタ

resourceId

なし

 

1 つの resourceId を指定します。この値は、名前が付けられたリソースから取得されます。NULL の場合、メソッドは resourceIdsList 引数を探します。

resourceIdList

あり

 

resourceIds を一覧表示します。これらの ID は、名前が付けられたリソースから取得されます。これは、resourceId 引数が NULL (未定義) の場合にのみ使用されます。

options

なし

 

検索動作を制御する、オプションのマップを指定します。

オプションについては、次の表で説明します。

表 2-20 listResourceObjects メソッドのオプションの値 

オプション

説明

searchContext

検索の実行対象となるコンテキストを指定します。指定しない場合、メソッドは RA_BASE_CONTEXT から値を取得しようとします。RA_BASE_CONTEXT にも値が指定されていない場合は、論理上の上位から検索が行われます。

searchFilter

(省略可能) RFC 1558 に規定されている LDAP 検索フィルタフォーマットでは、1 つまたは複数のオブジェクト <attr name> <condition> <value> が、and または or で連結されます。規定されていない場合は、指定した objectType を使用してフィルタが作成されます。

searchScope

検索対象を、指定した searchContext のコンテキストのみに含まれる現在のオブジェクト、または指定した searchContext に含まれるすべてのサブコンテキストに設定します。

有効な値には、objectoneLevel、または subTree があります。subTree は、指定した searchContext に含まれるすべてのサブコンテキストを対象に検索を実行することを表します。

searchTimeLimit

検索の制限時間を、ミリ秒単位で指定します。検索は、この制限時間内に行われます。

searchAttrsToGet

オブジェクトごとに取得する、objectType に固有の属性名のリストを指定します。

runAsUser

この要求を実行するユーザーの名前を指定します。指定しない場合は、デフォルト値として、リソースプロキシ管理ユーザーが適用されます。

runAsPassword

runAsUser のパスワードを指定します。指定したユーザーとしてリスト要求を実行する権限があることを、リソースに対して認証するために必要とされます。

cache

返されたオブジェクトリストをサーバーがキャッシュするかどうかを指定します。true に設定した場合は、サーバーは返されたオブジェクトリストをキャッシュします。デフォルトは false です。

cacheTimeout

キャッシュがタイムアウトになるまでの制限時間を、ミリ秒単位で指定します (cacheList が true の場合のみ有効)。キャッシュがタイムアウトになると、オブジェクトが、次回の要求時に自動的にリソースから取得されます。

clearCache

キャッシュをクリアし、次回の要求時に、オブジェクトをリソースから再フェッチするように強制します。

queryObjectNames セッションワークフローサービス

指定したクエリー属性と一致する名前のリストを返します。

表 2-21 queryObjectNames メソッドの引数

名前

必要性

有効値

説明

op

あり

queryObjectNames

 

type

あり

 

検索対象のオブジェクトタイプを指定します。

attributes

なし

 

オブジェクトのクエリーに使用する、クエリー可能な属性の名前と値のペアのリストまたはマップを指定します。指定しない場合は、指定したタイプのすべてのオブジェクトが返されます。

single

なし

true

false

true に設定した場合は、指定したクエリーと最初に一致したオブジェクトの名前が返されます。false に設定した場合、または値を指定しない場合は、指定したクエリーと一致するすべてのオブジェクトの名前が返されます。

戻り値と副作用

single が false または未指定の場合は、指定したクエリー属性と一致するオブジェクトの名前リストが queryResult 変数に格納されます。single が true の場合は、指定したクエリー属性と最初に一致するオブジェクトの名前が queryResult 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

queryObjects セッションワークフローサービス

指定したクエリー属性と一致するオブジェクトのリストを返します。

このメソッドは、次のいずれかを受け付けます。

表 2-22 queryObjects メソッドの引数

名前

必要性

有効値

説明

op

あり

queryObjects

 

type

あり

 

検索対象のオブジェクトタイプを指定します。

attributes

なし

 

次のいずれかを指定します。

WSAttribute タイプの要素を含むマップ

AttributeCondition タイプの要素を含むリスト

指定しない場合は、指定したタイプのすべてのオブジェクトが返されます。

single

なし

true

false

true に設定した場合は、指定したクエリーと最初に一致するオブジェクトが返されます。false に設定した場合は、指定したクエリーと一致するすべてのオブジェクトが返されます。

戻り値と副作用

single が false または未指定の場合は、指定したクエリー属性と一致するオブジェクトのリストが queryResult 変数に格納されます。single が true の場合は、指定したクエリー属性と最初に一致するオブジェクトが queryResult 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

queryReferencingRoles セッションワークフローサービス

指定したロールを直接的または間接的に参照するすべてのロールのリストを返します。関連付けられているロールを特定する、対象のロールを指定するために、ロール引数が必要です。

戻り値と副作用

指定したロールが role として渡されると、このメソッドは、結果を queryResult 変数で返します。これは、指定したロールを直接的または間接的に参照する、Identity Manager リポジトリ内のすべてのロールオブジェクトのリストです。

refreshView セッションワークフローサービス

Identity Manager ビューを更新します。

表 2-23 refreshView メソッドの引数

名前

必要性

有効値

説明

op

あり

unlockObject

 

view

なし

 

更新するビューを指定します。この引数を指定しない場合、refreshView ワークフローサービスは機能しません。

raiseViewErrors

なし

true または false

display.errorsWF_ACTION_ERROR に昇格させることを指定します。true に設定すると、ビューの display.errors 属性に含まれるエラーが自動的に抽出され、ワークフローエンジンにエラーとして返されます。WF_ACTION_ERROR ワークフローの変数が設定されます。

戻り値と副作用

正しく更新されたビューは view 変数に格納されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

removeDeferredTask セッションワークフローサービス

Identity Manager オブジェクトから延期タスクを削除するときに使用されます。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトを表示する権限を持っているかどうかを確認します。

表 2-24 removeDeferredTask メソッドの引数 

名前

必要性

有効値

説明

type

なし

有効な値は、タイプのリストです。

 

延期タスクが削除されるオブジェクトのタイプを指定します。指定しない場合は、デフォルトのタイプである user と見なされます。

name

あり

 

延期タスクが削除されるオブジェクトの名前を指定します。

task

なし

 

実行する TaskDefinition の名前を指定します。

taskDefinition

なし

 

完全なタスク定義オブジェクトを指定します。この引数は、次に説明するその他すべてのタスク引数の代わりに使用できます。完全なタスクオブジェクトと、その他の引数の両方を指定した場合は、独立して指定した引数が、タスク定義オブジェクトの引数の値に優先して適用されます。

instanceName

なし

 

作成する TaskInstance の名前を指定します。

date

なし

java.util.Date オブジェクト、または通常形式の文字列のいずれかです。

延期タスクを実行する日付を指定します。

organization

なし

 

TaskInstance を割り当てる組織を指定します。

owner

なし

 

TaskInstance の有効な所有者の名前を指定します (後の管理で使用される)。

description

なし

 

タスク管理ページに表示するために TaskInstance に割り当てるオプションの説明文を指定します。

removeProperty セッションワークフローサービス

Identity Manager オブジェクトのプロパティーを削除します。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトを表示する権限を持っているかどうかを確認します。

表 2-25 removeProperty メソッドの引数

名前

必要性

有効値

説明

name

あり

 

プロパティーを設定するオブジェクトの名前を指定します。

propertyName

なし

 

変更するオブジェクトのプロパティーの名前を指定します。propertyName を指定しない場合、サービスは機能しません。

戻り値と副作用

Identity Manager オブジェクトのプロパティーは削除されます。エラーが発生した場合は (管理者にオブジェクトを表示する権限がない場合を含む)、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

setProperty セッションワークフローサービス

Identity Manager オブジェクトのプロパティーの値を設定します。Identity Manager は、ワークフローを呼び出した管理者が、オブジェクトを表示する権限を持っているかどうかを確認します。

表 2-26 setProperty メソッドの引数

名前

必要性

有効値

説明

name

あり

setObject

プロパティーを設定するオブジェクトの名前を指定します。

propertyName

なし

「タイプ名」を参照

オブジェクトから取得するプロパティーの名前を指定します。propertyName を指定しない場合、サービスは機能しません。

propertyValue

なし

プロパティーに設定する値

propertyValue を指定しない場合、プロパティーは NULL に設定されます。

戻り値と副作用

Identity Manager オブジェクトのプロパティーに、指定した値を設定します。エラーが発生した場合は (管理者にオブジェクトを表示する権限がない場合を含む)、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

unlockObject セッションワークフローサービス

Identity Manager オブジェクトのロックを解除します。ワークフローを呼び出した管理者 (WF_CASE_OWNER) は、オブジェクトを修正する権限を持つかどうかが確認されます。オブジェクトを使用するよりも、ビューのほうが便利です。オブジェクトの修正には、ビューを使用してみてください。

表 2-27 unlockObject メソッドの引数 

名前

必要性

有効値

説明

op

あり

unlockObject

 

type

あり

 

ロック解除の対象となるオブジェクトのタイプを指定します。

name

あり

 

ロック解除の対象となるオブジェクトの名前を指定します。

lockedBy

なし

 

オブジェクトのロックに使用された代替ロック名を指定します。

戻り値と副作用

成功した場合は、指定したオブジェクトのロックが解除されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

unlockView セッションワークフローサービス

Identity Manager ビューのロックを解除します。

表 2-28 unlockView メソッドの引数

名前

必要性

有効値

説明

op

あり

unlockview

 

view

なし

 

ロックを解除するビューを指定します。この引数を指定しない場合、unlockView ワークフローサービスは機能しません。

戻り値と副作用

成功した場合は、指定したビューのロックが解除されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

プロビジョンワークフローサービス

com.waveset.provision.WorkflowServices にもサービスのセットがありますが、これらのサービスは、com.waveset.session.WorkflowServices のメソッドほど使用頻度が高くありません。これらのサービスは、アカウントを管理するための、低レベルの権限です。これをストックワークフローと呼びます。カスタムワークフローでは、これらのサービスを使用するか、checkoutView/checkinView でより高いレベルのビューを使用して、ストックワークフローを呼び出すことができます。

一般的なプロビジョンワークフローサービスの呼び出しの構造

ワークフローサービスは、ワークフローアクションから呼び出されます。プロビジョンワークフローサービスのアクションの一般的な形式は次のとおりです。

<Action class='com.waveset.provision.WorkflowServices'>
   <Condition/>
   <Argument name='op' value=workflowServiceOp/>
   <Argument name=argname1>
      <expression>value1expression</expression>
   </Argument>
   <Argument name=argname2>
      <expression>value2expression</expression>
   </Argument>
         br>    <Argument name=argnameN>
      <expression>valueNexpression</expression>
   </Argument>
</Action>

サポートされる各ワークフローサービスには、それぞれ異なる数の、必須および省略可能な引数があります。

サポートされるプロビジョンワークフローサービス

次のリストは、Identity Manager が現在サポートしているプロビジョンワークフローサービスを示しています。ワークフローサービスの呼び出しに指定する op 引数は、次のいずれかの値である必要があります。

op 引数に上記以外の値を指定した場合、ワークフローサービスは次の結果を返します。

'Unknown WorkflowServices op'

また、ワークフローコンテキスト変数 WF_ACTION_ERROR は、NULL 以外の値に設定されます。

approveProvision プロビジョンワークフローサービス

ユーザーアカウントの承認を記録します。

表 2-29 approveProvision メソッドの引数

名前

必要性

有効値

説明

op

あり

approve

 

user.waveset.accountId または accountId

あり

 

承認する Identity Manager ユーザーの名前を指定します。

options

なし

 

プロビジョニングの特性を指定するオプションを指定します。Javadoc で、com.waveset.provision を参照してください。

ProvisioningOptions。

戻り値と副作用

承認の結果を記録した WavesetResult オブジェクト。

auditNativeChangeToAccountAttributes プロビジョンワークフローサービス

リソースアカウントの 1 つまたは複数の監査可能属性に加えられたネイティブ変更のレポートを生成します。

表 2-30 auditNativeChangeToAccountAttributes メソッドの引数

名前

必要性

有効値

説明

op

あり

auditNativeChangeToAccountAttributes

 

user.waveset.accountId または accountId

あり

 

監査する Identity Manager ユーザーの名前を指定します。

resource

あり

 

監査対象のネイティブ変更が行われたリソースを指定します。

prevAttributes

なし

Map

変更前の属性の名前と値のペアのマップを指定します。

newAttributes

なし

Map

変更後の属性の名前と値のペアのマップを指定します。

formattedChanges

なし

Map

ログに記録する、フォーマットされた変更を指定します。

戻り値と副作用

監査の結果を記録した WavesetResult オブジェクト。

bulkReprovision プロビジョンワークフローサービス

このメソッドは、クエリーのセットを実行し、指定した条件と一致するすべてのユーザーを検索します。その後、このリストを繰り返し、ユーザーを一度に再プロビジョニングします。

このメソッドを使用してすべてのロール更新の自動再プロビジョニングをサポートするには、Role フォームに次のフィールドを追加します。

<Field name='processInputs.reprovision'>

   <Expansion><s>true</s></Expansion>

</Field>

表 2-31 bulkReprovision メソッドの引数

パラメータ

説明

role

ロール名を指定します

roles

ロール名のリスト

organization

組織名を指定します

organizations

組織名のリスト

conditions

LighthouseContext.list オブジェクトに適したクエリーオプションのマップを指定します

options

プロビジョニングオプションを指定します (たとえば、ターゲット、フェッチなど)

maxErrors

処理を停止するまでに許容されるエラーの最大数を指定します

戻り値

successes - 正しく再プロビジョニングされたユーザーを示します

failures - 完全に再プロビジョニングできなかったユーザーを示します

authenticateUserCredentials プロビジョンワークフローサービス

パスワードを使用して、リソースに対しユーザーを認証します。

表 2-32 authenticateUserCredentials メソッドの引数

名前

必要性

有効値

説明

resourceName

あり

 

認証の対象となるリソースの名前を指定します。

accountId

あり

 

名前が付けられたリソースに表示される、このアカウントの ID を指定します。

accountPassword

あり

 

このアカウントのパスワードを指定します (暗号化されていない文字列)。

戻り値

認証への呼び出しの結果を返します。成功した場合は、WFContext の変数 passwordIsValid を true に設定し、失敗した場合は何もしません。

changeResourceAccountPassword プロビジョンワークフローサービス

1 つまたは複数のリソースアカウントのパスワードを変更します。

表 2-33 changeResourceAccountPassword メソッドの引数

名前

必要性

有効値

説明

op

あり

 

 

resources

あり

 

パスワードを変更するリソースのリストを指定します。

options

なし

 

プロビジョニングの特性を指定するオプションを指定します。Javadoc で、com.waveset.provision.ProvisioningOptions を参照してください。

戻り値と副作用

パスワード変更の結果を記録した WavesetResult オブジェクト。

cleanupResult プロビジョンワークフローサービス

タスク結果から NULL の ResultError を削除します。このメソッドは、引数として op をとります。有効な値は、cleanupResult です。

戻り値と副作用

クリーンアップの結果を記録した WavesetResult オブジェクト。

checkDeProvision プロビジョンワークフローサービス

削除前に、アカウントがプロビジョニング解除を必要とするかどうかを調べます。

表 2-34 checkDeProvision メソッドの引数

名前

必要性

有効値

説明

op

あり

checkDeProvision

プロビジョニング解除の必要性を調べる Identity Manager ユーザーの名前を指定します。

user.waveset.accountId または accountId

あり

 

プロビジョニング解除の必要性を調べるユーザーの名前を指定します。

戻り値と副作用

クリーンアップの結果を記録した WavesetResult オブジェクト。

createResourceObject プロビジョンワークフローサービス

リソースオブジェクト (たとえば、グループ) を作成します。

表 2-35 createResourceObject メソッドの引数

名前

必要性

有効値

説明

op

あり

createResourceObject

 

object

なし

GenericObject

指定しない場合は、サービスは、ObjectType の後に名前が指定された引数を探します。たとえば、リソースが ObjectType というグループの管理をサポートする場合に、object 引数が指定されていないときは、サービスは group という引数にリソースオブジェクトが指定されているものと見なします。できる限り、object 引数を使用してください。

objectType

あり

 

Identity Manager リソースは、管理するオブジェクトのタイプを指定できます。この指定には、リソースのプロトタイプ XML に定義される ObjectType 要素リストが使用されます。この引数は、これらの ObjectType のいずれかの名前です。

resourceId

あり

 

オブジェクトの作成先リソースのオブジェクト ID を指定します。

戻り値と副作用

オブジェクト作成の結果を記録した WavesetResult オブジェクト。

deleteResourceAccount プロビジョンワークフローサービス

リソースアカウントを削除します。

表 2-36 deleteResourceAccount メソッドの引数

名前

必要性

有効値

説明

op

あり

deleteResourceAccount

 

user.waveset.accountId または accountId

あり

 

削除する Identity Manager ユーザーの名前を指定します。

resource

あり

 

アカウントの削除が必要なリソースの名前を指定します。

戻り値と副作用

アカウント削除の結果を記録した WavesetResult オブジェクト。

deleteResourceObject プロビジョンワークフローサービス

リソースオブジェクト (たとえば、グループ) を削除します。

表 2-37 deleteResourceObject メソッドの引数 

名前

必要性

有効値

説明

op

あり

deleteResourceObject

 

objectType

あり

 

Identity Manager リソースは、管理するオブジェクトのタイプを指定できます。この指定には、リソースのプロトタイプ XML に定義される ObjectType 要素リストが使用されます。この引数は、これらの ObjectTypes のいずれかの名前です。

object

なし

GenericObject

指定しない場合は、サービスは、ObjectType の後に名前が指定された引数を探します。たとえば、リソースが ObjectType というグループの管理をサポートする場合に、object 引数が指定されていないときは、サービスは group という引数にリソースオブジェクトが指定されているものと見なします。できる限り、object 引数を使用してください。

resourceId

あり

 

オブジェクトを削除するリソースのオブジェクト ID を指定します。

戻り値と副作用

オブジェクト作成の結果を記録した WavesetResult オブジェクト。

deProvision プロビジョンワークフローサービス

Identity Manager アカウント、リソースアカウント、またはその両方を削除します。

表 2-38 deProvision メソッドの引数

名前

必要性

有効値

説明

op

あり

deProvision

 

accountId

あり

 

プロビジョニング解除する Identity Manager ユーザーの名前を指定します。

subject

なし

 

呼び出しの有効な主体を指定します。指定しない場合は、タスクの主体が適用されます。この引数の値として none を指定した場合は、認証は行われません。

options

なし

 

指定しない場合は、次に指定された引数が適用されます。指定した場合は、次に指定された引数が、このオプションマップに含まれる同じ引数に優先して適用されます。

戻り値と副作用

プロビジョニング解除の結果を記録した WavesetResult オブジェクト。

deleteUser プロビジョンワークフローサービス

Identity Manager ユーザーを削除します。

表 2-39 deleteUser メソッドの引数

名前

必要性

有効値

説明

op

あり

deleteUser

 

subject

なし

 

呼び出しの有効な主体を指定します。指定しない場合は、タスクの主体が適用されます。この引数の値として none を指定した場合は、認証は行われません。

user.waveset.accountId または accountID

あり

 

承認する Identity Manager ユーザーの名前を指定します。

options

なし

Map

オプション名とオプション値のペアのマップの値。指定しない場合は、次に指定された引数が適用されます。指定した場合は、次に指定された引数が、このオプションマップに含まれる同じ引数に優先して適用されます。

user.waveset.accountId または accountID

あり

 

削除する Identity Manager ユーザーの名前を指定します。

adminName

なし

 

削除を実行する管理者の名前を指定します。

loginAppName

なし

 

ログインアプリケーションの名前を指定します。

force

なし

true/false

true を指定した場合は、プロビジョニング解除が必要なリソースアカウントの有無に関係なく、ユーザーが削除されます。

戻り値と副作用

ユーザー削除の結果を記録した WavesetResult オブジェクト。

disable プロビジョンワークフローサービス

Identity Manager アカウント、リソースアカウント、またはその両方を無効にします。

表 2-40 disable メソッドの引数

名前

必要性

有効値

説明

op

あり

disable

 

subject

なし

 

呼び出しの有効な主体。指定しない場合は、タスクの主体が適用されます。この引数の値として none を指定した場合は、認証は行われません。

options

なし

 

オプション名とオプション値のペアのマップの値。指定しない場合は、次に指定された引数が適用されます。指定した場合は、次に指定された引数が、このオプションマップに含まれる同じ引数に優先して適用されます。

accountId

なし

 

 

adminName

なし

 

処理を実行する管理者の名前を指定します。

loginAppName

なし

 

ログインアプリケーションの名前を指定します。

doLighthouse

なし

true/false

Identity Manager アカウントを無効にするかどうかを指定します。

doResources

なし

true/false

ユーザーのアカウントを無効にするかどうかを指定します。

doAuthenticators

なし

true/false

true に設定した場合は、すべてのパススルー認証リソースが無効化されます。

戻り値と副作用

無効化の結果を記録した WavesetResult オブジェクト。

enable プロビジョンワークフローサービス

Identity Manager アカウント、リソースアカウント、または両方を有効にします。

表 2-41 enable メソッドの引数

名前

必要性

有効値

説明

op

あり

enable

 

subject

なし

 

呼び出しの有効な主体を指定します。指定しない場合は、タスクの主体が適用されます。この引数の値として none を指定した場合は、認証は行われません。

options

なし

Map

オプション名とオプション値のペアのマップの値。指定しない場合は、次に指定された引数が適用されます。指定した場合は、次に指定された引数が、このオプションマップに含まれる同じ引数に優先して適用されます。

accountId

なし

 

有効化する Identity Manager ユーザーの名前を指定します。

adminName

なし

 

処理を実行する管理者の名前を指定します。

loginAppName

なし

 

ログインアプリケーションの名前を指定します。

doLighthouse

なし

true/false

Identity Manager アカウントを有効にするかどうかを指定します。

doResources

なし

true/false

ユーザーのアカウントを有効にするかどうかを指定します。

doAuthenticators

なし

true/false

true に設定した場合は、すべてのパススルー認証リソースが有効化されます。

戻り値と副作用

有効化の結果を記録した WavesetResult オブジェクト。

getApprovals プロビジョンワークフローサービス

既存のアカウントに割り当てられたロール、組織、およびリソースの承認のリストを決定します。

表 2-42 getApprovals メソッドの引数

名前

必要性

有効値

説明

op

あり

getApprovers

 

user

あり

GenericObject

ユーザーを表示するビューを指定します。

戻り値と副作用

getApprovals ワークフローが成功すると、ユーザーに必要な承認を表す GenericObjectapprovals 変数に返されます。エラーが発生した場合は、WF_ACTION_ERRORtrue となり、WavesetResult にエラーが格納されます。

lockOrUnlock プロビジョンワークフローサービス

指定されたユーザーに関連付けられている Lighthouse アカウントポリシーがロックの有効期限の時刻を指定している場合に、そのユーザーをロックまたはロック解除します。

次のいずれかの条件と一致する場合に、ユーザーのロックは解除されます。

ロックされているユーザーは、ログインアプリケーションインタフェース (たとえば、ユーザーまたは管理者インタフェース) からログインできません。デフォルトでは、パスワードログインの失敗試行回数が、ユーザーの Lighthouse アカウントポリシーで許可されている回数を超えた場合に、Password Login プロセスの Failure アクティビティーによって lock サービスが呼び出されます。

引数

lock -- (ブール型) ユーザーがロックされているかどうかを示します (ロックされている場合は true)。

戻り値と副作用

ロック要求の場合は、このメソッドは NULL を返します。ロック解除要求の場合は、ロック解除の結果を含む WavesetResult を返します。

notify プロビジョンワークフローサービス

通知を送信します。ほとんどの場合は、電子メールが使用されます。

表 2-43 notify メソッドの引数

名前

必要性

有効値

説明

op

あり

notify

 

type

あり

 

通知のタイプを指定します。指定しない場合は、電子メールタイプが適用されます。

その他の各種引数

なし。ただし、できるだけ指定してください。

 

通知ツールに渡される引数を指定します。名前と値のペアのマップ。

戻り値と副作用

通知の結果を記録した WavesetResult オブジェクト。

provision プロビジョンワークフローサービス

新しい Identity Manager アカウントと、(オプションとして) リソースアカウントを作成します。

表 2-44 provision メソッドの引数

名前

必要性

有効値

説明

op

あり

Provision

 

user

あり

GenericObject

プロビジョニングされるビューを含む GenericObject を指定します。

各種プロビジョニングオプション

なし

 

プロビジョニングの特性を指定するオプションを指定します。Javadoc で、com.waveset.provision.ProvisioningOptions を参照してください。

戻り値と副作用

プロビジョニングの結果を記録した WavesetResult オブジェクト。

questionLock プロビジョンワークフローサービス

ユーザーをロックしますが、ロックの有効期限の日時は設定しません。

このサービスによってロックされたユーザーは、ユーザーのロック解除機能持つ管理者が明示的にロック解除できます。管理者がこのユーザーのロックを解除しない場合、次にユーザーのパスワードが変更またはリセットされると、そのユーザーのアカウントは自動的にロック解除されます。このサービスによってロックされたユーザーも、「パスワードをお忘れですか」ページ以外の Identity Manager アプリケーションインタフェースからはログイン可能です。

デフォルトでは、質問ログインの失敗試行回数が、ユーザーの Lighthouse アカウントポリシーで許可されている回数を超えた場合に、Question Login プロセスの Failure アクティビティーによって questionLock サービスが呼び出されます。

戻り値と副作用

NULL が返されます。

reject プロビジョンワークフローサービス

リソースアカウントの却下を記録します。

表 2-45 reject メソッドの引数

名前

必要性

有効値

説明

op

あり

reject

 

user.waveset.accountId または accountId

あり

 

却下する Identity Manager ユーザーの名前を指定します。

options

なし

Map

プロビジョニングの特性を指定するオプションを指定します。Javadoc で、com.waveset.provision.ProvisioningOptions を参照してください。

戻り値と副作用

却下の結果を記録した WavesetResult オブジェクト。

reProvision プロビジョンワークフローサービス

既存の Identity Manager アカウントを更新します。

表 2-46 reProvision メソッドの引数

名前

必要性

有効値

説明

op

あり

reProvision

 

user

あり

GenericObject

再プロビジョニングされるビューを含む GenericObject を指定します。

各種プロビジョニングオプション

なし

 

プロビジョニングの特性を指定するオプションを指定します。Javadoc で、com.waveset.provision.ProvisioningOptions を参照してください。

戻り値と副作用

再プロビジョニングの結果を記録した WavesetResult オブジェクト。

runResourceAction プロビジョンワークフローサービス

リソースの指定されたリソースアダプタに対して、リソースアクションを実行します。

リソースアクションは、直接 (resourceAction を使用)、または ID (resourceId を使用) で指定できます。resourceAction がリソースアクションを正しく参照する場合は、その値は、resourceId に指定されている ID に優先して適用されます。

このメソッドには、認証チェックは含まれません。リソースアクションに適用されるすべての規則が適用されます。

表 2-47 runResourceAction メソッドの引数

名前

必要性

有効値

説明

resourceId

 

 

使用するリソースを指定します。

resourceAction

 

 

(省略可能) 実行するリソースアクションを指定します。この値は、resourceId に指定されている ID に優先して適用されます。

resourceActionId

 

 

アダプタが実行するリソースアクションを ID で指定します。

resourceActionArgs

 

 

このメソッドが使用する引数のマップを提供します。これらの引数は、環境値としてアクションのスクリプトに渡されます。変数の名前は、RESACTIONARG_<key> で、値はそのキーに対応する値です。キーと値は、文字列で指定する必要があります。


前述した変数へのアクセスには、例外があります。ACTIONS をサポートする HostAccessResourceAdapter サブクラスは、アクションの実行に JavaScript を使用し、引数は additionalArgs というグローバル変数に渡されます。


戻り値と副作用

実行したアクションの結果を記録した WavesetResult オブジェクト。

updateResourceObject プロビジョンワークフローサービス

リソースオブジェクト (たとえば、グループ) を更新します。

表 2-48 updateResourceObject メソッドの引数

名前

必要性

有効値

説明

op

あり

updateResourceObject

 

objectType

あり

 

Identity Manager リソースは、管理するオブジェクトのタイプを指定できます。この指定には、リソースのプロトタイプ XML に定義される ObjectType 要素リストが使用されます。この引数は、これらの ObjectTypes のいずれかの名前です。

group

あり

GenericObject

リソースで更新する GenericObject を指定します。指定しない場合は、サービスは、ObjectType の後に名前が指定された引数を探します。たとえば、リソースが、group というオブジェクトタイプの管理をサポートしているとします。object 引数を指定しない場合、サービスは、group という引数にリソースオブジェクトが指定されているものと見なします。できる限り、object 引数を使用してください。

resourceId

あり

 

オブジェクトを更新するリソースのオブジェクト ID を指定します。

戻り値と副作用

オブジェクト更新の結果を記録した WavesetResult オブジェクト。


タイプ名

次に、Identity Manager で使用される有効なタイプ名を示します。


権限名

次に、Identity Manager で使用される有効な権限名を示します。


アクション名

次に、Identity Manager で使用される有効なアクション名を示します。



前へ      目次      索引      次へ     


Part No: 820-1582.   Copyright 2006 Sun Microsystems, Inc. All rights reserved.