intra-mart(R) 6.0.13

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

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

public final class AdminMenuManager
extends Object

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

グループ管理者が利用する管理メニュー情報の操作を行います。

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

メソッドの概要
 void addMenuItem(String parentMenuId, MenuItem menuItem)
          メニューを追加します。
 void addMenuLoginGroup(String menuId, String groupId)
          指定したログイングループのアクセス権をメニューに設定します。
static void clearInstance()
          ログイングループマネージャのインスタンスを初期化します。
 void deleteMenuItem(String menuId)
          メニューを削除します。
 void deleteMenuItems()
          すべてのメニューを削除します。
 void deleteMenuLoginGroup(String menuId, String groupId)
          指定したログイングループのアクセス権をメニューから削除します。
 void exportData(String category, OutputStream outputStream)
          メニュー情報・エクスポート。
 String[] getChildMenuIds(String menuId)
          子メニューIDを取得します。
 String[] getExportCategories()
          管理メニューエクスポート用のカテゴリの一覧を取得します。
 String[] getFirstMenuIds()
          第一階層のメニューIDをすべて取得します。
 String[] getImportCategories()
          管理メニューインポート用のカテゴリの一覧を取得します。
static AdminMenuManager getInstance()
          ログイングループマネージャのインスタンスを取得します。
 String[] getMenuIds()
          すべてのメニューIDを取得します。
 String[] getMenuIdsByLoginGroup(String groupId)
          引き数に指定したログイングループが参照可能なメニューIDの一覧を取得します。
 MenuItem getMenuItem(String menuId)
          指定されたメニューIDに対応するメニューを取得します。
 MenuItem[] getMenuItems()
          すべてのメニューを取得します。
 MenuItem[] getMenuItemsByIds(String[] menuIds)
          引き数に指定したメニューIDに一致するメニューアイテムの一覧を取得します。
 String[] getMenuLoginGroups(String menuId)
          引数に指定したメニューを参照可能なログイングループIDの一覧を取得します。
 MenuTree[] getMenuTree()
          メニュー構成を取得します。
 MenuTree[] getMenuTree(String groupId)
          引数に指定したログイングループのメニュー構成を取得します。
 String getParentMenuId(String menuId)
          指定されたメニューの親メニューを取得します。
 void importData(String category, InputStream inputStream)
          メニュー情報・インポート。
 boolean isAccessControlEnabled(String menuId)
          メニューアイテムのアクセス権の有無を取得します。
 void moveMenuItem(MenuInclusion menuInclusion)
          メニューを移動します。
 void setAccessControlEnabled(String menuId, boolean accessControl)
          メニューアイテムに対するアクセス権を設定します。
 void updateMenuItem(MenuItem menuItem)
          メニューを更新します。
 
クラス 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 AdminMenuManager getInstance()
ログイングループマネージャのインスタンスを取得します。

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

addMenuItem

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

パラメータ:
parentMenuId - 親メニューID
nullの場合は、第一階層へ追加される。
例外:
AccessSecurityException - メニューの追加に失敗した場合にスローされます。

addMenuLoginGroup

public void addMenuLoginGroup(String menuId,
                              String groupId)
                       throws AccessSecurityException
指定したログイングループのアクセス権をメニューに設定します。

パラメータ:
menuId - メニューID
groupId - ログイングループID
例外:
AccessSecurityException - アクセス権設定時に例外が発生
導入されたバージョン:
5.1

deleteMenuItem

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

パラメータ:
menuId - メニューID
例外:
AccessSecurityException

deleteMenuItems

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

例外:
AccessSecurityException

deleteMenuLoginGroup

public void deleteMenuLoginGroup(String menuId,
                                 String groupId)
                          throws AccessSecurityException
指定したログイングループのアクセス権をメニューから削除します。

パラメータ:
menuId - メニューID
groupId - ログイングループID
例外:
AccessSecurityException - アクセス権削除時に例外が発生
導入されたバージョン:
5.1

exportData

public void exportData(String category,
                       OutputStream outputStream)
                throws AccessSecurityException
メニュー情報・エクスポート。

パラメータ:
category - カテゴリ
outputStream - 出力ストリーム
例外:
AccessSecurityException

getChildMenuIds

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

パラメータ:
menuId - 親メニューID
戻り値:
子メニューの配列
例外:
AccessSecurityException

getFirstMenuIds

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

戻り値:
第一階層のメニューIDの配列
例外:
AccessSecurityException

getMenuIds

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

戻り値:
メニューIDの配列
例外:
AccessSecurityException

getMenuItem

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

パラメータ:
menuId - メニューID
戻り値:
メニュー
例外:
AccessSecurityException

getMenuItems

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

戻り値:
メニューの配列
例外:
AccessSecurityException

getMenuTree

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

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

getMenuTree

public MenuTree[] getMenuTree(String groupId)
                       throws AccessSecurityException
引数に指定したログイングループのメニュー構成を取得します。

パラメータ:
groupId - ログイングループID
戻り値:
メニュー構成の配列
例外:
AccessSecurityException - 読み込み処理に失敗した場合にスローされます。
導入されたバージョン:
5.1

getMenuLoginGroups

public String[] getMenuLoginGroups(String menuId)
                            throws AccessSecurityException
引数に指定したメニューを参照可能なログイングループIDの一覧を取得します。

パラメータ:
menuId - メニューID
戻り値:
ログイングループIDの一覧
例外:
AccessSecurityException - メニュー情報取得時に例外発生
導入されたバージョン:
5.1

getParentMenuId

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

パラメータ:
menuId - メニューID
戻り値:
親メニューID
例外:
AccessSecurityException

importData

public void importData(String category,
                       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

getExportCategories

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

戻り値:
管理メニューエクスポート用カテゴリの一覧

getImportCategories

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

戻り値:
管理メニューインポート用カテゴリの一覧

getMenuIdsByLoginGroup

public String[] getMenuIdsByLoginGroup(String groupId)
                                throws AccessSecurityException
引き数に指定したログイングループが参照可能なメニューIDの一覧を取得します。

パラメータ:
groupId - ログイングループID
戻り値:
メニューIDの一覧
例外:
AccessSecurityException - メニュー情報取得時に例外が発生
導入されたバージョン:
5.1

getMenuItemsByIds

public MenuItem[] getMenuItemsByIds(String[] menuIds)
                             throws AccessSecurityException
引き数に指定したメニューIDに一致するメニューアイテムの一覧を取得します。

パラメータ:
menuIds - メニューID
戻り値:
メニューアイテムの一覧
例外:
AccessSecurityException - メニュー情報取得時に例外発生
導入されたバージョン:
5.1

setAccessControlEnabled

public void setAccessControlEnabled(String menuId,
                                    boolean accessControl)
                             throws AccessSecurityException
メニューアイテムに対するアクセス権を設定します。 アクセス権を有効にすると、ログイングループ毎にアクセス制限を設定可能です。 未設定の場合はアクセス制限を行いません。

パラメータ:
menuId - メニューID
accessControl - true/有効、false/無効
例外:
AccessSecurityException - アクセス権限設定時に例外が発生
導入されたバージョン:
5.1

isAccessControlEnabled

public boolean isAccessControlEnabled(String menuId)
                               throws AccessSecurityException
メニューアイテムのアクセス権の有無を取得します。

パラメータ:
menuId - メニューID
戻り値:
true/有効、false/無効
例外:
AccessSecurityException - アクセス権限取得時に例外が発生
導入されたバージョン:
5.1

intra-mart(R) 6.0.13

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