Package org.forgerock.json.resource.http

Class HttpContext

java.lang.Object
org.forgerock.services.context.AbstractContext
org.forgerock.json.resource.http.HttpContext
All Implemented Interfaces:
org.forgerock.services.context.Context
public final class HttpContext extends org.forgerock.services.context.AbstractContext
A Context containing information relating to the originating HTTP request.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_HEADERS
    Attribute in the serialized JSON form that holds the request headers.
    static final String
    ATTR_METHOD
    Attribute in the serialised JSON form that holds the HTTP method of the request.
    static final String
    ATTR_PARAMETERS
    Attribute in the serialized JSON form that holds the query and/or form parameters.
    static final String
    ATTR_PATH
    Attribute in the serialised JSON form that holds the full URI of the request, excluding anything beyond the path component (i.e., no query parameters).

    Fields inherited from class org.forgerock.services.context.AbstractContext

    data

  • Constructor Summary

    Constructors
    Constructor
    Description
    HttpContext(JsonValue savedContext, ClassLoader classLoader)
    Restore from JSON representation.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getHeader(String name)
    Returns an unmodifiable list containing the values of the named HTTP request header.
    String
    getHeaderAsString(String name)
    Returns the first value of the named HTTP request header.
    Map<String,List<String>>
    getHeaders()
    Returns an unmodifiable map of the HTTP request headers.
    String
    getMethod()
    Returns the effective HTTP method, taking into account presence of the X-HTTP-Method-Override header.
    List<String>
    getParameter(String name)
    Returns an unmodifiable list containing the values of the named HTTP request parameter.
    String
    getParameterAsString(String name)
    Returns the first value of the named HTTP request parameter.
    Map<String,List<String>>
    getParameters()
    Returns an unmodifiable map of the HTTP request parameters.
    String
    getPath()
    Returns the HTTP request path.

    Methods inherited from class org.forgerock.services.context.AbstractContext

    as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • HttpContext

      public HttpContext(JsonValue savedContext, ClassLoader classLoader)
      Restore from JSON representation.
      Parameters:
      savedContext - The JSON representation from which this context's attributes should be parsed. Must be a JSON Object that contains ATTR_HEADERS and ATTR_PARAMETERS attributes.
      classLoader - The ClassLoader which can properly resolve the persisted class-name.

  • Method Details

    • getHeader

      public List<String> getHeader(String name)
      Returns an unmodifiable list containing the values of the named HTTP request header.
      Parameters:
      name - The name of the HTTP request header.
      Returns:
      An unmodifiable list containing the values of the named HTTP request header, which may be empty if the header is not present in the request.

    • getHeaderAsString

      public String getHeaderAsString(String name)
      Returns the first value of the named HTTP request header.
      Parameters:
      name - The name of the HTTP request header.
      Returns:
      The first value of the named HTTP request header, or null if the header is not present in the request.

    • getHeaders

      public Map<String,List<String>> getHeaders()
      Returns an unmodifiable map of the HTTP request headers.
      Returns:
      An unmodifiable map of the HTTP request headers.

    • getMethod

      public String getMethod()
      Returns the effective HTTP method, taking into account presence of the X-HTTP-Method-Override header.
      Returns:
      The effective HTTP method, taking into account presence of the X-HTTP-Method-Override header.

    • getParameter

      public List<String> getParameter(String name)
      Returns an unmodifiable list containing the values of the named HTTP request parameter.
      Parameters:
      name - The name of the HTTP request parameter.
      Returns:
      An unmodifiable list containing the values of the named HTTP request parameter, which may be empty if the parameter is not present in the request.

    • getParameterAsString

      public String getParameterAsString(String name)
      Returns the first value of the named HTTP request parameter.
      Parameters:
      name - The name of the HTTP request parameter.
      Returns:
      The first value of the named HTTP request parameter, or null if the parameter is not present in the request.

    • getParameters

      public Map<String,List<String>> getParameters()
      Returns an unmodifiable map of the HTTP request parameters.
      Returns:
      An unmodifiable map of the HTTP request parameters.

    • getPath

      public String getPath()
      Returns the HTTP request path.
      Returns:
      The HTTP request path.