Package org.keycloak.http

Interface HttpRequest

public interface HttpRequest

Represents an incoming HTTP request.

Instances of this class can be obtained from KeycloakContext.getHttpRequest().

  • Method Summary

    Modifier and Type
    Method
    Description
    X509Certificate[]
    getClientCertificateChain()
    Returns the client X509 certificate chain when processing TLS requests.
    jakarta.ws.rs.core.MultivaluedMap<String,String>
    getDecodedFormParameters()
    Returns the form parameters (e.g.: media type application/x-www-form-urlencoded) as a MultivaluedMap where the key and its correspondent value maps to the parameter name and value, respectively.
    jakarta.ws.rs.core.HttpHeaders
    getHttpHeaders()
    Returns the HTTP headers.
    String
    getHttpMethod()
    Returns the HTTP method.
    jakarta.ws.rs.core.MultivaluedMap<String,FormPartValue>
    getMultiPartFormParameters()
    Parses the parts from a multipart form request (e.g.: multipart/form-data media type).
    jakarta.ws.rs.core.UriInfo
    getUri()
    Returns a UriInfo instance for the path being requested.
    boolean
    isProxyTrusted()
    Returns false if the server is configured for trusted proxies and the request is from an untrusted source.

  • Method Details

    • getHttpMethod

      String getHttpMethod()
      Returns the HTTP method.
      Returns:
      the HTTP method.

    • getDecodedFormParameters

      jakarta.ws.rs.core.MultivaluedMap<String,String> getDecodedFormParameters()

      Returns the form parameters (e.g.: media type application/x-www-form-urlencoded) as a MultivaluedMap where the key and its correspondent value maps to the parameter name and value, respectively.

      The values are already decoded using HTML form decoding.

      Returns:
      the decoded form parameters

    • getMultiPartFormParameters

      jakarta.ws.rs.core.MultivaluedMap<String,FormPartValue> getMultiPartFormParameters()
      Parses the parts from a multipart form request (e.g.: multipart/form-data media type).
      Returns:
      the parts from a multipart form request

    • getHttpHeaders

      jakarta.ws.rs.core.HttpHeaders getHttpHeaders()
      Returns the HTTP headers.
      Returns:
      the HTTP headers

    • getClientCertificateChain

      X509Certificate[] getClientCertificateChain()
      Returns the client X509 certificate chain when processing TLS requests.
      Returns:
      the client certificate chain

    • getUri

      jakarta.ws.rs.core.UriInfo getUri()
      Returns a UriInfo instance for the path being requested.
      Returns:
      the UriInfo for the current path

    • isProxyTrusted

      boolean isProxyTrusted()
      Returns false if the server is configured for trusted proxies and the request is from an untrusted source.
      Returns:
      false if the server is configured for trusted proxies and the request is from an untrusted source.