Sys.Services.AuthenticationService クラス

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

認証サービスのクライアントプロキシクラスを提供します。

名前空間 :Sys.Services

継承 : なし

メンバ

名前	説明
Sys.Services.AuthenticationService コンストラクタ	Sys.Services.AuthenticationService クラスの新しいインスタンスを初期化します。
Sys.Services.AuthenticationService.DefaultWebServicePath フィールド	既定の認証サービスへのパスを指定します。
Sys.Services AuthenticationService の login メソッド	ユーザーの資格情報を認証します。
Sys.Services AuthenticationService の logout メソッド	現在認証されているユーザーをログアウトします。
Sys.Services の AuthenticationService の defaultFailedCallback プロパティ	既定の失敗コールバック関数の名前を取得または設定します。
Sys.Services の AuthenticationService の defaultLoginCompletedCallback プロパティ	既定のログイン完了コールバック関数の名前を取得または設定します。
Sys.Services の AuthenticationService の defaultLogoutCompletedCallback プロパティ	既定のログアウト完了コールバック関数の名前を取得または設定します。
Sys.Services の AuthenticationService の defaultSucceededCallback プロパティ	サービスの既定の成功コールバック関数を取得または設定します。
Sys.Services の AuthenticationService の defaultUserContext プロパティ	サービスの既定のユーザーコンテキストを取得または設定します。
Sys.Services の AuthenticationService の isLoggedIn プロパティ	現在のユーザーの認証状態を取得します。
Sys.Services の AuthenticationService の path プロパティ	認証サービスパスを取得または設定します。
Sys.Services の AuthenticationService の timeout プロパティ	認証サービスのタイムアウト値を取得または設定します。

解説

AuthenticationService クラスは、ユーザー認証へのスクリプトアクセスを提供します。認証サービスのメソッドを、他の Web サービスメソッドを呼び出す場合と同じインフラストラクチャを介して呼び出します。

メモ :
組み込みの認証サービスは、サーバー上の定義された場所に保存されています。

AuthenticationService クラスはシングルトンで、アクセスのグローバルポイントを持つインスタンスが 1 つだけ含まれます。アプリケーションでいつでも使用でき、インスタンス化する必要はありません。

例

説明

AuthenticationService クラスを使用してユーザーが認証されているかどうかを確認する方法を次の例に示します。詳細については、「ASP.NET AJAX でのフォーム認証の使用」を参照してください。

コード

// Define global variables.
var usernameEntry;
var passwordEntry;
var username;
var password;
var textLoggedIn;
var textNotLoggedIn;
var buttonLogin;  
var buttonLogout; 

function pageLoad()
{
    usernameEntry = $get("NameId");
    passwordEntry = $get("PwdId");
    username = $get("username");
    password = $get("password");
    textLoggedIn = $get("loggedin");
    textNotLoggedIn = $get("notloggedin");
    buttonLogin = $get("ButtonLogin");  
    buttonLogout = $get("ButtonLogout"); 
}



// This function sets and gets the default
// login completed callback function.
function SetDefaultLoginCompletedCallBack()
{
    // Set the default callback function.
    Sys.Services.AuthenticationService.set_defaultLoginCompletedCallback(OnLoginCompleted);

    // Get the default callback function.
    var callBack =     
        Sys.Services.AuthenticationService.get_defaultLoginCompletedCallback();
}

// This function sets and gets the default
// logout completed callback function.
function SetDefaultLogoutCompletedCallBack()
{
    // Set the default callback function.
    Sys.Services.AuthenticationService.set_defaultLogoutCompletedCallback(OnLogoutCompleted);

    // Get the default callback function.
    var callBack =     
        Sys.Services.AuthenticationService.get_defaultLogoutCompletedCallback();
}


// This function sets and gets the default
// failed callback function.
function SetDefaultFailedCallBack()
{
    // Set the default callback function.
    Sys.Services.AuthenticationService.set_defaultFailedCallback(OnFailed);

    // Get the default callback function.
    var callBack =     
        Sys.Services.AuthenticationService.get_defaultFailedCallback();  
}


// This function calls the login method of the
// authentication service to verify 
// the credentials entered by the user.
// If the credentials are authenticated, the
// authentication service issues a forms 
// authentication cookie. 
function OnClickLogin() 
{   

    // Set the default callback functions.
    SetDefaultLoginCompletedCallBack();
    SetDefaultLogoutCompletedCallBack();
    SetDefaultFailedCallBack();

    // Call the authetication service to authenticate
    // the credentials entered by the user.
    Sys.Services.AuthenticationService.login(username.value, 
        password.value, false,null,null,null,null,"User Context");
}

// This function calls the logout method of the
// authentication service to clear the forms 
// authentication cookie.
function OnClickLogout() 
{  
   // Clear the forms authentication cookie. 
   Sys.Services.AuthenticationService.logout(null, 
        null, null, null); 
} 



// This is the callback function called 
// if the authentication fails.      
function OnFailed(error, 
    userContext, methodName)
{           
    // Display feedback message.
    DisplayInformation("error:message = " + 
        error.get_message());
    DisplayInformation("error:timedOut = " + 
        error.get_timedOut());
    DisplayInformation("error:statusCode = " + 
        error.get_statusCode());            
}


// The callback function called 
// if the authentication completed successfully.
function OnLoginCompleted(validCredentials, 
    userContext, methodName)
{
    // GetPageElements();
    
    // Clear the user password.
    password.value = "";

    // On success there will be a forms 
    // authentication cookie in the browser.
    if (validCredentials == true) 
    {

        // Clear the user name.
        username.value = "";

        // Hide login fields.
        buttonLogin.style.visibility = "hidden";
        usernameEntry.style.visibility = "hidden";
        passwordEntry.style.visibility = "hidden";
        textNotLoggedIn.style.visibility = "hidden";  

        // Display logout fields.
        buttonLogout.style.visibility = "visible";
        textLoggedIn.style.visibility = "visible";

        // Clear the feedback area.
        DisplayInformation(""); 
    }
    else 
    {
        textLoggedIn.style.visibility = "hidden";
        textNotLoggedIn.style.visibility = "visible";
        DisplayInformation(
            "Login Credentials Invalid. Could not login"); 
    }
    
}

// This is the callback function called 
// if the user logged out successfully.
function OnLogoutCompleted(result) 
{
    // Display login fields.
    usernameEntry.style.visibility = "visible";
    passwordEntry.style.visibility = "visible";
    textNotLoggedIn.style.visibility = "visible";  
    buttonLogin.style.visibility = "visible";

    // Hide logout fields.
    buttonLogout.style.visibility = "hidden";
    textLoggedIn.style.visibility = "hidden";

}            

// This function displays feedback
// information for the user.    
function DisplayInformation(text)
{
    // var feedBack = 
    //    document.getElementById("FeedBackID").innerHTML;

    document.getElementById("FeedBackID").innerHTML = 
        "<br/>" + text;

    // Display authentication service information.

    var userLoggedIn =
        Sys.Services.AuthenticationService.get_isLoggedIn();
    
    var authServiceTimeout =       
        Sys.Services.AuthenticationService.get_timeout();

    var userLoggedInfo = 
        "<br/> User logged in:                 " + userLoggedIn;

    var timeOutInfo = 
        "<br/> Authentication service timeout: " + authServiceTimeout;

    document.getElementById("FeedBackID").innerHTML = 
        userLoggedInfo + timeOutInfo;

}

// Notify ScriptManager that this is the end of the script.
if (typeof(Sys) !== 'undefined') Sys.Application.notifyScriptLoaded();

参照

概念

Sys.Services.ProfileService クラス

Sys.Net.WebServiceProxy クラス

ASP.NET AJAX でのフォーム認証の使用

次の方法で共有

Sys.Services.AuthenticationService クラス

メンバ

解説

例

説明

コード

参照

概念

その他のリソース