intra-mart 6.1.14

jp.co.intra_mart.foundation.security.group
クラス LoginGroupManager

java.lang.Object
  拡張jp.co.intra_mart.foundation.security.group.LoginGroupManager

public class LoginGroupManager
extends Object

ログイングループマネージャクラス。

ログイングループ情報を操作を行います。
ログイングループマネージャでは、以下の操作が可能です。

  • ログイングループの追加、更新、削除。
  • ログイングループへのグループ管理者の追加、更新、削除。
  • ログイングループへのメインページパターンの追加、更新、削除。


  • 導入されたバージョン:
    5.0
    バージョン:
    1.0
    関連項目:
    LoginGroup, SuperUser, MainPagePatternInfo

    メソッドの概要
     void addLoginGroup(LoginGroup loginGroup)
              ログイングループを新規追加します。
     void addMainPagePattern(String groupId, MainPagePatternInfo mainPagePatternInfo)
              メインページパターンを新規追加します。
     void addSuperUser(String groupId, SuperUser superUser)
              グループ管理者を新規追加します。
    static void clearInstance()
              ログイングループマネージャのインスタンスを初期化します。
     int countLoginGroups()
              ログイングループ数を取得します。
     void deleteLoginGroup(String groupId)
              ログイングループを削除します。
     void deleteMainPagePattern(String groupId, String mainPagePatternId)
              メインページパターンを削除します。
     void deleteMainPagePatterns(String groupId)
              メインページパターンをすべて削除します。
     void deleteSuperUser(String groupId)
              グループ管理者情報を削除します。
    static LoginGroupManager getInstance()
              ログイングループマネージャのインスタンスを取得します。
     LoginGroup getLoginGroup(String groupId)
              ログイングループ情報を取得します。
     String[] getLoginGroupIds()
              ログイングループIDの一覧を取得します。
     LoginGroup[] getLoginGroups()
              ログイングループの一覧を取得します。
     MainPagePatternInfo getMainPagePattern(String groupId, String mainPagePatternId)
              メインページパターンを取得します。
     String[] getMainPagePatternIds(String groupId)
              メインページパターンIDの一覧を取得します。
     MainPagePatternInfo[] getMainPagePatterns(String groupId)
              メインページパターンの一覧を取得します。
     SuperUser getSuperUser(String groupId)
              グループ管理者情報を取得します。
     void updateLoginGroup(LoginGroup loginGroup)
              ログイングループ情報を更新します。
     void updateMainPagePattern(String groupId, MainPagePatternInfo mainPagePatternInfo)
              メインページパターンを更新します。
     void updateSuperUser(String groupId, SuperUser superUser)
              グループ管理者情報を更新します。
     
    クラス java.lang.Object から継承したメソッド
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    メソッドの詳細

    clearInstance

    public static void clearInstance()
    ログイングループマネージャのインスタンスを初期化します。

    アクセスセキュリティ設定ファイルを再取得し、インスタンスを初期化します。

    アクセスセキュリティ設定ファイル(access-security.xml)は、サーバマネージャルート/confに存在します。
    通常、このメソッドを使用する必要はありません。


    getInstance

    public static LoginGroupManager getInstance()
    ログイングループマネージャのインスタンスを取得します。

    戻り値:
    ログイングループマネージャのインスタンス

    addLoginGroup

    public void addLoginGroup(LoginGroup loginGroup)
                       throws AccessSecurityException
    ログイングループを新規追加します。

    ログイングループを新規に追加します。
    ログイングループIDはユニークなものを設定してください。

    パラメータ:
    loginGroup - ログイングループ情報
    例外:
    AccessSecurityException - ログイングループ情報の追加に失敗した場合にスローされます。

    addMainPagePattern

    public void addMainPagePattern(String groupId,
                                   MainPagePatternInfo mainPagePatternInfo)
                            throws AccessSecurityException
    メインページパターンを新規追加します。

    ログイングループに対してメインページパターンを新規に追加します。
    メインページパターンIDはログイングループ単位でユニークなものを設定してください。
    存在しないログイングループに対して、メインページパターンは追加できません。

    パラメータ:
    groupId - ログイングループID
    mainPagePatternInfo - メインページパターン情報
    例外:
    AccessSecurityWriteException - メインページパターン情報の追加に失敗した場合、または引数が不正だった場合にスローされます。
    AccessSecurityException

    addSuperUser

    public void addSuperUser(String groupId,
                             SuperUser superUser)
                      throws AccessSecurityException
    グループ管理者を新規追加します。

    ログイングループに対してグループ管理者を新規に追加します。
    存在しないログイングループに対して、グループ管理者は追加できません。

    パラメータ:
    groupId - ログイングループID
    superUser - グループ管理者情報
    例外:
    AccessSecurityException - グループ管理者情報の追加に失敗した場合、または引数が不正だった場合にスローされます。

    countLoginGroups

    public int countLoginGroups()
                         throws AccessSecurityException
    ログイングループ数を取得します。

    現在登録されているログイングループの数を返却します。

    戻り値:
    ログイングループ数
    例外:
    AccessSecurityException - ログイングループ情報の取得に失敗した場合にスローされます。

    deleteMainPagePatterns

    public void deleteMainPagePatterns(String groupId)
                                throws AccessSecurityException
    メインページパターンをすべて削除します。

    ログイングループに属するすべてのメインページパターンを削除します。
    存在しないログイングループに対して、メインページパターンの削除はできません。

    パラメータ:
    groupId - ログイングループID
    例外:
    AccessSecurityWriteException - メインページパターン情報の更新に失敗した場合にスローされます。
    AccessSecurityException

    deleteLoginGroup

    public void deleteLoginGroup(String groupId)
                          throws AccessSecurityException
    ログイングループを削除します。 ログイングループに属するすべてのアクセスセキュリティ情報も同時に削除されます。

    削除対象情報:
  • メインページパターン
  • グループ管理者
  • ロール
  • アカウント
  • メニュー
  • カレンダ
  • アクセスコントローラ
  • バッチ

  • パラメータ:
    groupId - ログイングループID
    例外:
    AccessSecurityException - ログイングループ情報の削除に失敗した場合にスローされます。

    deleteMainPagePattern

    public void deleteMainPagePattern(String groupId,
                                      String mainPagePatternId)
                               throws AccessSecurityException
    メインページパターンを削除します。

    ログイングループに属するメインページパターンを削除します。
    存在しないログイングループに対して、メインページパターンの削除はできません。

    パラメータ:
    groupId - ログイングループID
    mainPagePatternId - メインページパターンID
    例外:
    AccessSecurityWriteException - メインページパターン情報の更新に失敗した場合に、または引数が不正だった場合にスローされます。
    AccessSecurityException

    deleteSuperUser

    public void deleteSuperUser(String groupId)
                         throws AccessSecurityException
    グループ管理者情報を削除します。

    ログイングループに属するグループ管理者を削除します。
    存在しないログイングループに対して、グループ管理者の削除はできません。

    パラメータ:
    groupId - ログイングループID
    例外:
    AccessSecurityException - グループ管理者情報の削除に失敗した場合にスローされます。

    getLoginGroup

    public LoginGroup getLoginGroup(String groupId)
                             throws AccessSecurityException
    ログイングループ情報を取得します。

    引数で指定したログイングループIDのログイングループ情報を取得します。
    指定したログイングループIDのログイングループが存在しない場合は、nullを返却します。

    パラメータ:
    groupId - ログイングルーID
    戻り値:
    ログイングループ情報
    例外:
    AccessSecurityException - ログイングループ情報の取得に失敗した場合にスローされます。

    getLoginGroupIds

    public String[] getLoginGroupIds()
                              throws AccessSecurityException
    ログイングループIDの一覧を取得します。

    現在登録されているログイングループのログイングループIDの一覧を取得します。
    ログイングループが一件も存在しない場合は、空の配列を返却します。

    戻り値:
    ログイングループIDの配列
    例外:
    AccessSecurityException - ログイングループ情報の取得に失敗した場合にスローされます。

    getLoginGroups

    public LoginGroup[] getLoginGroups()
                                throws AccessSecurityException
    ログイングループの一覧を取得します。

    現在登録されているログイングループの一覧を取得します。
    ログイングループが一件も存在しない場合は、空の配列を返却します。

    戻り値:
    ログイングループ情報の配列
    例外:
    AccessSecurityException - ログイングループ情報の取得に失敗した場合にスローされます。

    getMainPagePattern

    public MainPagePatternInfo getMainPagePattern(String groupId,
                                                  String mainPagePatternId)
                                           throws AccessSecurityException
    メインページパターンを取得します。

    ログイングループに属するメインページパターンを取得します。
    ログイングループに属するメインページパターンIDが存在しない場合は、nullを返却します。

    パラメータ:
    groupId - ログイングループID
    mainPagePatternId - メインページパターンID
    戻り値:
    メインページパターン情報
    例外:
    AccessSecurityReadException - メインページパターン情報の取得に失敗した場合、または引数が不正だった場合にスローされます。
    AccessSecurityException

    getMainPagePatternIds

    public String[] getMainPagePatternIds(String groupId)
                                   throws AccessSecurityException
    メインページパターンIDの一覧を取得します。

    ログイングループに属するメインパターンIDの一覧を取得します。
    ログイングループに属するメインパターンが一件も存在しない場合は、空の配列を返却します。

    パラメータ:
    groupId - ログイングループID
    戻り値:
    メインページパターンIDの配列
    例外:
    AccessSecurityReadException - メインページパターン情報の取得に失敗した場合にスローされます。
    AccessSecurityException

    getMainPagePatterns

    public MainPagePatternInfo[] getMainPagePatterns(String groupId)
                                              throws AccessSecurityException
    メインページパターンの一覧を取得します。

    ログイングループに属するメインパターンの一覧を取得します。
    ログイングループに属するメインパターンが一件も存在しない場合は、空の配列を返却します。

    パラメータ:
    groupId - ログイングループID
    戻り値:
    メインページパターン情報の配列
    例外:
    AccessSecurityReadException - メインページパターン情報の取得に失敗した場合にスローされます。
    AccessSecurityException

    getSuperUser

    public SuperUser getSuperUser(String groupId)
                           throws AccessSecurityException
    グループ管理者情報を取得します。

    ログイングループに属するグループ管理者を取得します。
    ログイングループに属するグループ管理者が存在しない場合は、nullを返却します。

    パラメータ:
    groupId - ログイングループID
    戻り値:
    グループ管理者情報
    例外:
    AccessSecurityException - グループ管理者情報の取得に失敗した場合にスローされます。

    updateLoginGroup

    public void updateLoginGroup(LoginGroup loginGroup)
                          throws AccessSecurityException
    ログイングループ情報を更新します。

    既に登録されているログイングループを更新します。
    存在しないログイングループに対して、ログイングループの更新はできません。

    パラメータ:
    loginGroup - ログイングループID
    例外:
    AccessSecurityException - ログイングループ情報の更新に失敗した場合にスローされます。

    updateMainPagePattern

    public void updateMainPagePattern(String groupId,
                                      MainPagePatternInfo mainPagePatternInfo)
                               throws AccessSecurityException
    メインページパターンを更新します。

    既に登録されているログイングループに属するメインページパターンを更新します。
    存在しないログイングループに対して、メインページパターンの更新はできません。

    パラメータ:
    groupId - ログイングループID
    mainPagePatternInfo -
    例外:
    AccessSecurityWriteException - メインページパターン情報の更新に失敗した場合、または引数が不正だった場合にスローされます。
    AccessSecurityException

    updateSuperUser

    public void updateSuperUser(String groupId,
                                SuperUser superUser)
                         throws AccessSecurityException
    グループ管理者情報を更新します。

    既に登録されているログイングループに属するグループ管理者を更新します。
    存在しないログイングループに対して、グループ管理者の更新はできません。

    パラメータ:
    groupId - ログイングループID
    superUser - グループ管理者情報
    例外:
    AccessSecurityException - グループ管理者情報の更新に失敗した場合、または引数が不正だった場合にスローされます。

    intra-mart 6.1.14

    Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.