org.springframework.security.web.authentication

Class HttpStatusEntryPoint

java.lang.Object

org.springframework.security.web.authentication.HttpStatusEntryPoint

All Implemented Interfaces:

AuthenticationEntryPoint

public final class HttpStatusEntryPoint
extends Object
implements AuthenticationEntryPoint

An AuthenticationEntryPoint that sends a generic HttpStatus as a response. Useful for JavaScript clients which cannot use Basic authentication since the browser intercepts the response.

Since:

4.0

Author:

Rob Winch

Constructor Summary

Constructors

Constructor and Description
HttpStatusEntryPoint(HttpStatus httpStatus) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	commence(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.security.core.AuthenticationException authException) Commences an authentication scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpStatusEntryPoint

public HttpStatusEntryPoint(HttpStatus httpStatus)

Creates a new instance.

Parameters:

httpStatus - the HttpSatus to set

Method Detail

commence

public void commence(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     org.springframework.security.core.AuthenticationException authException)
              throws IOException,
                     javax.servlet.ServletException

Description copied from interface: AuthenticationEntryPoint

Commences an authentication scheme.

ExceptionTranslationFilter will populate the HttpSession attribute named AbstractAuthenticationProcessingFilter.SPRING_SECURITY_SAVED_REQUEST_KEY with the requested target URL before calling this method.

Implementations should modify the headers on the ServletResponse as necessary to commence the authentication process.

Specified by:

commence in interface AuthenticationEntryPoint

Parameters:

request - that resulted in an AuthenticationException

response - so that the user agent can begin authentication

authException - that caused the invocation

Throws:

IOException

javax.servlet.ServletException