org.springframework.security.web.authentication.logout
Class CookieClearingLogoutHandler

java.lang.Object
  extended by org.springframework.security.web.authentication.logout.CookieClearingLogoutHandler
All Implemented Interfaces:
LogoutHandler

public final class CookieClearingLogoutHandler
extends Object
implements LogoutHandler

A logout handler which clears a defined list of cookies, using the context path as the cookie path.

Since:
3.1

Constructor Summary
CookieClearingLogoutHandler(String... cookiesToClear)
           
 
Method Summary
 void logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication authentication)
          Causes a logout to be completed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CookieClearingLogoutHandler

public CookieClearingLogoutHandler(String... cookiesToClear)
Method Detail

logout

public void logout(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Authentication authentication)
Description copied from interface: LogoutHandler
Causes a logout to be completed. The method must complete successfully.

Specified by:
logout in interface LogoutHandler
Parameters:
request - the HTTP request
response - the HTTP response
authentication - the current principal details