Class BasicAuthenticationEntryPoint

  • All Implemented Interfaces:
    org.springframework.beans.factory.InitializingBean, AuthenticationEntryPoint

    public class BasicAuthenticationEntryPoint
    extends java.lang.Object
    implements AuthenticationEntryPoint, org.springframework.beans.factory.InitializingBean
    Used by the ExceptionTranslationFilter 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 Detail

      • BasicAuthenticationEntryPoint

        public BasicAuthenticationEntryPoint()
    • Method Detail

      • afterPropertiesSet

        public void afterPropertiesSet()
        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      • commence

        public void commence​(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             AuthenticationException authException)
        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
        request - that resulted in an AuthenticationException
        response - so that the user agent can begin authentication
        authException - that caused the invocation
      • getRealmName

        public java.lang.String getRealmName()
      • setRealmName

        public void setRealmName​(java.lang.String realmName)