com.atlassian.bitbucket.auth

Interface HttpAuthenticationSuccessHandler

public interface HttpAuthenticationSuccessHandler

Handler that is called when a user successfully authenticates with the system over HTTP. The system will call onAuthenticationSuccess(HttpAuthenticationSuccessContext) on all installed http-auth-success-handler modules in order of their configured weight, until a handler returns true.

Method Summary

Modifier and Type	Method and Description
boolean	onAuthenticationSuccess(HttpAuthenticationSuccessContext context) Callback method that is called by the system on authentication success over HTTP.

Method Detail

onAuthenticationSuccess

boolean onAuthenticationSuccess(@Nonnull
                                HttpAuthenticationSuccessContext context)
                         throws javax.servlet.ServletException,
                                IOException

Callback method that is called by the system on authentication success over HTTP. The authenticated user can be retrieved through HttpAuthenticationSuccessContext.getUser().

Implementations can prevent other success 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 authenticated user.

Returns:

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

Throws:

javax.servlet.ServletException - may be thrown by implementations

IOException - may be thrown by implementations