Package com.spotfire.server.security

Interface WebAuthenticationContext

All Superinterfaces:
AuthenticationContext
public interface WebAuthenticationContext extends AuthenticationContext
The WebAuthenticationContext contains information besides the information provided by the AuthenticationContext that is only available to CustomWebAuthenticator implementations.
Since:
7.8

  • Method Details

    • getParameter

      String getParameter(String name)
      Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
      Parameters:
      name - a String specifying the name of the parameter
      Returns:
      a String representing the single value of the parameter
      Since:
      7.8
      See Also:
      • ServletRequest.getParameter(String)

    • getParameterNames

      Enumeration<String> getParameterNames()
      Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
      Returns:
      an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters
      Since:
      7.8
      See Also:
      • ServletRequest.getParameterNames()

    • getParameterValues

      String[] getParameterValues(String name)
      Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
      Parameters:
      name - a String specifying the name of the parameter
      Returns:
      an array of String objects containing the parameter's values
      Since:
      7.8
      See Also:
      • ServletRequest.getParameterValues(String)

    • getParameterMap

      Map<String,String[]> getParameterMap()
      Delegates to the underlying jakarta.servlet.http.HttpServletRequest.
      Returns:
      an immutable java.util.Map containing parameter names as keys and parameter values as map values
      Since:
      7.8
      See Also:
      • ServletRequest.getParameterMap()

    • getSessionContext

      Map<String,Object> getSessionContext()
      Returns a mutable map, stored as a parameter in the HTTP session associated with this request, that is only available from this interface. Note that the map remains in the session between authentication attempts and may contain information relating to multiple authentication attempts at once.

      Typically used for storing a CSRF token or similar when implementing for example the Authorization Code Flow of OAuth 2.0.

      Requests within the same session are serialized during the authentication phase so the session context can be used without any further synchronization.

      All objects placed in the map MUST implement Serializable.

      Returns:
      the session context
      Since:
      7.8
      See Also:

    • getReturnEndpoint

      URI getReturnEndpoint()
      Returns the URI to the endpoint on the Spotfire Server to which the identity provider should redirect the user's browser after authentication. The returned URI is an absolute URI on the form http[s]://<host>[:<port>]/spotfire/auth/custom/authenticate.
      Returns:
      the URI to the endpoint on the Spotfire Server to which the identity provider should redirect the user's browser after authentication
      Since:
      11.6