Class RestRequest

    • Constructor Detail

      • RestRequest

        protected RestRequest​(NamedXContentRegistry xContentRegistry,
                              java.util.Map<java.lang.String,​java.lang.String> params,
                              java.lang.String path,
                              java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers,
                              HttpRequest httpRequest,
                              HttpChannel httpChannel)
      • RestRequest

        protected RestRequest​(RestRequest restRequest)
    • Method Detail

      • isContentConsumed

        public boolean isContentConsumed()
      • method

        public RestRequest.Method method()
        Returns the HTTP method used in the REST request.
        the RestRequest.Method used in the REST request
        java.lang.IllegalArgumentException - if the HTTP method is invalid
      • uri

        public java.lang.String uri()
        The uri of the rest request, with the query string.
      • rawPath

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

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

        public boolean hasContent()
      • content

        protected BytesReference content​(boolean contentConsumed)
      • requiredContent

        public final BytesReference requiredContent()
        content of the request body or throw an exception if the body or content type is missing
      • header

        public final java.lang.String header​(java.lang.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 java.util.List<java.lang.String> getAllHeaderValues​(java.lang.String name)
        Get all values for the header or null if the header was not found
      • getHeaders

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

        public final XContentType getXContentType()
        The XContentType 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
      • hasParam

        public final boolean hasParam​(java.lang.String key)
      • param

        public final java.lang.String param​(java.lang.String key)
        Specified by:
        param in interface ToXContent.Params
      • param

        public final java.lang.String param​(java.lang.String key,
                                            java.lang.String defaultValue)
        Specified by:
        param in interface ToXContent.Params
      • params

        public java.util.Map<java.lang.String,​java.lang.String> params()
      • paramAsFloat

        public float paramAsFloat​(java.lang.String key,
                                  float defaultValue)
      • paramAsInt

        public int paramAsInt​(java.lang.String key,
                              int defaultValue)
      • paramAsLong

        public long paramAsLong​(java.lang.String key,
                                long defaultValue)
      • paramAsBoolean

        public boolean paramAsBoolean​(java.lang.String key,
                                      boolean defaultValue)
        Specified by:
        paramAsBoolean in interface ToXContent.Params
      • paramAsBoolean

        public java.lang.Boolean paramAsBoolean​(java.lang.String key,
                                                java.lang.Boolean defaultValue)
        Specified by:
        paramAsBoolean in interface ToXContent.Params
      • paramAsTime

        public TimeValue paramAsTime​(java.lang.String key,
                                     TimeValue defaultValue)
      • paramAsStringArray

        public java.lang.String[] paramAsStringArray​(java.lang.String key,
                                                     java.lang.String[] defaultValue)
      • paramAsStringArrayOrEmptyIfAll

        public java.lang.String[] paramAsStringArrayOrEmptyIfAll​(java.lang.String key)
      • applyContentParser

        public final void applyContentParser​(CheckedConsumer<XContentParser,​> applyParser)
        If there is any content then call applyParser with the parser, otherwise do nothing.
      • 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.
      • withContentOrSourceParamParserOrNull

        public final void withContentOrSourceParamParserOrNull​(CheckedConsumer<XContentParser,​> withParser)
        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.
      • parseContentType

        public static XContentType parseContentType​(java.util.List<java.lang.String> header)
        Parses the given content type string for the media type. This method currently ignores parameters.