Package org.craftercms.security.processors.impl

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 final String	DEFAULT_LOGOUT_METHOD
static final String	DEFAULT_LOGOUT_URL
static final org.slf4j.Logger	logger
protected String	logoutMethod
protected LogoutSuccessHandler	logoutSuccessHandler
protected String	logoutUrl
protected RememberMeManager	rememberMeManager

Constructor Summary

Constructors

Constructor	Description
LogoutProcessor(AuthenticationManager authenticationManager, LogoutSuccessHandler logoutSuccessHandler, RememberMeManager rememberMeManager)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	isLogoutRequest(jakarta.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 the logoutUrl and the HTTP method matches the logoutMethod.
void	setLogoutMethod(String logoutMethod)
void	setLogoutUrl(String logoutUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

Constructor Details

LogoutProcessor

public LogoutProcessor(AuthenticationManager authenticationManager,
 LogoutSuccessHandler logoutSuccessHandler,
 RememberMeManager rememberMeManager)

Default constructor.

Method Details

setLogoutUrl

public void setLogoutUrl(String logoutUrl)

setLogoutMethod

public void setLogoutMethod(String logoutMethod)

processRequest

public void processRequest(org.craftercms.commons.http.RequestContext context,
 RequestSecurityProcessorChain processorChain)
                    throws Exception

Checks if the request URL matches the logoutUrl and the HTTP method matches the logoutMethod. If it does, it proceeds to logout the user, by invalidating the authentication through AuthenticationManager.invalidateAuthentication(Authentication)

Specified by:

processRequest in interface RequestSecurityProcessor

Parameters:

context - the context which holds the current request and response

processorChain - the processor chain, used to call the next processor

Throws:

Exception

isLogoutRequest

protected boolean isLogoutRequest(jakarta.servlet.http.HttpServletRequest request)

onLogoutSuccess

protected void onLogoutSuccess(org.craftercms.commons.http.RequestContext context,
 Authentication authentication)
                        throws IOException

Throws:

IOException