Package org.craftercms.security.authentication.impl

Class RestLogoutSuccessHandler

java.lang.Object

org.craftercms.security.utils.handlers.AbstractRestHandlerBase

org.craftercms.security.authentication.impl.RestLogoutSuccessHandler

All Implemented Interfaces:

LogoutSuccessHandler

public class RestLogoutSuccessHandler
extends AbstractRestHandlerBase
implements LogoutSuccessHandler

Implementation of LogoutSuccessHandler for REST based applications, which just returns a 200 OK status with a simple success message.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_LOGOUT_SUCCESS_MESSAGE
protected String	logoutSuccessMessage

Fields inherited from class org.craftercms.security.utils.handlers.AbstractRestHandlerBase

responseWriter

Constructor Summary

Constructors

Constructor	Description
RestLogoutSuccessHandler(org.craftercms.commons.rest.HttpMessageConvertingResponseWriter responseWriter)

Method Summary

Modifier and Type	Method	Description
void	handle(org.craftercms.commons.http.RequestContext context)	Handles the request after a successful logout.
void	setLogoutSuccessMessage(String logoutSuccessMessage)

Methods inherited from class org.craftercms.security.utils.handlers.AbstractRestHandlerBase

sendErrorMessage, sendMessage, sendObject

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOGOUT_SUCCESS_MESSAGE

protected static final String DEFAULT_LOGOUT_SUCCESS_MESSAGE

See Also:

• Constant Field Values

logoutSuccessMessage

protected String logoutSuccessMessage

Constructor Details

RestLogoutSuccessHandler

public RestLogoutSuccessHandler(org.craftercms.commons.rest.HttpMessageConvertingResponseWriter responseWriter)

Method Details

setLogoutSuccessMessage

public void setLogoutSuccessMessage(String logoutSuccessMessage)

handle

public void handle(org.craftercms.commons.http.RequestContext context)
            throws SecurityProviderException,
IOException

Description copied from interface: LogoutSuccessHandler

Handles the request after a successful logout.

Specified by:

handle in interface LogoutSuccessHandler

Parameters:

context - the request context

Throws:

SecurityProviderException

IOException