Class LogoutProcessor
- java.lang.Object
-
- org.craftercms.security.processors.impl.LogoutProcessor
-
- All Implemented Interfaces:
RequestSecurityProcessor
public class LogoutProcessor extends Object implements RequestSecurityProcessor
Processes logout requests.- Author:
- Alfonso Vásquez
-
-
Field Summary
Fields Modifier and Type Field Description protected AuthenticationManager
authenticationManager
static String
DEFAULT_LOGOUT_METHOD
static String
DEFAULT_LOGOUT_URL
static org.slf4j.Logger
logger
protected String
logoutMethod
protected LogoutSuccessHandler
logoutSuccessHandler
protected String
logoutUrl
protected RememberMeManager
rememberMeManager
-
Constructor Summary
Constructors Constructor Description LogoutProcessor()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
isLogoutRequest(javax.servlet.http.HttpServletRequest request)
protected void
onLogoutSuccess(org.craftercms.commons.http.RequestContext context, Authentication authentication)
void
processRequest(org.craftercms.commons.http.RequestContext context, RequestSecurityProcessorChain processorChain)
Checks if the request URL matches thelogoutUrl
and the HTTP method matches thelogoutMethod
.void
setAuthenticationManager(AuthenticationManager authenticationManager)
void
setLogoutMethod(String logoutMethod)
void
setLogoutSuccessHandler(LogoutSuccessHandler logoutSuccessHandler)
void
setLogoutUrl(String logoutUrl)
void
setRememberMeManager(RememberMeManager rememberMeManager)
-
-
-
Field Detail
-
logger
public static final org.slf4j.Logger logger
-
DEFAULT_LOGOUT_URL
public static final String DEFAULT_LOGOUT_URL
- See Also:
- Constant Field Values
-
DEFAULT_LOGOUT_METHOD
public static final String DEFAULT_LOGOUT_METHOD
- See Also:
- Constant Field Values
-
logoutUrl
protected String logoutUrl
-
logoutMethod
protected String logoutMethod
-
authenticationManager
protected AuthenticationManager authenticationManager
-
logoutSuccessHandler
protected LogoutSuccessHandler logoutSuccessHandler
-
rememberMeManager
protected RememberMeManager rememberMeManager
-
-
Method Detail
-
setLogoutUrl
public void setLogoutUrl(String logoutUrl)
-
setLogoutMethod
public void setLogoutMethod(String logoutMethod)
-
setAuthenticationManager
public void setAuthenticationManager(AuthenticationManager authenticationManager)
-
setLogoutSuccessHandler
public void setLogoutSuccessHandler(LogoutSuccessHandler logoutSuccessHandler)
-
setRememberMeManager
public void setRememberMeManager(RememberMeManager rememberMeManager)
-
processRequest
public void processRequest(org.craftercms.commons.http.RequestContext context, RequestSecurityProcessorChain processorChain) throws Exception
Checks if the request URL matches thelogoutUrl
and the HTTP method matches thelogoutMethod
. If it does, it proceeds to logout the user, by invalidating the authentication throughAuthenticationManager.invalidateAuthentication(Authentication)
- Specified by:
processRequest
in interfaceRequestSecurityProcessor
- Parameters:
context
- the context which holds the current request and responseprocessorChain
- the processor chain, used to call the next processor- Throws:
Exception
-
isLogoutRequest
protected boolean isLogoutRequest(javax.servlet.http.HttpServletRequest request)
-
onLogoutSuccess
protected void onLogoutSuccess(org.craftercms.commons.http.RequestContext context, Authentication authentication) throws IOException
- Throws:
IOException
-
-