Spring Security Framework

org.springframework.security.ui
Interface AuthenticationEntryPoint

All Known Implementing Classes:
AuthenticationProcessingFilterEntryPoint, BasicProcessingFilterEntryPoint, CasProcessingFilterEntryPoint, DigestProcessingFilterEntryPoint, NtlmProcessingFilterEntryPoint, PreAuthenticatedProcessingFilterEntryPoint, X509ProcessingFilterEntryPoint

public interface AuthenticationEntryPoint

Used by ExceptionTranslationFilter to commence an authentication scheme.

Version:
$Id$
Author:
Ben Alex

Method Summary
 void commence(ServletRequest request, ServletResponse response, AuthenticationException authException)
          Commences an authentication scheme.
 

Method Detail

commence

void commence(ServletRequest request,
              ServletResponse response,
              AuthenticationException authException)
              throws IOException,
                     ServletException
Commences an authentication scheme.

ExceptionTranslationFilter will populate the HttpSession attribute named AbstractProcessingFilter.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.

Parameters:
request - that resulted in an AuthenticationException
response - so that the user agent can begin authentication
authException - that caused the invocation
Throws:
IOException
ServletException

Spring Security Framework

Copyright © 2004-2010 SpringSource, Inc. All Rights Reserved.