Interface AuthManager

All Superinterfaces:
Manager

public interface AuthManager
extends Manager
セキュリティ管理クラス。
  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  AuthManager.GroupOidListType  
  • Method Summary

    Modifier and Type Method Description
    boolean canResetCredential()
    パスワードリセットが可能か否か。
    boolean canResetCredential​(java.lang.String policyName)
    指定の認証ポリシーの定義下において、パスワードリセットが可能か否か。 複数のパスワードリセット可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
    boolean canResetLockoutStatus()
    アカウントロックアウトの(apiによる)解除が可能か否か。
    boolean canResetLockoutStatus​(java.lang.String policyName)
    指定の認証ポリシーの定義下において、 アカウントロックアウトの(apiによる)解除が可能か否か。 複数のアカウントロックアウト解除可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
    boolean canUpdateCredential()
    パスワード更新が可能か否か。
    boolean canUpdateCredential​(java.lang.String policyName)
    指定の認証ポリシーの定義にて、パスワード更新が可能か否か。 複数のパスワード更新可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
    <T> T doPrivileged​(java.util.function.Supplier<T> action)  
    AuthContext getContext()  
    java.lang.String[] getGroupOids​(AuthManager.GroupOidListType type, java.lang.String... groupCode)
    groupCodeで指定したグループのoid(のリスト)を一括で取得する。 typeによって、子グループ、親グループのoidのリストを一括で取得可能。
    void login​(Credential credential)  
    void logout()  
    void reAuth​(Credential credential)
    現在のログインセッションを信頼されたものにするために再認証する(セッション内に格納されているユーザ情報以外のものは保持される)。
    void resetCredential​(Credential credential)
    パスワードをリセットする。
    void resetCredential​(Credential credential, java.lang.String policyName)
    指定の認証ポリシーの定義かにおいてパスワードをリセットする。 複数のパスワードリセット可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
    void resetLockoutStatus​(java.lang.String accountId)
    アカウントロックアウトの解除をする。
    void resetLockoutStatus​(java.lang.String accountId, java.lang.String policyName)
    指定の認証ポリシーの定義下においてアカウントロックアウトの解除をする。 複数のアカウントロックアウト解除可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
    void updateCredential​(Credential oldCredential, Credential newCredential)
    パスワードを更新する。
    void updateCredential​(Credential oldCredential, Credential newCredential, java.lang.String policyName)
    指定の認証ポリシーの定義下においてパスワードを更新する。 複数のパスワード更新可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
  • Method Details

    • getContext

      AuthContext getContext()
    • doPrivileged

      <T> T doPrivileged​(java.util.function.Supplier<T> action)
    • canUpdateCredential

      boolean canUpdateCredential()
      パスワード更新が可能か否か。
      Returns:
    • canUpdateCredential

      boolean canUpdateCredential​(java.lang.String policyName)
      指定の認証ポリシーの定義にて、パスワード更新が可能か否か。 複数のパスワード更新可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      policyName -
      Returns:
    • updateCredential

      void updateCredential​(Credential oldCredential, Credential newCredential) throws CredentialUpdateException
      パスワードを更新する。
      Parameters:
      oldCredential -
      newCredential -
      Throws:
      CredentialUpdateException
    • updateCredential

      void updateCredential​(Credential oldCredential, Credential newCredential, java.lang.String policyName) throws CredentialUpdateException
      指定の認証ポリシーの定義下においてパスワードを更新する。 複数のパスワード更新可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      oldCredential -
      newCredential -
      policyName -
      Throws:
      CredentialUpdateException
    • canResetCredential

      boolean canResetCredential()
      パスワードリセットが可能か否か。
      Returns:
    • canResetCredential

      boolean canResetCredential​(java.lang.String policyName)
      指定の認証ポリシーの定義下において、パスワードリセットが可能か否か。 複数のパスワードリセット可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      policyName -
      Returns:
    • resetCredential

      void resetCredential​(Credential credential)
      パスワードをリセットする。
      Parameters:
      credential -
    • resetCredential

      void resetCredential​(Credential credential, java.lang.String policyName)
      指定の認証ポリシーの定義かにおいてパスワードをリセットする。 複数のパスワードリセット可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      credential -
      policyName -
    • canResetLockoutStatus

      boolean canResetLockoutStatus()
      アカウントロックアウトの(apiによる)解除が可能か否か。
      Returns:
    • canResetLockoutStatus

      boolean canResetLockoutStatus​(java.lang.String policyName)
      指定の認証ポリシーの定義下において、 アカウントロックアウトの(apiによる)解除が可能か否か。 複数のアカウントロックアウト解除可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      policyName -
      Returns:
    • resetLockoutStatus

      void resetLockoutStatus​(java.lang.String accountId)
      アカウントロックアウトの解除をする。
      Parameters:
      accountId -
    • resetLockoutStatus

      void resetLockoutStatus​(java.lang.String accountId, java.lang.String policyName)
      指定の認証ポリシーの定義下においてアカウントロックアウトの解除をする。 複数のアカウントロックアウト解除可能な認証プロバイダが存在する場合、認証ポリシーの定義によって、 そのポリシー下で有効な認証プロバイダのリストを指定することが可能。
      Parameters:
      accountId -
      policyName -
    • getGroupOids

      java.lang.String[] getGroupOids​(AuthManager.GroupOidListType type, java.lang.String... groupCode)
      groupCodeで指定したグループのoid(のリスト)を一括で取得する。 typeによって、子グループ、親グループのoidのリストを一括で取得可能。
       query.from("mtp.auth.User");
       String[] groupOid = authManager.getGroupOids(WITH_CHILDREN, groupCode);
       query.where(new In("groups.oid", groupOid));
       em.searchEntity(query);
       
      といった形で、Userなどを検索する際の条件に指定可能。
      返却されるoidのリストは、実行するユーザのセキュリティ権限によらず、すべてのoidが返却される。
      Parameters:
      type -
      groupCode -
      Returns:
    • login

      void login​(Credential credential) throws LoginFailedException, CredentialExpiredException
      Throws:
      LoginFailedException
      CredentialExpiredException
    • reAuth

      void reAuth​(Credential credential) throws LoginFailedException, CredentialExpiredException
      現在のログインセッションを信頼されたものにするために再認証する(セッション内に格納されているユーザ情報以外のものは保持される)。
      Parameters:
      credential -
      Throws:
      LoginFailedException
      CredentialExpiredException
    • logout

      void logout()