5 SecurityService

この章では、認証、偽装、ログイン、ログアウト、アカウント管理など、BI Publisherサーバーのセキュリティ操作を管理するためのSecurityServiceメソッドの詳細について説明します。

この章の内容は次のとおりです。

• 第5.1項「assignRolesToUser()メソッド」

• 第5.2項「createRole()メソッド」

• 第5.3項「createUser()メソッド」

• 第5.4項「deleteRole()メソッド」

• 第5.5項「deleteUser()メソッド」

• 第5.6項「getBIPHTTPSessionInterval()メソッド」

• 第5.7項「getObjectSecurityXML()メソッド」

• 第5.8項「getSecurityModel()メソッド」

• 第5.9項「hasObjectAccess()メソッド」

• 第5.10項「hasObjectAccessInSession()メソッド」

• 第5.11項「impersonate()メソッド」

• 第5.12項「isUserExists()メソッド」

• 第5.13項「login()メソッド」

• 第5.14項「logout()メソッド」

• 第5.15項「notifyBIEEPreferencesUpdated()メソッド」

• 第5.16項「notifyBIEEPreferencesUpdatedWithString()メソッド」

• 第5.17項「removeRolesFromUser()メソッド」

• 第5.18項「updateRole()メソッド」

• 第5.19項「updateUser()メソッド」

• 第5.20項「validateLogin()メソッド」

注意: BI Publisher Webサービスを使用して作成されたアプリケーションをデバッグする方法の詳細は、第1.4項「Webサービス・アプリケーションのデバッグ」を参照してください。

注意: SecurityServiceが使用できるのは、BI Publisherセキュリティ・モデルのみです。ご使用のBI Publisherデプロイメントで別のセキュリティ・モデル(LDAP、Oracle E-Business Suite、Oracle Fusion Appsなど)が使用されている場合、SecurityService APIを使用できません。

5.1 assignRolesToUser()メソッド

assignRolesToUser()メソッドは、新しいロールをBI Publisherのユーザーに割り当てます。

シグネチャ

String[] assignRolesToUser(String userName, String[] roleNames, String adminUser, String adminPassword);

表5-1 assignRolesToUser()メソッドのパラメータ

パラメータ	説明
String userName	ロール(複数可)を追加するユーザー。
String[] roleNames	ユーザーを追加するロールの名前。(例: 金融関係のユーザー)。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.2 createRole()メソッド

createRole()メソッドは、BI Publisher内にロールを作成します。

シグネチャ

boolean createRole(String roleName, String description, String adminUser, String adminPassword);

表5-2 createRole()メソッドのパラメータ

パラメータ	説明
String roleName	作成するロールの名前。(例: 金融関係のユーザー)。
String description	ロールの説明。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.3 createUser()メソッド

createUser()メソッドは、BI Publisher内にユーザーを作成します。このメソッドは、正常なメソッドのブール値を返します。

シグネチャ

boolean createUser(String userName, String password, String adminUser, String adminPassword);

表5-3 createUser()メソッドのパラメータ

パラメータ	説明
String userName	作成するユーザー名。
String password	新規作成ユーザーのパスワード。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.4 deleteRole()メソッド

deleteRole()メソッドは、BI Publisherからロールを削除します。このメソッドは、正常なメソッドのブール値を返します。

シグネチャ

boolean deleteRole(String roleName, String adminUser, String adminPassword);

表5-4 deleteRole()メソッドのパラメータ

パラメータ	説明
String roleName	削除するユーザー名。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.5 deleteUser()メソッド

deleteUser()メソッドは、BI Publisherからユーザーを削除します。このメソッドは、正常なメソッドのブール値を返します。

シグネチャ

boolean deleteUser(String userName, String adminUser, String adminPassword);

表5-5 deleteUser()メソッドのパラメータ

パラメータ	説明
String userName	削除するユーザー名。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.6 getBIPHTTPSessionInterval()メソッド

このメソッドは、HTTPセッションの間隔を秒数で返します。

シグネチャ

int getBIPHTTPSessionInterval(void);

5.7 getObjectSecurityXML()メソッド

このメソッドは、BIEE統合カタログに対するレポートレベル権限を(security.xmlから)抽出します。

シグネチャ

byte[] getObjectSecurityXML(String adminUsername, String adminPassword, String objectAbsolutePath, boolean isRecursive);

表5-6 getObjectSecurityXML()メソッドのパラメータ

パラメータ	説明
String adminUsername	管理権限でBI Publisherユーザーに指定するユーザー名。
String adminPassword	adminUserNameに関連付けられているパスワード。
String objectAbsolutePath	権限の説明を取得するカタログ・オブジェクトの絶対パス。
boolean isRecursive	objectAbsolutePathが再帰的かどうかを示します。

5.8 getSecurityModel()メソッド

このメソッドは、BI Publisherのセキュリティ・モデルを所定の場所に返します。

シグネチャ

String getSecurityModel(void);

5.9 hasObjectAccess()メソッド

このメソッドは、reportAbsolutePathが参照するレポート・オブジェクトに対するアクセス権限が指定ユーザーにあるかどうかを検証します。このメソッドは、指定された資格証明で最初にユーザーを認証します。正常に認証が完了すると、レポート・オブジェクトへのユーザーのアクセス権限を検証します。

シグネチャ

boolean hasObjectAccess(String reportAbsolutePath, String roleName, String userID, String password);

表5-7 hasObjectAccess()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	ユーザーのアクセス権限を検証する対象レポート・オブジェクトへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String roleName	将来用です。機能していないのでこのパラメータを無視してください。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

5.10 hasObjectAccessInSession()メソッド

このメソッドは、reportAbsolutePathに関連するレポート・オブジェクトに対するアクセス権限が認証前のbipSessionにあるかどうかを検証します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean hasObjectAccessInSession(string reportAbsolutePath, string roleName, string bipSessionToken);

表5-8 hasObjectAccessInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート・オブジェクトへの絶対パス。
String roleName	指定ユーザーに関連付けられているロール。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

5.11 impersonate()メソッド

このメソッドは、ユーザー・アカウントのかわりに機能する管理アカウントを有効にします。BI Publisherサーバーで認証される際のパスワードをユーザーが知らない場合、これは非常に便利です。このメソッドは、管理アカウント権限を使用してログインし、渡されたユーザー名にBI Publisherサーバー・セッションの所有者を切り替えます。したがって、渡されたユーザー名でbipSessionトークンは後から検証されます。それ以降のBI Publisher操作はすべて、指定されたユーザー名を使用して実行されます。

シグネチャ

String impersonate(String adminUsername, String adminPassword,String username);

表5-9 impersonate()メソッドのパラメータ

パラメータ	説明
String adminUserName	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。
String username	管理者権限を付与されるユーザー・アカウントのユーザー名。

5.12 isUserExists()メソッド

isUserExists()メソッドは、BI Publisherセキュリティ・モデル内のユーザー名の有無をテストします。このメソッドは、結果をブール値として返します。

シグネチャ

boolean isUserExists(String userName, String adminUser, String adminPassword);

表5-10 isUserExists()メソッドのパラメータ

パラメータ	説明
String userName	テストするユーザー名。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.13 login()メソッド

login()メソッドは、BI Publisherにログインし、Web Servicesを使用してその他のBI Publisherアクションを実行します。login()メソッドは、BI PublisherセッションIDとなる文字列を返します。

シグネチャ

String login(String userID, String password);

表5-11 login()メソッドのパラメータ

パラメータ	説明
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

5.14 logout()メソッド

このメソッドは、実際には、特定のユーザーのbipSessionTokenを検証して、そのユーザーをシステムからログアウトさせます。正常なログアウトが完了すると、bipSessionToken文字列は無効になります。

シグネチャ

boolean logout(String bipSessionToken);

表5-12 logout()メソッドのパラメータ

パラメータ	説明
String bipSessionToken	BI PublisherセッションのID。

5.15 notifyBIEEPreferencesUpdated()メソッド

このメソッドは、BIEEユーザー・プリファレンスの統合のためにのみ提供されます。

シグネチャ

boolean notifyBIEEPreferencesupdated(bieeSessionID);

表5-13 notifyBIEEPreferencesUpdated()メソッドのパラメータ

パラメータ	説明
String bieeSessionID	Oracle Business IntelligenceとBI Publisherの統合に対応したセッションID。

5.16 notifyBIEEPreferencesUpdatedWithString()メソッド

このメソッドは、BIEEユーザー・プリファレンスの統合のためにのみ提供されます。

シグネチャ

boolean notifyBIEEPreferencesUpdatedWithString(String bieeSessionID, String userPrefesXML);

表5-14 notifyBIEEPreferencesUpdatedWithString()メソッドのパラメータ

パラメータ	説明
String bieeSessionID	Oracle Business IntelligenceとBI Publisherの統合に対応したセッションID。
String userPrefesXML	ユーザー・プリファレンスが記述されたXMLデータ。

5.17 removeRolesFromUser()メソッド

removeRolesFromUser()メソッドは、ロールをBI Publisherのユーザーから削除します。

シグネチャ

String[] removeRolesFromUser(String userName, String[] roleNames, String adminUser, String adminPassword);

表5-15 removeRolesFromUser()メソッドのパラメータ

パラメータ	説明
String userName	ロール(複数可)を削除するユーザー。
String[] roleNames	ユーザーから削除するロールの名前。(例: 金融関係のユーザー)。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.18 updateRole()メソッド

updateRole()メソッドは、BI Publisher内に現在あるロールの説明を更新します。

シグネチャ

boolean updateRole(String currentRoleName, String newDescription, String adminUser, String adminPassword);

表5-16 updateRole()メソッドのパラメータ

パラメータ	説明
String currentRoleName	更新するロールの名前。
String newDescription	適用するロールの更新された説明。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.19 updateUser()メソッド

updateUser()メソッドは、BI Publisher内のユーザーのパスワードを更新します。このメソッドは、正常なメソッドのブール値を返します。

シグネチャ

boolean updateUser(String currentUsername, String newPassword, String adminUser, String adminPassword);

表5-17 updateUser()メソッドのパラメータ

パラメータ	説明
String currentUserName	更新するユーザー名。
String newPassword	新しいユーザー名に割り当てる新しいパスワード。
String adminUser	管理権限でユーザーにBI Publisherユーザー名を指定します。
String adminPassword	管理ユーザー名にパスワードを指定します。

5.20 validateLogin()メソッド

validateLogin()メソッドは、Oracle BI Publisherレポート・サーバーにアクセスする権限がuserIDとpasswordにあることを検証します。

シグネチャ

boolean validateLogin(String userID, String password);

表5-18 validateLogin()メソッドのパラメータ

パラメータ	説明
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。