com.atlassian.bitbucket.auth

Interface HttpAuthenticationFailureHandler

public interface HttpAuthenticationFailureHandler

Handler for authentication failure over HTTP. onAuthenticationFailure(HttpAuthenticationFailureContext) is called by the system for all installed http-auth-failure-handler module types, in order of their configured weight (low to high).

Method Summary

Modifier and Type	Method and Description
boolean	onAuthenticationFailure(HttpAuthenticationFailureContext context) Callback method that is called by the system on authentication failure.

Method Detail

onAuthenticationFailure

boolean onAuthenticationFailure(@Nonnull
                                HttpAuthenticationFailureContext context)
                         throws javax.servlet.ServletException,
                                IOException

Callback method that is called by the system on authentication failure. The reason for authentication failure can be retrieved through HttpAuthenticationFailureContext.getAuthenticationException().

Implementors can prevent other failure handlers further down the chain from being evaluated by returning true. They should only do so if the handler has written to or redirected the HTTP response.

Parameters:

context - a context object holding the request, response, authentication details and authentication exception.

Returns:

true if the request was fully handled and no other failure handlers should be evaluated. Otherwise false.

Throws:

javax.servlet.ServletException - may be thrown by implementations

IOException - may be thrown by implementations