org.springframework.security.web.authentication.www

Class BasicAuthenticationEntryPoint

java.lang.Object

org.springframework.security.web.authentication.www.BasicAuthenticationEntryPoint

All Implemented Interfaces:

AuthenticationEntryPoint

public class BasicAuthenticationEntryPoint
extends java.lang.Object
implements AuthenticationEntryPoint

Used by the ExceptionTraslationFilter to commence authentication via the BasicAuthenticationFilter.

Once a user agent is authenticated using BASIC authentication, logout requires that the browser be closed or an unauthorized (401) header be sent. The simplest way of achieving the latter is to call the commence(HttpServletRequest, HttpServletResponse, AuthenticationException) method below. This will indicate to the browser its credentials are no longer authorized, causing it to prompt the user to login again.

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticationEntryPoint()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) Commences an authentication scheme.
java.lang.String	getRealmName()
void	setRealmName(java.lang.String realmName)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthenticationEntryPoint

public BasicAuthenticationEntryPoint()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Throws:

java.lang.Exception

commence

public void commence(HttpServletRequest request,
                     HttpServletResponse response,
                     AuthenticationException authException)
              throws java.io.IOException,
                     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:

java.io.IOException

ServletException

getRealmName

public java.lang.String getRealmName()

setRealmName

public void setRealmName(java.lang.String realmName)