Class SpringCacheBasedTicketCache
- java.lang.Object
-
- org.springframework.security.cas.authentication.SpringCacheBasedTicketCache
-
- All Implemented Interfaces:
StatelessTicketCache
public class SpringCacheBasedTicketCache extends java.lang.Object implements StatelessTicketCache
Caches tickets using a Spring IoC definedCache
.- Since:
- 3.2
-
-
Constructor Summary
Constructors Constructor Description SpringCacheBasedTicketCache(org.springframework.cache.Cache cache)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CasAuthenticationToken
getByTicketId(java.lang.String serviceTicket)
Retrieves theCasAuthenticationToken
associated with the specified ticket.void
putTicketInCache(CasAuthenticationToken token)
Adds the specifiedCasAuthenticationToken
to the cache.void
removeTicketFromCache(java.lang.String serviceTicket)
Removes the specified ticket from the cache, meaning that future calls will require a new service ticket.void
removeTicketFromCache(CasAuthenticationToken token)
Removes the specified ticket from the cache, as perStatelessTicketCache.removeTicketFromCache(String)
.
-
-
-
Method Detail
-
getByTicketId
public CasAuthenticationToken getByTicketId(java.lang.String serviceTicket)
Description copied from interface:StatelessTicketCache
Retrieves theCasAuthenticationToken
associated with the specified ticket.If not found, returns a
null
CasAuthenticationToken
.- Specified by:
getByTicketId
in interfaceStatelessTicketCache
- Returns:
- the fully populated authentication token
-
putTicketInCache
public void putTicketInCache(CasAuthenticationToken token)
Description copied from interface:StatelessTicketCache
Adds the specifiedCasAuthenticationToken
to the cache.The
CasAuthenticationToken.getCredentials()
method is used to retrieve the service ticket number.- Specified by:
putTicketInCache
in interfaceStatelessTicketCache
- Parameters:
token
- to be added to the cache
-
removeTicketFromCache
public void removeTicketFromCache(CasAuthenticationToken token)
Description copied from interface:StatelessTicketCache
Removes the specified ticket from the cache, as perStatelessTicketCache.removeTicketFromCache(String)
.Implementations should use
CasAuthenticationToken.getCredentials()
to obtain the ticket and then delegate to theStatelessTicketCache.removeTicketFromCache(String)
method.- Specified by:
removeTicketFromCache
in interfaceStatelessTicketCache
- Parameters:
token
- to be removed
-
removeTicketFromCache
public void removeTicketFromCache(java.lang.String serviceTicket)
Description copied from interface:StatelessTicketCache
Removes the specified ticket from the cache, meaning that future calls will require a new service ticket.This is in case applications wish to provide a session termination capability for their stateless clients.
- Specified by:
removeTicketFromCache
in interfaceStatelessTicketCache
- Parameters:
serviceTicket
- to be removed
-
-