SAWSessionServiceサービス

SAWSessionServiceサービスを使用して、ログオンやログオフなどの認証メソッド、およびその他のセッション関連のメソッドを提供します。

メソッド名	説明
getCurUser()メソッド	セッションの現行ユーザーIDを取得します。
GetSessionEnvironment()メソッド	現行セッションの環境オブジェクトを取得します。
getSessionVariable()メソッド	セッション変数のリストを取得します。
impersonate()メソッド	ログオンしてユーザーを偽装します。
impersonateex()メソッド	ログオンしてユーザーを偽装します。impersonateメソッドに類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。
keepAlive()メソッド	Oracle Analyticsプレゼンテーション・サービスに、特定のセッションが非アクティブであっても終了させないよう指示します。
logoff()メソッド	ユーザーをOracle Analyticsプレゼンテーション・サービスからログオフさせます。
logon()メソッド	ユーザーを認証します
logonex()メソッド	ユーザーを認証しますlogonメソッドと類似していますが、logonexではオプションのセッション・パラメータを指定できます。

getCurUser()メソッド

getCurUser()メソッドを使用して、セッションの現行ユーザー名を取得します。

シグネチャ

String getCurUser(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

セッションの現行ユーザー名を示す文字列を戻します。

GetSessionEnvironment()メソッド

GetSessionEnvironment()メソッドを使用して、現行セッションの環境オブジェクトを取得します。

シグネチャ

SessionEnvironment getSessionEnvironment(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

このメソッドは、セッション環境オブジェクトを返します。

「SessionEnvironment構造体」を参照してください。

getSessionVariable()メソッド

getSessionVariable()メソッドを使用して、セッション変数のリストを取得します。

シグネチャ

List[] getSessionVariables(List[] names, String sessionID);

引数	説明
List[] names	セッション変数の名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

このメソッドは、現行セッションに関連付けられたOracle BI EE変数の値を戻します。

impersonate()メソッド

impersonate()メソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。

このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonate()メソッドを使用する場合、logonメソッドを使用する必要はありません。

ユーザー認証または偽装に失敗した場合、例外がスローされます。

シグネチャ

String impersonate(String name, String password, String impersonateID);

引数	説明
String name	ログオンし、認証を行うユーザー名を指定します。
String password	ユーザーのパスワードの指定ユーザーにパスワードがない場合、このフィールドは空(void)にします。
String impersonateID	認証対象となるユーザーを偽装するユーザー名を指定します。

戻り値

このメソッドは、セッションIDを戻し、HTTPセッションのCookieを設定します。

セッションIDは、別のメソッドでOracle Analytics Webサービスのセッションの識別に使用されます。

impersonateex()メソッド

impersonateex()メソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。

impersonateメソッドに類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonateex()メソッドを使用する場合、logonメソッドを使用する必要はありません。

ユーザー認証または偽装に失敗した場合、例外がスローされます。

シグネチャ

AuthResults impersonateex(String name, String password, String impersonateID, SAWSessionParameters sessionparams);

引数	説明
String name	ログオンし、認証を行うユーザー名を指定します。
String password	ユーザーのパスワードの指定ユーザーにパスワードがない場合、このフィールドは空(void)にします。
String impersonateID	認証対象となるユーザーを偽装するユーザー名を指定します。
SAWSessionParameters sessionparams	オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、「SAWSessionParameters構造体」を参照してください。

戻り値

このメソッドは、セッションIDを含むAuthResult構造体を戻し、HTTPセッションのCookieを設定します。

セッションIDは、別のメソッドでOracle Analyticsプレゼンテーション・サービス・セッションの識別に使用されます。詳細は、「AuthResult構造体」を参照してください。

keepAlive()メソッド

keepAlive()メソッドを使用して、Oracle Analyticsプレゼンテーション・サービスに、特定のWebユーザーが非アクティブであっても終了しないよう指示します。

セッション存続期間におけるこのメソッドの効果は、ユーザーがブラウザでアクティビティを実行した(分析のクリック、メソッドの起動など)場合と同様です。

シグネチャ

void keepAlive(String[] sessionID);

引数	説明
String[] sessionID	ログオン状態のままにするセッションIDを指定します。

logoff()メソッド

logoff()メソッドを使用して、Oracle Analyticsからユーザーをログオフします。

シグネチャ

void logoff(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

logon()メソッド

logon()メソッドを使用して、ユーザーを認証します。認証に失敗した場合、例外がスローされます。

シグネチャ

String logon(String name, String password);

引数	説明
String name	認証を行うユーザー名を指定します。
String password	ユーザーのパスワードの指定パスワードがない場合、このフィールドは空(void)にします。

OAuth2トークンをサポートするアイデンティティ管理システムを使用してOracle Analytics Serverを構成した場合は、ユーザー名とパスワードのかわりにアクセス・トークンを認可ヘッダーに渡すことで、セッションIDを取得できます。

戻り値

このメソッドは、セッションIDを戻し、HTTPセッションのCookieを設定します。

セッションIDは、別のメソッドでOracle Analyticsのセッションの識別に使用されます。

logonex()メソッド

logonex()メソッドを使用して、ユーザーを認証します。logonメソッドと類似していますが、logonex()メソッドではオプションのセッション・パラメータを指定できます。

認証に失敗した場合、例外がスローされます。

シグネチャ

AuthResult logonex(String name, String password, SAWSessionParameters sessionparams);

引数	説明
String name	認証を行うユーザー名を指定します。
String password	ユーザーのパスワードの指定パスワードがない場合、このフィールドは空(void)にします。
SAWSessionParameters sessionparams	オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、「SAWSessionParameters構造体」を参照してください。

戻り値

このメソッドは、セッションIDを含むAuthResult構造体を戻し、HTTPセッションのCookieを設定します。

セッションIDは、別のメソッドでOracle Analyticsプレゼンテーション・サービス・セッションの識別に使用されます。