C# Class Sholo.Web.Security.Authentication.Device.Provider.CacheDeviceAuthenticationTicketProvider

Inheritance: DeviceAuthenticationTicketProviderBase

Exibir arquivo Open project: scottt732/SholoWebSecurity

Public Methods

Method	Description
ContainsTicket ( string ticketKey ) : bool	Indicates whether or not the ticket store contains the supplied userAuthenticationTicketKey
GetAllTicketKeys ( ) : IEnumerable	Retrieves all DeviceAuthenticationTicket keys in the ticket store that have not already expired.
GetAllTickets ( ) : IEnumerable	Retrieves all tickets in the ticket store that have not already expired.
GetDeviceTicketsByHostAddress ( string hostAddress ) : IEnumerable
GetDeviceUsers ( ) : IEnumerable
GetTicket ( string ticketKey ) : DeviceAuthenticationTicket	Retrieve a DeviceAuthenticationTicket from the ticket store by it's ticket key
Initialize ( string name, NameValueCollection config ) : void	Initializes the CacheUserAuthenticationTicketProvider module.
InsertTicket ( DeviceAuthenticationTicket ticket, System.DateTime expiration ) : void	Inserts a DeviceAuthenticationTicket to the ticket store with a corresponding ticket expiration date.
RemoveExpiredTickets ( ) : void	Removes expired entries from the ticket store
RevokeTicket ( string ticketKey ) : 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).
UpdateTicketExpiration ( DeviceAuthenticationTicket 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 ( DeviceAuthenticationTicket ticket ) : bool	Verify that the supplied DeviceAuthenticationTicket exists in the ticket store

Private Methods

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

Method Details

ContainsTicket() public method

Indicates whether or not the ticket store contains the supplied userAuthenticationTicketKey

ticketKey is null ticketKey is empty

public ContainsTicket ( string ticketKey ) : bool
ticketKey	string	The ticket to check for
return	bool

GetAllTicketKeys() public method

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

public GetAllTicketKeys ( ) : IEnumerable
return	IEnumerable

GetAllTickets() public method

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

public GetAllTickets ( ) : IEnumerable
return	IEnumerable

GetDeviceTicketsByHostAddress() public method

public GetDeviceTicketsByHostAddress ( string hostAddress ) : IEnumerable
hostAddress	string
return	IEnumerable

GetDeviceUsers() public method

public GetDeviceUsers ( ) : IEnumerable
return	IEnumerable

GetTicket() public method

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

ticketKey is null ticketKey is empty

public GetTicket ( string ticketKey ) : DeviceAuthenticationTicket
ticketKey	string	The ticket key generated by the server
return	DeviceAuthenticationTicket

Initialize() public method

Initializes the CacheUserAuthenticationTicketProvider module.

public Initialize ( string name, NameValueCollection config ) : void
name	string
config	System.Collections.Specialized.NameValueCollection
return	void

InsertTicket() public method

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

DeviceAuthenticationTicket is null

public InsertTicket ( DeviceAuthenticationTicket ticket, System.DateTime expiration ) : void
ticket	DeviceAuthenticationTicket	The DeviceAuthenticationTicket to insert
expiration	System.DateTime	The date and time at which the ticket expires
return	void

RemoveExpiredTickets() public method

Removes expired entries from the ticket store

public RemoveExpiredTickets ( ) : void
return	void

RevokeTicket() public method

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).

icketKey is null ticketKey is empty

public RevokeTicket ( string ticketKey ) : void
ticketKey	string	The ticket to remove from the ticket store
return	void

UpdateTicketExpiration() public method

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).

DeviceAuthenticationTicket is null

public UpdateTicketExpiration ( DeviceAuthenticationTicket ticket, System.DateTime newExpiration ) : void
ticket	DeviceAuthenticationTicket	The DeviceAuthenticationTicket to insert
newExpiration	System.DateTime	The new expiration date and time
return	void

VerifyTicket() public method

Verify that the supplied DeviceAuthenticationTicket exists in the ticket store

public VerifyTicket ( DeviceAuthenticationTicket ticket ) : bool
ticket	DeviceAuthenticationTicket	The DeviceAuthenticationTicket to verify
return	bool