C# Class NGM.CasClient.Client.State.CacheServiceTicketManager

Inheritance: IServiceTicketManagerWrapper

Mostra file Open project: NIKASoftwareDevs/Orchard

Private Properties

Property	Type	Description
GetTicketKey	string

Public Methods

Method	Description
CacheServiceTicketManager ( IHttpContextAccessor httpContextAccessor ) : System	The constructor is marked internal because this object is not suitable for use outside of this assembly.
ContainsTicket ( string serviceTicket ) : bool	Indicates whether or not the ticket store contains the supplied serviceTicket
GetAllServiceTickets ( ) : IEnumerable	Retrieves all CAS Service Tickets in the ticket store that have not already expired.
GetAllTicketedUsers ( ) : IEnumerable	Retrieves a list of all users that have non-expired CAS authentication tickets.
GetAllTickets ( ) : IEnumerable	Retrieves all tickets in the ticket store that have not already expired.
GetTicket ( string serviceTicket ) : CasAuthenticationTicket	Retrieve a CasAuthenticationTicket from the ticket store by it's CAS Service Ticket
GetUserServiceTickets ( string netId ) : IEnumerable	Retrieves all non-expired CAS Service Tickets in the ticket store associated with the netId supplied.
GetUserTickets ( string netId ) : IEnumerable	Retrieves all non-expired tickets in the ticket store associated with the netId supplied.
Initialize ( ) : void	Performs initialization of the CacheServiceTicketManager
InsertTicket ( CasAuthenticationTicket casAuthenticationTicket, System.DateTime expiration ) : void	Inserts a CasAuthenticationTicket to the ticket store with a corresponding ticket expiration date.
RemoveExpiredTickets ( ) : void	Removes expired entries from the ticket store
RevokeTicket ( string serviceTicket ) : 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 netId ) : void	Revoke all tickets corresponding to the supplied NetId.
UpdateTicketExpiration ( CasAuthenticationTicket casAuthenticationTicket, 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).
VerifyClientTicket ( CasAuthenticationTicket casAuthenticationTicket ) : bool	Verify that the supplied casAuthenticationTicket exists in the ticket store

Private Methods

Method	Description
GetTicketKey ( string serviceTicket ) : string	Converts a CAS Service Ticket to its corresponding key in the ticket manager store (cache provider).

Method Details

CacheServiceTicketManager() public method

The constructor is marked internal because this object is not suitable for use outside of this assembly.

public CacheServiceTicketManager ( IHttpContextAccessor httpContextAccessor ) : System
httpContextAccessor	IHttpContextAccessor
return	System

ContainsTicket() public method

Indicates whether or not the ticket store contains the supplied serviceTicket

serviceTicket is null serviceTicket is empty

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

GetAllServiceTickets() public method

Retrieves all CAS Service Tickets in the ticket store that have not already expired.

public GetAllServiceTickets ( ) : IEnumerable
return	IEnumerable

GetAllTicketedUsers() public method

Retrieves a list of all users that have non-expired CAS authentication tickets.

public GetAllTicketedUsers ( ) : IEnumerable
return	IEnumerable

GetAllTickets() public method

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

public GetAllTickets ( ) : IEnumerable
return	IEnumerable

GetTicket() public method

Retrieve a CasAuthenticationTicket from the ticket store by it's CAS Service Ticket

serviceTicket is null serviceTicket is empty

public GetTicket ( string serviceTicket ) : CasAuthenticationTicket
serviceTicket	string	The service ticket generated by the CAS server
return	CasAuthenticationTicket

GetUserServiceTickets() public method

Retrieves all non-expired CAS Service Tickets in the ticket store associated with the netId supplied.

netId is null netId is empty

public GetUserServiceTickets ( string netId ) : IEnumerable
netId	string	The netId to search the collection for
return	IEnumerable

GetUserTickets() public method

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

netId is null netId is empty

public GetUserTickets ( string netId ) : IEnumerable
netId	string	The NetId to search the collection for
return	IEnumerable

Initialize() public method

Performs initialization of the CacheServiceTicketManager

public Initialize ( ) : void
return	void

InsertTicket() public method

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

casAuthenticationTicket is null

public InsertTicket ( CasAuthenticationTicket casAuthenticationTicket, System.DateTime expiration ) : void
casAuthenticationTicket	CasAuthenticationTicket	The CasAuthenticationTicket 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).

serviceTicket is null serviceTicket is empty

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

RevokeUserTickets() public method

Revoke all tickets corresponding to the supplied NetId.

The netId supplied is null The netId supplied is empty

public RevokeUserTickets ( string netId ) : void
netId	string	The NetId to revoke tickets for
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).

casAuthenticationTicket is null

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

VerifyClientTicket() public method

Verify that the supplied casAuthenticationTicket exists in the ticket store

public VerifyClientTicket ( CasAuthenticationTicket casAuthenticationTicket ) : bool
casAuthenticationTicket	CasAuthenticationTicket	The casAuthenticationTicket to verify
return	bool