Interface ExternalUserAuthenticator

All Known Implementing Classes:
AbstractIdentityServiceAuthenticator, DefaultAdminConsoleAuthenticator, DefaultWebScriptsHomeAuthenticator, IdentityServiceAdminConsoleAuthenticator, IdentityServiceWebScriptsHomeAuthenticator

public interface ExternalUserAuthenticator
An interface for objects capable of extracting an externally authenticated user ID from the HTTP request.
  • Method Summary

    Modifier and Type
    Method
    Description
    getUserId(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Gets an externally authenticated user ID from the HTTP request.
    void
    requestAuthentication(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
  • Method Details

    • getUserId

      String getUserId(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Gets an externally authenticated user ID from the HTTP request.
      Returns:
      the user ID or null if the user is unauthenticated
    • requestAuthentication

      void requestAuthentication(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)