org.craftercms.security.authentication.impl

Class RestAuthenticationRequiredHandler

java.lang.Object

org.craftercms.security.utils.handlers.AbstractRestHandlerBase

org.craftercms.security.authentication.impl.RestAuthenticationRequiredHandler

All Implemented Interfaces:

AuthenticationRequiredHandler

public class RestAuthenticationRequiredHandler
extends AbstractRestHandlerBase
implements AuthenticationRequiredHandler

Implementation of AuthenticationRequiredHandler for REST based applications, which returns a 401 UNAUTHORIZED status with the authentication exception message.

Author:

avasquez

Field Summary

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

responseWriter

Constructor Summary

Constructors

Constructor and Description
RestAuthenticationRequiredHandler()

Method Summary

Modifier and Type	Method and Description
void	handle(org.craftercms.commons.http.RequestContext context, AuthenticationException e) Handles the request when authentication is required.

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

sendErrorMessage, sendMessage, sendObject, setResponseWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAuthenticationRequiredHandler

public RestAuthenticationRequiredHandler()

Method Detail

handle

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

Description copied from interface: AuthenticationRequiredHandler

Handles the request when authentication is required.

Specified by:

handle in interface AuthenticationRequiredHandler

Parameters:

context - the request context

e - the exception with the reason for requiring authentication

Throws:

SecurityProviderException

IOException