C# Class Rock.Security.AuthenticationComponent

Base class for components that perform authentication based on a username and password entered by the user
Inheritance: Rock.Extension.Component
Afficher le fichier Open project: NewSpring/Rock

Méthodes publiques

Méthode Description
Authenticate ( HttpRequest request, string &userName, string &returnUrl ) : System.Boolean

Authenticates the user based on a request from a third-party provider. Will set the username and returnUrl values.

Authenticate ( UserLogin user, string password ) : System.Boolean

Authenticates the user based on user name and password

ChangePassword ( UserLogin user, string oldPassword, string newPassword, string &warningMessage ) : bool

Changes the password.

EncodePassword ( UserLogin user, string password ) : String

Encodes the password.

GenerateLoginUrl ( HttpRequest request ) : Uri

Generates the login URL.

ImageUrl ( ) : String

Gets the URL of an image that should be displayed.

IsReturningFromAuthentication ( HttpRequest request ) : System.Boolean

Tests the Http Request to determine if authentication should be tested by this authentication provider.

SetPassword ( UserLogin user, string password ) : void

Sets the password.

Method Details

Authenticate() public abstract méthode

Authenticates the user based on a request from a third-party provider. Will set the username and returnUrl values.
public abstract Authenticate ( HttpRequest request, string &userName, string &returnUrl ) : System.Boolean
request System.Web.HttpRequest The request.
userName string Name of the user.
returnUrl string The return URL.
Résultat System.Boolean

Authenticate() public abstract méthode

Authenticates the user based on user name and password
public abstract Authenticate ( UserLogin user, string password ) : System.Boolean
user UserLogin The user.
password string The password.
Résultat System.Boolean

ChangePassword() public abstract méthode

Changes the password.
public abstract ChangePassword ( UserLogin user, string oldPassword, string newPassword, string &warningMessage ) : bool
user UserLogin The user.
oldPassword string The old password.
newPassword string The new password.
warningMessage string The warning message.
Résultat bool

EncodePassword() public abstract méthode

Encodes the password.
public abstract EncodePassword ( UserLogin user, string password ) : String
user UserLogin The user.
password string The password.
Résultat String

GenerateLoginUrl() public abstract méthode

Generates the login URL.
public abstract GenerateLoginUrl ( HttpRequest request ) : Uri
request System.Web.HttpRequest The request.
Résultat System.Uri

ImageUrl() public abstract méthode

Gets the URL of an image that should be displayed.
public abstract ImageUrl ( ) : String
Résultat String

IsReturningFromAuthentication() public abstract méthode

Tests the Http Request to determine if authentication should be tested by this authentication provider.
public abstract IsReturningFromAuthentication ( HttpRequest request ) : System.Boolean
request System.Web.HttpRequest The request.
Résultat System.Boolean

SetPassword() public abstract méthode

Sets the password.
public abstract SetPassword ( UserLogin user, string password ) : void
user UserLogin The user.
password string The password.
Résultat void