Package nablarch.common.authorization.role

Annotation Type CheckRole

@Published @Target(METHOD) @Retention(RUNTIME) @Interceptor(Impl.class) @Documented public @interface CheckRole
アクションのメソッドを実行するために必要なロールを、 アクセスしてきたユーザが持つかチェックするInterceptor。

このアノテーションをアクションのメソッドに設定することで、 そのメソッドを実行するために必要なロールをアクセスしてきたユーザが持つかどうかを チェックできるようになる。
アクセスしてきたユーザの識別子は、ThreadContextのgetUserIdメソッドで 取得できるものが利用される。
また、ロールの有無の判定はRoleEvaluatorに委譲して行われる。 このRoleEvaluatorのインスタンスは、システムリポジトリから"roleEvaluator"という名前で 取得したものを使用する。

判定の結果ロールを持たないと判断された場合は、Forbiddenがスローされる。

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CheckRole.Impl
    CheckRoleアノテーションのインターセプタ。

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
    判定の条件となるロールの一覧。

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    anyOf
    ロールの一覧による判定を部分一致とするかどうかのフラグ。

  • Element Details

    • value

      String[] value
      判定の条件となるロールの一覧。
      Returns:
      ロールの一覧

    • anyOf

      boolean anyOf
      ロールの一覧による判定を部分一致とするかどうかのフラグ。

      tureの場合、ロールの一覧で指定したもののうちどれか1つでも ロールを有していれば許可と判定される。
      falseの場合は、ロールの一覧で指定されたものを全て有している場合に 許可と判定される。

      デフォルトはfalse。

      Returns:
      ロールの一覧を部分一致で判定する場合は true
      Default:
      false