public interface

HttpAuthenticationSuccessHandler

com.atlassian.stash.auth.HttpAuthenticationSuccessHandler

Class Overview

Handler that is called when a user successfully authenticates with the system. 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.

Please note that the HTTP authentication APIs are currently considered to be BETA and are expected to change slightly in future releases. Breaking API changes will be avoided where possible, but may happen.

Summary

Public Methods
boolean onAuthenticationSuccess(HttpAuthenticationSuccessContext context)
Callback method that is called by the system on authentication success.

Public Methods

public boolean onAuthenticationSuccess (HttpAuthenticationSuccessContext context)

Callback method that is called by the system on authentication success. The authenticated com.atlassian.stash.user.StashUser user can be retrieved through 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
ServletException
IOException
ServletException