intra-mart(R)
5.1

jp.co.intra_mart.foundation.security.menu
クラス MenuManager

java.lang.Object
  拡張jp.co.intra_mart.foundation.security.menu.MenuManager

public final class MenuManager
extends java.lang.Object

メニューマネージャクラス。

メニュー情報の操作を行います。

導入されたバージョン:
5.0
バージョン:
1.0

コンストラクタの概要
MenuManager(java.lang.String groupId)
          コンストラクタ。
 
メソッドの概要
 void addMenuDepartment(java.lang.String menuId, DepartmentInfo departmentInfo)
          組織をメニューに紐付けます。
 void addMenuItem(java.lang.String parentMenuId, MenuItem menuItem)
          メニューを追加します。
 void addMenuPost(java.lang.String menuId, PostInfo postInfo)
          役職をメニューに紐付けます。
 void addMenuPublicGroup(java.lang.String menuId, PublicGroupInfo publicGroupInfo)
          パブリックグループをメニューに紐付けます。
 void addMenuRole(java.lang.String menuId, java.lang.String roleId)
          ロールをメニューに紐付けます。
static void clearInstance()
          メニューマネージャのインスタンスを初期化します。
 void deleteMenuDepartment(java.lang.String menuId, DepartmentInfo departmentInfo)
          組織の紐付けをメニューから削除します。
 void deleteMenuDepartments(java.lang.String menuId)
          組織の紐付けをメニューからすべて削除します。
 void deleteMenuItem(java.lang.String menuId)
          メニューを削除します。
 void deleteMenuItems()
          すべてのメニューを削除します。
 void deleteMenuPost(java.lang.String menuId, PostInfo postInfo)
          役織の紐付けをメニューから削除します。
 void deleteMenuPosts(java.lang.String menuId)
          役織の紐付けをメニューからすべて削除します。
 void deleteMenuPublicGroup(java.lang.String menuId, PublicGroupInfo publicGroupInfo)
          パブリックグループの紐付けをメニューから削除します。
 void deleteMenuPublicGroups(java.lang.String menuId)
          パブリックグループの紐付けをメニューからすべて削除します。
 void deleteMenuRole(java.lang.String menuId, java.lang.String roleId)
          ロールの紐付けをメニューから削除します。
 void deleteMenuRoles(java.lang.String menuId)
          ロールの紐付けをメニューから削除します。
 void exportData(java.lang.String category, java.io.OutputStream outputStream)
          メニュー情報をエクスポートします。
 MenuTree[] getAccountMenuTree(java.lang.String userId, java.lang.String clientType)
          指定したアカウントのメニュー構成を取得します。
 java.lang.String[] getChildMenuIds(java.lang.String menuId)
          子メニューIDを取得します。
 java.lang.String[] getExportCategories()
          メニューエクスポート用のカテゴリの一覧を取得します。
 java.lang.String[] getFirstMenuIds()
          第一階層のメニューIDをすべて取得します。
 java.lang.String[] getImportCategories()
          メニューインポート用のカテゴリの一覧を取得します。
 java.lang.String getLoginGroupId()
          ログイングループIDを取得します。
 DepartmentInfo[] getMenuDepartments(java.lang.String menuId)
          メニューに紐付いた組織の一覧を取得します。
 java.lang.String[] getMenuIds()
          すべてのメニューIDを取得します。
 java.lang.String[] getMenuIdsByDepartment(DepartmentInfo[] departments)
          指定された組織を持つメニューIDをすべて取得します。
 java.lang.String[] getMenuIdsByPost(PostInfo[] posts)
          指定された役職を持つメニューIDをすべて取得します。
 java.lang.String[] getMenuIdsByPublicGroup(PublicGroupInfo[] publicGroups)
          指定されたパブリックグループを持つメニューIDをすべて取得します。
 java.lang.String[] getMenuIdsByRole(java.lang.String[] roleIds)
          指定されたロールIDを持つメニューIDをすべて取得します。
 MenuItem getMenuItem(java.lang.String menuId)
          指定されたメニューIDに対応するメニューを取得します。
 MenuItem[] getMenuItems()
          すべてのメニューを取得します。
 MenuItem[] getMenuItemsByIds(java.lang.String[] menuIds)
          ログイングループ内で引数指定したメニューIDのメニュー情報をすべて取得します。
 PostInfo[] getMenuPosts(java.lang.String menuId)
          メニューに紐付いた役職の一覧を取得します。
 PublicGroupInfo[] getMenuPublicGroups(java.lang.String menuId)
          メニューに紐付いたパブリックグループの一覧を取得します。
 java.lang.String[] getMenuRoles(java.lang.String menuId)
          メニューに紐付いたロールの一覧を取得します。
 MenuTree[] getMenuTree()
          メニュー構成を取得します。
 MenuTree[] getMenuTree(java.lang.String clientType)
          指定されたクライアントタイプのみのメニュー構成を取得します。
 MenuTree[] getMenuTree(java.lang.String clientType, java.lang.String[] menuIds, boolean showNoChildFolder)
          指定されたクライアントタイプと指定されたメニューIDのみのメニュー構成を取得します。
 java.lang.String getParentMenuId(java.lang.String menuId)
          指定されたメニューの親メニューを取得します。
 void importData(java.lang.String category, java.io.InputStream inputStream)
          メニュー情報をインポートします。
 void moveMenuItem(MenuInclusion menuInclusion)
          メニューを移動します。
 void updateMenuItem(MenuItem menuItem)
          メニューを更新します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MenuManager

public MenuManager(java.lang.String groupId)
            throws AccessSecurityException
コンストラクタ。

ログイングループ単位のメニューを操作するマネージャーを作成します。

パラメータ:
groupId - ログイングループID
例外:
AccessSecurityException - ログイングループIDが不正な場合にスローされます。
メソッドの詳細

clearInstance

public static void clearInstance()
メニューマネージャのインスタンスを初期化します。

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

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


addMenuDepartment

public void addMenuDepartment(java.lang.String menuId,
                              DepartmentInfo departmentInfo)
                       throws AccessSecurityException
組織をメニューに紐付けます。

パラメータ:
menuId - メニューID
departmentInfo - 組織情報
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

addMenuItem

public void addMenuItem(java.lang.String parentMenuId,
                        MenuItem menuItem)
                 throws AccessSecurityException
メニューを追加します。

パラメータ:
parentMenuId - 親メニューID
nullの場合は、第一階層へ追加されます。
menuItem - メニュー
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

addMenuPost

public void addMenuPost(java.lang.String menuId,
                        PostInfo postInfo)
                 throws AccessSecurityException
役職をメニューに紐付けます。

パラメータ:
menuId - メニューID
postInfo - 役職情報
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

addMenuPublicGroup

public void addMenuPublicGroup(java.lang.String menuId,
                               PublicGroupInfo publicGroupInfo)
                        throws AccessSecurityException
パブリックグループをメニューに紐付けます。

パラメータ:
menuId - メニューID
publicGroupInfo - パブリックグループ
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

addMenuRole

public void addMenuRole(java.lang.String menuId,
                        java.lang.String roleId)
                 throws AccessSecurityException
ロールをメニューに紐付けます。

パラメータ:
menuId - メニューID
roleId - ロールID
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuDepartment

public void deleteMenuDepartment(java.lang.String menuId,
                                 DepartmentInfo departmentInfo)
                          throws AccessSecurityException
組織の紐付けをメニューから削除します。

パラメータ:
menuId - メニューID
departmentInfo - 組織情報
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuDepartments

public void deleteMenuDepartments(java.lang.String menuId)
                           throws AccessSecurityException
組織の紐付けをメニューからすべて削除します。

パラメータ:
menuId - メニューID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuItem

public void deleteMenuItem(java.lang.String menuId)
                    throws AccessSecurityException
メニューを削除します。

パラメータ:
menuId - メニューID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuItems

public void deleteMenuItems()
                     throws AccessSecurityException
すべてのメニューを削除します。

例外:
AccessSecurityException - 削除処理に失敗した場合にスローされます。

deleteMenuPost

public void deleteMenuPost(java.lang.String menuId,
                           PostInfo postInfo)
                    throws AccessSecurityException
役織の紐付けをメニューから削除します。

パラメータ:
menuId - メニューID
postInfo - 役織情報
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuPosts

public void deleteMenuPosts(java.lang.String menuId)
                     throws AccessSecurityException
役織の紐付けをメニューからすべて削除します。

パラメータ:
menuId - メニューID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuPublicGroup

public void deleteMenuPublicGroup(java.lang.String menuId,
                                  PublicGroupInfo publicGroupInfo)
                           throws AccessSecurityException
パブリックグループの紐付けをメニューから削除します。

パラメータ:
menuId - メニューID
publicGroupInfo - パブリックグループ
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuPublicGroups

public void deleteMenuPublicGroups(java.lang.String menuId)
                            throws AccessSecurityException
パブリックグループの紐付けをメニューからすべて削除します。

パラメータ:
menuId - メニューID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuRole

public void deleteMenuRole(java.lang.String menuId,
                           java.lang.String roleId)
                    throws AccessSecurityException
ロールの紐付けをメニューから削除します。

パラメータ:
menuId - メニューID
roleId - ロールID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

deleteMenuRoles

public void deleteMenuRoles(java.lang.String menuId)
                     throws AccessSecurityException
ロールの紐付けをメニューから削除します。

パラメータ:
menuId - メニューID
例外:
AccessSecurityException - 削除処理に失敗した場合、または引数が不正だった場合にスローされます。

exportData

public void exportData(java.lang.String category,
                       java.io.OutputStream outputStream)
                throws AccessSecurityException
メニュー情報をエクスポートします。

パラメータ:
category - カテゴリ
outputStream - 出力ストリーム
例外:
AccessSecurityException - エクスポートに失敗した場合、または引数が不正だった場合にスローされます。

getAccountMenuTree

public MenuTree[] getAccountMenuTree(java.lang.String userId,
                                     java.lang.String clientType)
                              throws AccessSecurityException
指定したアカウントのメニュー構成を取得します。

このメソッドはメニューの絞り込みにPermissionManagerを利用しています。
PermissionManagerでメニューの絞り込みに利用されるカテゴリは、'account-menu'です。

パラメータ:
userId - ユーザID
clientType - クライアントタイプ
戻り値:
メニュー構成の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合にスローされます。

getChildMenuIds

public java.lang.String[] getChildMenuIds(java.lang.String menuId)
                                   throws AccessSecurityException
子メニューIDを取得します。

パラメータ:
menuId - 親メニューID
戻り値:
子メニューIDの配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getExportCategories

public java.lang.String[] getExportCategories()
                                       throws AccessSecurityException
メニューエクスポート用のカテゴリの一覧を取得します。

戻り値:
メニューエクスポート用カテゴリの一覧
例外:
AccessSecurityException - メニューエクスポート用のカテゴリの取得に失敗した場合にスローされます。

getFirstMenuIds

public java.lang.String[] getFirstMenuIds()
                                   throws AccessSecurityException
第一階層のメニューIDをすべて取得します。

戻り値:
第一階層のメニューIDの配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合にスローされます。

getImportCategories

public java.lang.String[] getImportCategories()
                                       throws AccessSecurityException
メニューインポート用のカテゴリの一覧を取得します。

戻り値:
メニューインポート用カテゴリの一覧
例外:
AccessSecurityException - メニューインポート用のカテゴリの取得に失敗した場合にスローされます。

getLoginGroupId

public java.lang.String getLoginGroupId()
ログイングループIDを取得します。

戻り値:
ログイングループID

getMenuDepartments

public DepartmentInfo[] getMenuDepartments(java.lang.String menuId)
                                    throws AccessSecurityException
メニューに紐付いた組織の一覧を取得します。

パラメータ:
menuId - メニューID
戻り値:
組織情報の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuIds

public java.lang.String[] getMenuIds()
                              throws AccessSecurityException
すべてのメニューIDを取得します。

戻り値:
メニューIDの配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuIdsByDepartment

public java.lang.String[] getMenuIdsByDepartment(DepartmentInfo[] departments)
                                          throws AccessSecurityException
指定された組織を持つメニューIDをすべて取得します。

パラメータ:
departments - 組織情報の配列
戻り値:
メニューIDの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityException - メニュー情報取得に失敗した場合スローされます。

getMenuIdsByPost

public java.lang.String[] getMenuIdsByPost(PostInfo[] posts)
                                    throws AccessSecurityException
指定された役職を持つメニューIDをすべて取得します。

パラメータ:
posts - 役職情報の配列
戻り値:
メニューIDの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityException - メニュー情報取得に失敗した場合スローされます。

getMenuIdsByPublicGroup

public java.lang.String[] getMenuIdsByPublicGroup(PublicGroupInfo[] publicGroups)
                                           throws AccessSecurityException
指定されたパブリックグループを持つメニューIDをすべて取得します。

パラメータ:
publicGroups - パブリックグループの配列
戻り値:
メニューIDの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityException - メニュー情報取得に失敗した場合スローされます。

getMenuIdsByRole

public java.lang.String[] getMenuIdsByRole(java.lang.String[] roleIds)
                                    throws AccessSecurityException
指定されたロールIDを持つメニューIDをすべて取得します。

パラメータ:
roleIds - ロールIDの配列
戻り値:
メニューIDの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityException - メニュー情報取得に失敗した場合スローされます。

getMenuItem

public MenuItem getMenuItem(java.lang.String menuId)
                     throws AccessSecurityException
指定されたメニューIDに対応するメニューを取得します。

パラメータ:
menuId - メニューID
戻り値:
メニュー
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuItems

public MenuItem[] getMenuItems()
                        throws AccessSecurityException
すべてのメニューを取得します。

戻り値:
メニュー情報の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合にスローされます。

getMenuItemsByIds

public MenuItem[] getMenuItemsByIds(java.lang.String[] menuIds)
                             throws AccessSecurityException
ログイングループ内で引数指定したメニューIDのメニュー情報をすべて取得します。

パラメータ:
menuIds - メニューIDの配列
戻り値:
メニュー情報の配列(データがない場合は空の配列を返します。)
例外:
AccessSecurityException - メニュー情報の取得に失敗した場合にスローされます。

getMenuPosts

public PostInfo[] getMenuPosts(java.lang.String menuId)
                        throws AccessSecurityException
メニューに紐付いた役職の一覧を取得します。

パラメータ:
menuId - メニューID
戻り値:
役職情報の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuPublicGroups

public PublicGroupInfo[] getMenuPublicGroups(java.lang.String menuId)
                                      throws AccessSecurityException
メニューに紐付いたパブリックグループの一覧を取得します。

パラメータ:
menuId - メニューID
戻り値:
パブリックグループの配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuRoles

public java.lang.String[] getMenuRoles(java.lang.String menuId)
                                throws AccessSecurityException
メニューに紐付いたロールの一覧を取得します。

パラメータ:
menuId - メニューID
戻り値:
ロールIDの配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuTree

public MenuTree[] getMenuTree()
                       throws AccessSecurityException
メニュー構成を取得します。

戻り値:
メニュー構成の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合にスローされます。

getMenuTree

public MenuTree[] getMenuTree(java.lang.String clientType)
                       throws AccessSecurityException
指定されたクライアントタイプのみのメニュー構成を取得します。

パラメータ:
clientType - クライアントタイプ この値がnullの場合は、すべてのクライアントタイプが対象となります。
戻り値:
メニュー構成の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getMenuTree

public MenuTree[] getMenuTree(java.lang.String clientType,
                              java.lang.String[] menuIds,
                              boolean showNoChildFolder)
                       throws AccessSecurityException
指定されたクライアントタイプと指定されたメニューIDのみのメニュー構成を取得します。

パラメータ:
clientType - クライアントタイプ
この値がnullの場合は、すべてのクライアントタイプが対象となります。
menuIds - 作成対象のメニューIDの配列
この値がnullの場合は、すべてのメニューIDが対象となります。
showNoChildFolder - 子メニューを持た持たないフォルダーを表示するかどうか
戻り値:
メニュー構成の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

getParentMenuId

public java.lang.String getParentMenuId(java.lang.String menuId)
                                 throws AccessSecurityException
指定されたメニューの親メニューを取得します。

メニューIDがトップメニューであった場合は、nullを返却します。

パラメータ:
menuId - メニューID
戻り値:
親メニューID
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または引数が不正だった場合にスローされます。

importData

public void importData(java.lang.String category,
                       java.io.InputStream inputStream)
                throws AccessSecurityException
メニュー情報をインポートします。

パラメータ:
category - カテゴリ
inputStream - 入力ストリーム
例外:
AccessSecurityException - インポートに失敗した場合、または引数が不正だった場合にスローされます。

moveMenuItem

public void moveMenuItem(MenuInclusion menuInclusion)
                  throws AccessSecurityException
メニューを移動します。

パラメータ:
menuInclusion - 新しいメニュー構成
例外:
AccessSecurityException - 読み込み処理に失敗した場合、または書き込み処理に失敗した場合にスローされます。

updateMenuItem

public void updateMenuItem(MenuItem menuItem)
                    throws AccessSecurityException
メニューを更新します。

パラメータ:
menuItem - メニュー情報
例外:
AccessSecurityException - 書き込み処理に失敗した場合、または引数が不正だった場合にスローされます。

intra-mart(R)
5.1

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