Interface OriginalQueryExtractor


public interface OriginalQueryExtractor
Helper class for extracting the query (or in case of Pushed Authorization Requests content of POST body) parameter values from the original request leading to the authentication service. This could have been initialized either by a call to the token server's authorization endpoint or directly to the authentication service in some flows.
  • Method Details

    • getClientId

      @Nullable @Nullable String getClientId()
      Get the client ID (client_id) from the original request, or null if none was present.
      Returns:
      the client ID from the original request, or null if none was present
    • getServiceProviderId

      @Nullable @Nullable String getServiceProviderId()
      The service provider ID from the request to the authentication service. Note that this could be either the name of the client or the name of the profile depending on which flow is used.
      Returns:
      the service provider ID (serviceProviderId) provided in the original authentication request or null if none was found
    • getQueryParameterValue

      @Nullable @Nullable String getQueryParameterValue(String queryParameterName)
      Gets the value of any arbitrary query parameter.
      Returns:
      the value of the provided query parameter, or null if no value was set for the parameter
    • getAuthorizationRequestQueryParameterValue

      @Nullable @Nullable String getAuthorizationRequestQueryParameterValue(String queryParameterName)
      Gets the value of an authorization request query parameter.
      Returns:
      the value of the provided query parameter, or null if no value was set for the parameter
      Since:
      6.2.0
    • getAuthenticationRequestQueryParameterValue

      @Nullable @Nullable String getAuthenticationRequestQueryParameterValue(String queryParameterName)
      Gets the value of an authentication request query parameter.
      Returns:
      the value of the provided query parameter, or null if no value was set for the parameter
      Since:
      6.2.0
    • getOriginalAuthorizationQueryString

      @Nullable @Nullable String getOriginalAuthorizationQueryString()
      Gets the original authorization request query string.
      Returns:
      the the original authorization request query string, or null if no query was provided by the client
      Since:
      6.2.0
    • getOriginalAuthenticationQueryString

      @Nullable @Nullable String getOriginalAuthenticationQueryString()
      Gets the original authentication request query string.
      Returns:
      the the original authentication request query string, or null if no query was provided by the client
      Since:
      6.2.0