C# Class Sholo.Web.Security.Authentication.User.Provider.CacheUserAuthenticationTicketProvider

An IUserAuthenticationTicketProvider implementation that relies on the ASP.NET Caching model for ticket storage. Generally this implies that the ticket storage is maintained locally on the web server (either in memory or on disk). A limitation of this model is that it will not support clustered, load balanced, or round-robin style configurations.

Inheritance: UserAuthenticationTicketProviderBase

Afficher le fichier Open project: scottt732/SholoWebSecurity

Méthodes publiques

Méthode	Description
ContainsTicket ( string userAuthenticationTicketKey ) : bool	Indicates whether or not the ticket store contains the supplied userAuthenticationTicketKey
GetAllTicketKeys ( ) : IEnumerable	Retrieves all UserAuthenticationTicket keys in the ticket store that have not already expired.
GetAllTicketedUsers ( ) : IEnumerable	Retrieves a list of all users that have non-expired ServerAuthenticationTickets.
GetAllTickets ( ) : IEnumerable	Retrieves all tickets in the ticket store that have not already expired.
GetTicket ( string userAuthenticationTicketKey ) : UserAuthenticationTicket	Retrieve a UserAuthenticationTicket from the ticket store by it's ticket key
GetUserTicketKeys ( string username ) : IEnumerable	Retrieves all non-expired UserAuthenticationTicket keys in the ticket store associated with the username supplied.
GetUserTickets ( string username ) : IEnumerable	Retrieves all non-expired tickets in the ticket store associated with the username supplied.
Initialize ( string name, NameValueCollection config ) : void	Initializes the CacheUserAuthenticationTicketProvider module.
InsertTicket ( UserAuthenticationTicket ticket, System.DateTime expiration ) : void	Inserts a UserAuthenticationTicket to the ticket store with a corresponding ticket expiration date.
RemoveExpiredTickets ( ) : void	Removes expired entries from the ticket store
RevokeTicket ( string userAuthenticationTicketKey ) : void	Removes the ticket from the collection if it exists. If the ticket does not exist in the ticket store, just return (do not throw an exception).
RevokeUserTickets ( string username ) : void	Revoke all tickets corresponding to the supplied Username.
UpdateTicketExpiration ( UserAuthenticationTicket ticket, System.DateTime newExpiration ) : void	Updates the expiration date and time for an existing ticket. If the ticket does not exist in the ticket store, just return (do not throw an exception).
VerifyTicket ( UserAuthenticationTicket ticket ) : bool	Verify that the supplied UserAuthenticationTicket exists in the ticket store

Private Methods

Méthode	Description
GetCacheKey ( string ticketKey ) : string	Converts a ticketKey to a corresponding key in the ticket store (cache provider).

Method Details

ContainsTicket() public méthode

Indicates whether or not the ticket store contains the supplied userAuthenticationTicketKey

userAuthenticationTicketKey is null userAuthenticationTicketKey is empty

public ContainsTicket ( string userAuthenticationTicketKey ) : bool
userAuthenticationTicketKey	string	The ticket to check for
Résultat	bool

GetAllTicketKeys() public méthode

Retrieves all UserAuthenticationTicket keys in the ticket store that have not already expired.

public GetAllTicketKeys ( ) : IEnumerable
Résultat	IEnumerable

GetAllTicketedUsers() public méthode

Retrieves a list of all users that have non-expired ServerAuthenticationTickets.

public GetAllTicketedUsers ( ) : IEnumerable
Résultat	IEnumerable

GetAllTickets() public méthode

Retrieves all tickets in the ticket store that have not already expired.

public GetAllTickets ( ) : IEnumerable
Résultat	IEnumerable

GetTicket() public méthode

Retrieve a UserAuthenticationTicket from the ticket store by it's ticket key

userAuthenticationTicketKey is null userAuthenticationTicketKey is empty

public GetTicket ( string userAuthenticationTicketKey ) : UserAuthenticationTicket
userAuthenticationTicketKey	string	The ticket key generated by the server
Résultat	UserAuthenticationTicket

GetUserTicketKeys() public méthode

Retrieves all non-expired UserAuthenticationTicket keys in the ticket store associated with the username supplied.

username is null username is empty

public GetUserTicketKeys ( string username ) : IEnumerable
username	string	The username to search the collection for
Résultat	IEnumerable

GetUserTickets() public méthode

Retrieves all non-expired tickets in the ticket store associated with the username supplied.

username is null username is empty

public GetUserTickets ( string username ) : IEnumerable
username	string	The Username to search the collection for
Résultat	IEnumerable

Initialize() public méthode

Initializes the CacheUserAuthenticationTicketProvider module.

public Initialize ( string name, NameValueCollection config ) : void
name	string
config	System.Collections.Specialized.NameValueCollection
Résultat	void

InsertTicket() public méthode

Inserts a UserAuthenticationTicket to the ticket store with a corresponding ticket expiration date.

UserAuthenticationTicket is null

public InsertTicket ( UserAuthenticationTicket ticket, System.DateTime expiration ) : void
ticket	UserAuthenticationTicket	The UserAuthenticationTicket to insert
expiration	System.DateTime	The date and time at which the ticket expires
Résultat	void

RemoveExpiredTickets() public méthode

Removes expired entries from the ticket store

public RemoveExpiredTickets ( ) : void
Résultat	void

RevokeTicket() public méthode

Removes the ticket from the collection if it exists. If the ticket does not exist in the ticket store, just return (do not throw an exception).

userAuthenticationTicketKey is null userAuthenticationTicketKey is empty

public RevokeTicket ( string userAuthenticationTicketKey ) : void
userAuthenticationTicketKey	string	The ticket to remove from the ticket store
Résultat	void

RevokeUserTickets() public méthode

Revoke all tickets corresponding to the supplied Username.

The username supplied is null The username supplied is empty

public RevokeUserTickets ( string username ) : void
username	string	The Username to revoke tickets for
Résultat	void

UpdateTicketExpiration() public méthode

Updates the expiration date and time for an existing ticket. If the ticket does not exist in the ticket store, just return (do not throw an exception).

UserAuthenticationTicket is null

public UpdateTicketExpiration ( UserAuthenticationTicket ticket, System.DateTime newExpiration ) : void
ticket	UserAuthenticationTicket	The UserAuthenticationTicket to insert
newExpiration	System.DateTime	The new expiration date and time
Résultat	void

VerifyTicket() public méthode

Verify that the supplied UserAuthenticationTicket exists in the ticket store

public VerifyTicket ( UserAuthenticationTicket ticket ) : bool
ticket	UserAuthenticationTicket	The UserAuthenticationTicket to verify
Résultat	bool