intra-mart 6.1.14

jp.co.intra_mart.foundation.security.role
インタフェース RoleAccessor

既知の実装クラスの一覧:
StandardRoleAccessor

public interface RoleAccessor

ロールアクセッサインタフェース。

ロール情報の読み込みおよび書き込みのインタフェースを定義します。

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

メソッドの概要
 void createRole(String groupId, Role role)
          ロール情報を新規に追加する。
 void deleteCategory(String groupId)
          すべてのカテゴリを削除する。
 void deleteCategory(String groupId, String category)
          カテゴリを削除する。
 void deleteRole(String groupId)
          すべてのロール情報を削除する。
 void deleteRole(String groupId, String roleId)
          ロール情報を削除する。
 void deleteSubRole(String groupId, String roleId)
          指定したロールのサブロールIDサマリを全削除する。
 void deleteSubRole(String groupId, String roleId, String subRoleId)
          サブロールIDサマリを削除する。
 String[] getAllParentRoleIds(String groupId, String roleId)
          すべての親ロールの一覧を取得する。
 String[] getAllSubRoleIds(String groupId, String roleId)
          すべてのサブロールの一覧を取得する。
 String[] getCategories(String groupId)
          カテゴリの一覧を取得する。
 String[] getParentRoleIds(String groupId, String roleId)
          親ロールの一覧を取得する。
 Role[] getRoleData(String groupId)
          ロール情報を全件取得する。
 Role getRoleData(String groupId, String roleId)
          ロール情報を取得する。
 Role[] getRoleDataByCategory(String groupId, String category)
          カテゴリからロール情報を取得する。
 Role[] getRolesByIds(String groupId, String[] roleIds)
          指定されたロールIDのロール情報をすべて取得する。
 String[] getSubRoleIds(String groupId, String roleId)
          サブロールIDサマリを取得する。
 void init(Map params)
          ロールアクセッサの初期化。
 void insertSubRole(String groupId, String roleId, String subRoleId)
          サブロールを作成する。
 void updateCategory(String groupId, String oldCategory, String newCategory)
          カテゴリを更新する。
 void updateRole(String groupId, Role role)
          ロール情報を更新する。
 

メソッドの詳細

createRole

public void createRole(String groupId,
                       Role role)
                throws AccessSecurityWriteException
ロール情報を新規に追加する。

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

deleteCategory

public void deleteCategory(String groupId)
                    throws AccessSecurityWriteException
すべてのカテゴリを削除する。

パラメータ:
groupId - ログイングループID
例外:
AccessSecurityWriteException - カテゴリの削除に失敗した場合にスローされます。

deleteCategory

public void deleteCategory(String groupId,
                           String category)
                    throws AccessSecurityWriteException
カテゴリを削除する。

パラメータ:
groupId - ログイングループID
category - カテゴリ名
例外:
AccessSecurityWriteException - カテゴリの削除に失敗した場合にスローされます。

deleteRole

public void deleteRole(String groupId)
                throws AccessSecurityWriteException
すべてのロール情報を削除する。

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

deleteRole

public void deleteRole(String groupId,
                       String roleId)
                throws AccessSecurityWriteException
ロール情報を削除する。

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

getAllParentRoleIds

public String[] getAllParentRoleIds(String groupId,
                                    String roleId)
                             throws AccessSecurityReadException
すべての親ロールの一覧を取得する。

引数に指定したロールの上位階層にあるすべての親ロールを取得する。
親ロールが一件も存在しない場合空の配列を返却する。

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

getAllSubRoleIds

public String[] getAllSubRoleIds(String groupId,
                                 String roleId)
                          throws AccessSecurityReadException
すべてのサブロールの一覧を取得する。

引数に指定したロールの下位階層にあるすべてのサブロールを取得する。
サブロールが一件も存在しない場合空の配列を返却する。

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

getCategories

public String[] getCategories(String groupId)
                       throws AccessSecurityReadException
カテゴリの一覧を取得する。

指定したログイングループに属するカテゴリが存在しない場合は空の配列を返却する。

パラメータ:
groupId - ログイングループID
戻り値:
カテゴリ名の配列
例外:
AccessSecurityReadException - カテゴリの取得に失敗した場合にスローされます。

getParentRoleIds

public String[] getParentRoleIds(String groupId,
                                 String roleId)
                          throws AccessSecurityReadException
親ロールの一覧を取得する。

引数に指定したロールの1階層上位にあるすべての親ロールを取得する。
親ロールが一件も存在しない場合空の配列を返却する。

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

getRoleData

public Role[] getRoleData(String groupId)
                   throws AccessSecurityReadException
ロール情報を全件取得する。

指定されたログイングループに属するロールが存在しない場合は空の配列を返却する。

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

getRoleData

public Role getRoleData(String groupId,
                        String roleId)
                 throws AccessSecurityReadException
ロール情報を取得する。

指定されたロールIDをもつロールが存在しない場合はnullを返す

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

getRoleDataByCategory

public Role[] getRoleDataByCategory(String groupId,
                                    String category)
                             throws AccessSecurityReadException
カテゴリからロール情報を取得する。

指定されたカテゴリに属するロール情報を取得する
指定したカテゴリーに属するロールが存在しない場合は空の配列を返却する。

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

getRolesByIds

public Role[] getRolesByIds(String groupId,
                            String[] roleIds)
                     throws AccessSecurityReadException
指定されたロールIDのロール情報をすべて取得する。

パラメータ:
groupId - ログイングループID
roleIds - ロールIDの配列
戻り値:
ロールオブジェクトの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityReadException - ロール情報取得に失敗した場合スローされます。

init

public void init(Map params)
ロールアクセッサの初期化。

このクラスを実装したクラスが生成される時、一度だけこのメソッドが呼び出される。

パラメータ:
params - 初期化パラメータのマップ(Map)

updateCategory

public void updateCategory(String groupId,
                           String oldCategory,
                           String newCategory)
                    throws AccessSecurityWriteException
カテゴリを更新する。

旧カテゴリ名を新カテゴリ名に更新する。

パラメータ:
groupId - ログイングループID
oldCategory - 旧カテゴリ名
newCategory - 新カテゴリ名
例外:
AccessSecurityWriteException - カテゴリの更新に失敗した場合にスローされます。

updateRole

public void updateRole(String groupId,
                       Role role)
                throws AccessSecurityWriteException
ロール情報を更新する。

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

insertSubRole

public void insertSubRole(String groupId,
                          String roleId,
                          String subRoleId)
                   throws AccessSecurityWriteException
サブロールを作成する。

パラメータ:
groupId - ログイングループID
roleId - ロールID
subRoleId - 追加するサブロールID
例外:
AccessSecurityWriteException - ロール情報の更新に失敗した場合にスローされます。

deleteSubRole

public void deleteSubRole(String groupId,
                          String roleId,
                          String subRoleId)
                   throws AccessSecurityWriteException
サブロールIDサマリを削除する。

パラメータ:
groupId - ログイングループID
roleId - ロールID
subRoleId - 削除するサブロールID
例外:
AccessSecurityWriteException - ロール情報の更新に失敗した場合にスローされます。

deleteSubRole

public void deleteSubRole(String groupId,
                          String roleId)
                   throws AccessSecurityWriteException
指定したロールのサブロールIDサマリを全削除する。

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

getSubRoleIds

public String[] getSubRoleIds(String groupId,
                              String roleId)
                       throws AccessSecurityReadException
サブロールIDサマリを取得する。

パラメータ:
groupId - ログイングループID
roleId - ロールID
戻り値:
String[] サブロールID
例外:
AccessSecurityWriteException - ロール情報の更新に失敗した場合にスローされます。
AccessSecurityReadException

intra-mart 6.1.14

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