nablarch.common.permission

クラス PermissionCheckHandler

java.lang.Object

nablarch.common.permission.PermissionCheckHandler

すべての実装されたインタフェース:

Handler<java.lang.Object,java.lang.Object>

直系の既知のサブクラス:

PermissionCheckHandler

public class PermissionCheckHandler
extends java.lang.Object
implements Handler<java.lang.Object,java.lang.Object>

認可判定を行うハンドラ。

このクラスを使用する場合は、下記プロパティを設定する。

permissionFactory

Permissionを生成するPermissionFactory。必須。

ignoreRequestIds

認可判定を行わないリクエストID。オプション。
複数指定する場合はカンマ区切り。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PermissionCheckHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	handle(java.lang.Object inputData, ExecutionContext context) リクエストIDを使用して認可判定を行う。
PermissionCheckHandler	setIgnoreRequestIds(java.lang.String... requestIds) 認可判定を行わないリクエストIDを設定する。
PermissionCheckHandler	setPermissionFactory(PermissionFactory permissionFactory) Permissionを生成するPermissionFactoryを設定する。
PermissionCheckHandler	setUsesInternalRequestId(boolean usesInternal) 開閉局状態の判定を内部リクエストIDを用いて行うか否かを設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PermissionCheckHandler

public PermissionCheckHandler()

メソッドの詳細

handle

public java.lang.Object handle(java.lang.Object inputData,
                               ExecutionContext context)
                        throws Forbidden

リクエストIDを使用して認可判定を行う。

下記の順に処理を行う。

1. ThreadContextからリクエストIDを取得し、認可判定の対象リクエストかをチェックする。
   対象でない場合は、認可判定を行わずに次のハンドラに処理を委譲する。
2. ThreadContext.getUserId()からユーザIDを取得する。
   ユーザIDが設定されていない場合は、認可判定を行わずに次のハンドラに処理を委譲する。
3. ユーザに紐付く認可情報を取得し、認可判定を行う。
   認可判定に成功した場合は、ThreadContextにPermissionを設定し、次のハンドラに処理を委譲する。
   認可判定に失敗した場合は、指定されたリソースパスとステータスコードを使用してForbiddenをスローする。

定義:

handle インタフェース内 Handler<java.lang.Object,java.lang.Object>

パラメータ:

inputData - 処理対象データ

context - 実行コンテキスト

戻り値:

処理結果

例外:

Forbidden - 認可判定に失敗した場合(nablarch.fw.Result$Forbidden)

setPermissionFactory

public PermissionCheckHandler setPermissionFactory(PermissionFactory permissionFactory)

Permissionを生成するPermissionFactoryを設定する。

パラメータ:

permissionFactory - Permissionを生成するPermissionFactory

戻り値:

自身のインスタンス

setIgnoreRequestIds

public PermissionCheckHandler setIgnoreRequestIds(java.lang.String... requestIds)

認可判定を行わないリクエストIDを設定する。

パラメータ:

requestIds - 認可判定を行わないリクエストID

戻り値:

自身のインスタンス

setUsesInternalRequestId

public PermissionCheckHandler setUsesInternalRequestId(boolean usesInternal)

開閉局状態の判定を内部リクエストIDを用いて行うか否かを設定する。 明示的に設定しなかった場合のデフォルトは true (内部リクエストIDを使用する。)

パラメータ:

usesInternal - 内部リクエストIDを使用して判定を行う場合は true 常に外部から送信されたリクエストIDを使って判定を行う場合は false

戻り値:

このハンドラインスタンス自体