public interface

HttpAuthenticationContext

com.atlassian.stash.auth.HttpAuthenticationContext
Known Indirect Subclasses

Class Overview

Context class holding all details relevant for authentication processing by HttpAuthenticationHandler modules.

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

Constants
String METHOD_BASIC BASIC authentication.
String METHOD_FORM FORM-based authentication.
String METHOD_TOKEN Authentication based on some kind of token (not username/password based).
Public Methods
@Nullable Object getCredentials()
@Nonnull FilterChain getFilterChain()
@Nonnull String getMethod()
@Nonnull HttpServletRequest getRequest()
@Nonnull HttpServletResponse getResponse()
@Nullable String getUsername()

Constants

public static final String METHOD_BASIC

BASIC authentication.

Constant Value: "basic"

public static final String METHOD_FORM

FORM-based authentication.

Constant Value: "form"

public static final String METHOD_TOKEN

Authentication based on some kind of token (not username/password based).

Constant Value: "token"

Public Methods

@Nullable public Object getCredentials ()

Returns
  • the provided credentials. Can be null if no credentials were provided.

@Nonnull public FilterChain getFilterChain ()

Returns
  • the FilterChain for the authentication request.

@Nonnull public String getMethod ()

Returns

@Nonnull public HttpServletRequest getRequest ()

Returns
  • the HTTP request

@Nonnull public HttpServletResponse getResponse ()

Returns
  • the HTTP response

@Nullable public String getUsername ()

Returns
  • the provided username. Can be null if no username was provided.