パッケージ jakarta.security.jacc
インターフェース PolicyContextHandler
public interface PolicyContextHandler
このインターフェースは、PolicyContext
クラスによって登録およびアクティブ化されるハンドラーによって実装される必要があるメソッドを定義します。PolicyContext
クラスは、コンテナーがコンテナー固有のPolicyContext
ハンドラーを登録およびアクティブ化するためのメソッドを提供します。Policy
プロバイダーは、PolicyContext
クラスを使用してハンドラーをアクティブ化し、(コンテナーから)追加のポリシー関連コンテキストを取得して、アクセス決定に適用します。PolicyContext
クラスを介して登録およびアクティブ化されるすべてのハンドラーは、PolicyContextHandler
インターフェースを実装する必要があります。- 作成者:
- Ron Monzillo, Gary Ellison
- 関連事項:
PolicyContext
,PolicyContextException
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ObjectSE
getContext(StringSE key, ObjectSE data)
この public メソッドは、PolicyContext
クラスによって使用され、ハンドラーをアクティブにし、(大文字と小文字を区別する)キーで識別されるコンテキストオブジェクトをハンドラーから取得します。StringSE[]
getKeys()
この public メソッドは、ハンドラーによってサポートされるコンテキストオブジェクトを識別するキーを返します。boolean
supports(StringSE key)
この public メソッドは、ハンドラーが(大文字と小文字を区別する)キー値で識別されるコンテキストオブジェクトをサポートするかどうかを示すブール結果を返します。
メソッドの詳細
supports
boolean supports(StringSE key) throws PolicyContextException
この public メソッドは、ハンドラーが(大文字と小文字を区別する)キー値で識別されるコンテキストオブジェクトをサポートするかどうかを示すブール結果を返します。- パラメーター:
key
- ハンドラーがサポートできるコンテキストオブジェクトを識別するString
値。このパラメーターの値は null であってはなりません。- 戻り値:
- 引数キーに対応するコンテキストオブジェクトがハンドラーによって処理されるかどうかを示すブール値。
- 例外:
PolicyContextException
- 実装がメソッドシグネチャーで説明されていないチェック済み例外をスローした場合実装クラスによってスローされた例外は、スローされた PolicyContextException に(構築中に)カプセル化されます。
getKeys
StringSE[] getKeys() throws PolicyContextException
この public メソッドは、ハンドラーによってサポートされるコンテキストオブジェクトを識別するキーを返します。ハンドラーでサポートされる各キーの値は、null 以外のString
値である必要があります。- 戻り値:
- ハンドラーによってサポートされるコンテキストオブジェクトを識別する
String
値を含む配列。配列に重複するキー値が含まれていてはなりません。万が一、ハンドラーがキーをサポートしない場合、ハンドラーは長さ 0 の配列を返す必要があります。このメソッドによって null 値が返されることはありません。 - 例外:
PolicyContextException
- 実装がメソッドシグネチャーで説明されていないチェック済み例外をスローした場合実装クラスによってスローされた例外は、スローされた PolicyContextException に(構築中に)カプセル化されます。
getContext
ObjectSE getContext(StringSE key, ObjectSE data) throws PolicyContextException
この public メソッドは、PolicyContext
クラスによって使用され、ハンドラーをアクティブにし、(大文字と小文字を区別する)キーで識別されるコンテキストオブジェクトをハンドラーから取得します。キーに加えて、ハンドラーは、PolicyContext
クラス内でこのメソッドの呼び出しが行われたスレッドに関連付けられたハンドラーデータ値でアクティブ化されます。スレッドに関連付けられたポリシーコンテキスト識別子は、PolicyContext.getContextID() を呼び出すことによってハンドラーで使用できることに注意してください。
- パラメーター:
key
- ハンドラーによって返されるコンテキストオブジェクトを識別する String。このパラメーターの値は null であってはなりません。data
- このメソッドの呼び出しが行われたスレッドに関連付けられたハンドラーデータObject
このパラメーターを介して渡される値はnull
である可能性があることに注意してください。- 戻り値:
- 必要なコンテキストを含むコンテナーおよびハンドラー固有の
Object
。対応するコンテキストの値が null の場合、null
値が返されることがあります。 - 例外:
PolicyContextException
- 実装がメソッドシグネチャーで説明されていないチェック済み例外をスローした場合実装クラスによってスローされた例外は、スローされた PolicyContextException に(構築中に)カプセル化されます。