Package org.opensearch.rest

Class RestRequest

java.lang.Object
org.opensearch.rest.RestRequest
All Implemented Interfaces:
org.opensearch.core.xcontent.ToXContent.Params
@PublicApi(since="1.0.0") public class RestRequest extends Object implements org.opensearch.core.xcontent.ToXContent.Params
REST Request
Opensearch.api:

  • Constructor Details

  • Method Details

    • isContentConsumed

      public boolean isContentConsumed()

    • request

      public static RestRequest request(org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, HttpRequest httpRequest, HttpChannel httpChannel)
      Creates a new REST request. This method will throw RestRequest.BadParameterException if the path cannot be decoded
      Parameters:
      xContentRegistry - the content registry
      httpRequest - the http request
      httpChannel - the http channel
      Throws:
      RestRequest.BadParameterException - if the parameters can not be decoded
      RestRequest.ContentTypeHeaderException - if the Content-Type header can not be parsed

    • requestWithoutParameters

      public static RestRequest requestWithoutParameters(org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, HttpRequest httpRequest, HttpChannel httpChannel)
      Creates a new REST request. The path is not decoded so this constructor will not throw a RestRequest.BadParameterException.
      Parameters:
      xContentRegistry - the content registry
      httpRequest - the http request
      httpChannel - the http channel
      Throws:
      RestRequest.ContentTypeHeaderException - if the Content-Type header can not be parsed

    • method

      public RestRequest.Method method()
      Returns the HTTP method used in the REST request.
      Returns:
      the RestRequest.Method used in the REST request
      Throws:
      IllegalArgumentException - if the HTTP method is invalid

    • uri

      public String uri()
      The uri of the rest request, with the query string.

    • rawPath

      public String rawPath()
      The non decoded, raw path provided.

    • path

      public final String path()
      The path part of the URI (without the query string), decoded.

    • hasContent

      public boolean hasContent()

    • content

      public org.opensearch.core.common.bytes.BytesReference content()

    • content

      protected org.opensearch.core.common.bytes.BytesReference content(boolean contentConsumed)

    • requiredContent

      public final org.opensearch.core.common.bytes.BytesReference requiredContent()
      Returns:
      content of the request body or throw an exception if the body or content type is missing

    • header

      public final String header(String name)
      Get the value of the header or null if not found. This method only retrieves the first header value if multiple values are sent. Use of getAllHeaderValues(String) should be preferred

    • getAllHeaderValues

      public final List<String> getAllHeaderValues(String name)
      Get all values for the header or null if the header was not found

    • getHeaders

      public final Map<String,List<String>> getHeaders()
      Get all of the headers and values associated with the headers. Modifications of this map are not supported.

    • getRequestId

      public final long getRequestId()

    • getMediaType

      @Nullable public final org.opensearch.core.xcontent.MediaType getMediaType()
      The MediaType that was parsed from the Content-Type header. This value will be null in the case of a request without a valid Content-Type header, a request without content (hasContent(), or a plain text request

    • getHttpChannel

      public HttpChannel getHttpChannel()

    • getHttpRequest

      public HttpRequest getHttpRequest()

    • hasParam

      public final boolean hasParam(String key)

    • param

      public final String param(String key)
      Specified by:
      param in interface org.opensearch.core.xcontent.ToXContent.Params

    • param

      public final String param(String key, String defaultValue)
      Specified by:
      param in interface org.opensearch.core.xcontent.ToXContent.Params

    • params

      public Map<String,String> params()

    • consumedParams

      public List<String> consumedParams()
      Returns a list of parameters that have been consumed. This method returns a copy, callers are free to modify the returned list.
      Returns:
      the list of currently consumed parameters.

    • paramAsFloat

      public float paramAsFloat(String key, float defaultValue)

    • paramAsInt

      public int paramAsInt(String key, int defaultValue)

    • paramAsLong

      public long paramAsLong(String key, long defaultValue)

    • paramAsBoolean

      public boolean paramAsBoolean(String key, boolean defaultValue)
      Specified by:
      paramAsBoolean in interface org.opensearch.core.xcontent.ToXContent.Params

    • paramAsBoolean

      public Boolean paramAsBoolean(String key, Boolean defaultValue)
      Specified by:
      paramAsBoolean in interface org.opensearch.core.xcontent.ToXContent.Params

    • paramAsTime

      public org.opensearch.common.unit.TimeValue paramAsTime(String key, org.opensearch.common.unit.TimeValue defaultValue)

    • paramAsSize

      public org.opensearch.core.common.unit.ByteSizeValue paramAsSize(String key, org.opensearch.core.common.unit.ByteSizeValue defaultValue)

    • paramAsStringArray

      public String[] paramAsStringArray(String key, String[] defaultValue)

    • paramAsStringArrayOrEmptyIfAll

      public String[] paramAsStringArrayOrEmptyIfAll(String key)

    • getXContentRegistry

      public org.opensearch.core.xcontent.NamedXContentRegistry getXContentRegistry()
      Get the NamedXContentRegistry that should be used to create parsers from this request.

    • contentParser

      public final org.opensearch.core.xcontent.XContentParser contentParser() throws IOException
      A parser for the contents of this request if there is a body, otherwise throws an OpenSearchParseException. Use applyContentParser(CheckedConsumer) if you want to gracefully handle when the request doesn't have any contents. Use contentOrSourceParamParser() for requests that support specifying the request body in the source param.
      Throws:
      IOException

    • applyContentParser

      public final void applyContentParser(org.opensearch.common.CheckedConsumer<org.opensearch.core.xcontent.XContentParser,IOException> applyParser) throws IOException
      If there is any content then call applyParser with the parser, otherwise do nothing.
      Throws:
      IOException

    • hasContentOrSourceParam

      public final boolean hasContentOrSourceParam()
      Does this request have content or a source parameter? Use this instead of hasContent() if this RestHandler treats the source parameter like the body content.

    • contentOrSourceParamParser

      public final org.opensearch.core.xcontent.XContentParser contentOrSourceParamParser() throws IOException
      A parser for the contents of this request if it has contents, otherwise a parser for the source parameter if there is one, otherwise throws an OpenSearchParseException. Use withContentOrSourceParamParserOrNull(CheckedConsumer) instead if you need to handle the absence request content gracefully.
      Throws:
      IOException

    • withContentOrSourceParamParserOrNull

      public final void withContentOrSourceParamParserOrNull(org.opensearch.common.CheckedConsumer<org.opensearch.core.xcontent.XContentParser,IOException> withParser) throws IOException
      Call a consumer with the parser for the contents of this request if it has contents, otherwise with a parser for the source parameter if there is one, otherwise with null. Use contentOrSourceParamParser() if you should throw an exception back to the user when there isn't request content.
      Throws:
      IOException

    • contentOrSourceParam

      public final org.opensearch.common.collect.Tuple<org.opensearch.core.xcontent.MediaType,org.opensearch.core.common.bytes.BytesReference> contentOrSourceParam()
      Get the content of the request or the contents of the source param or throw an exception if both are missing. Prefer contentOrSourceParamParser() or withContentOrSourceParamParserOrNull(CheckedConsumer) if you need a parser.

    • parseContentType

      public static org.opensearch.core.xcontent.MediaType parseContentType(List<String> header)
      Parses the given content type string for the media type. This method currently ignores parameters.

    • parsePaginatedQueryParams

      public PageParams parsePaginatedQueryParams(String defaultSortOrder, int defaultPageSize)