RestRequest (core 5.6.16 API)

java.lang.Object
- org.elasticsearch.rest.RestRequest

All Implemented Interfaces:: ToXContent.Params

public abstract class RestRequest
extends java.lang.Object
implements ToXContent.Params

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RestRequest.Method

Nested Classes
Modifier and Type	Class and Description
`static class`	`RestRequest.Method`

Constructor Summary

Constructors
Constructor and Description
`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)` Creates a new RestRequest
`RestRequest(NamedXContentRegistry xContentRegistry, java.lang.String uri, java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)` Creates a new RestRequest

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`applyContentParser(CheckedConsumer<XContentParser,java.io.IOException> applyParser)` If there is any content then call `applyParser` with the parser, otherwise do nothing.
`abstract BytesReference`	`content()`
`Tuple<XContentType,BytesReference>`	`contentOrSourceParam()` Get the content of the request or the contents of the `source` param or throw an exception if both are missing.
`XContentParser`	`contentOrSourceParamParser()` 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 `ElasticsearchParseException`.
`XContentParser`	`contentParser()` A parser for the contents of this request if there is a body, otherwise throws an `ElasticsearchParseException`.
`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
`BytesReference`	`getContentOrSourceParamOnly()` Deprecated. we should only take xcontent
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaders()` Get all of the headers and values associated with the headers.
`java.net.SocketAddress`	`getLocalAddress()`
`java.net.SocketAddress`	`getRemoteAddress()`
`NamedXContentRegistry`	`getXContentRegistry()` Get the `NamedXContentRegistry` that should be used to create parsers from this request.
`XContentType`	`getXContentType()` The `XContentType` that was parsed from the `Content-Type` header.
`abstract boolean`	`hasContent()`
`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.
`boolean`	`hasParam(java.lang.String key)`
`java.lang.String`	`header(java.lang.String name)` Get the value of the header or `null` if not found.
`abstract RestRequest.Method`	`method()`
`java.lang.String`	`param(java.lang.String key)`
`java.lang.String`	`param(java.lang.String key, java.lang.String defaultValue)`
`boolean`	`paramAsBoolean(java.lang.String key, boolean defaultValue)`
`java.lang.Boolean`	`paramAsBoolean(java.lang.String key, java.lang.Boolean defaultValue)`
`float`	`paramAsFloat(java.lang.String key, float defaultValue)`
`int`	`paramAsInt(java.lang.String key, int defaultValue)`
`long`	`paramAsLong(java.lang.String key, long defaultValue)`
`ByteSizeValue`	`paramAsSize(java.lang.String key, ByteSizeValue defaultValue)`
`java.lang.String[]`	`paramAsStringArray(java.lang.String key, java.lang.String[] defaultValue)`
`java.lang.String[]`	`paramAsStringArrayOrEmptyIfAll(java.lang.String key)`
`TimeValue`	`paramAsTime(java.lang.String key, TimeValue defaultValue)`
`java.util.Map<java.lang.String,java.lang.String>`	`params()`
`java.lang.String`	`path()` The path part of the URI (without the query string), decoded.
`java.lang.String`	`rawPath()` The non decoded, raw path provided.
`BytesReference`	`requiredContent()`
`abstract java.lang.String`	`uri()` The uri of the rest request, with the query string.
`void`	`withContentOrSourceParamParserOrNull(CheckedConsumer<XContentParser,java.io.IOException> 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`.
`void`	`withContentOrSourceParamParserOrNullLenient(CheckedConsumer<XContentParser,java.io.IOException> withParser)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RestRequest
```
public RestRequest(NamedXContentRegistry xContentRegistry,
                   java.lang.String uri,
                   java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
```
    Creates a new RestRequest
    
    Parameters:
    
    xContentRegistry - the xContentRegistry to use when parsing XContent
    
    uri - the URI of the request that potentially contains request parameters
    
    headers - a map of the headers. This map should implement a Case-Insensitive hashing for keys as HTTP header names are case insensitive
  - RestRequest
```
public 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)
```
    Creates a new RestRequest
    
    Parameters:
    
    xContentRegistry - the xContentRegistry to use when parsing XContent
    
    params - the parameters of the request
    
    path - the path of the request. This should not contain request parameters
    
    headers - a map of the headers. This map should implement a Case-Insensitive hashing for keys as HTTP header names are case insensitive
- Method Detail
  - method
```
public abstract RestRequest.Method method()
```
  - uri
```
public abstract 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 abstract boolean hasContent()
```
  - content
```
public abstract BytesReference content()
```
  - requiredContent
```
public final BytesReference requiredContent()
```
    Returns:
    
    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
```
@Nullable
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
  - getRemoteAddress
```
@Nullable
public java.net.SocketAddress getRemoteAddress()
```
  - getLocalAddress
```
@Nullable
public java.net.SocketAddress getLocalAddress()
```
  - 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)
```
  - paramAsSize
```
public ByteSizeValue paramAsSize(java.lang.String key,
                                 ByteSizeValue 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)
```
  - getXContentRegistry
```
public NamedXContentRegistry getXContentRegistry()
```
    Get the NamedXContentRegistry that should be used to create parsers from this request.
  - contentParser
```
public final XContentParser contentParser()
                                   throws java.io.IOException
```
    A parser for the contents of this request if there is a body, otherwise throws an ElasticsearchParseException. 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:
    
    java.io.IOException
  - applyContentParser
```
public final void applyContentParser(CheckedConsumer<XContentParser,java.io.IOException> applyParser)
                              throws java.io.IOException
```
    If there is any content then call applyParser with the parser, otherwise do nothing.
    
    Throws:
    
    java.io.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 XContentParser contentOrSourceParamParser()
                                                throws java.io.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 ElasticsearchParseException. Use withContentOrSourceParamParserOrNull(CheckedConsumer) instead if you need to handle the absence request content gracefully.
    
    Throws:
    
    java.io.IOException
  - withContentOrSourceParamParserOrNull
```
public final void withContentOrSourceParamParserOrNull(CheckedConsumer<XContentParser,java.io.IOException> withParser)
                                                throws java.io.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:
    
    java.io.IOException
  - contentOrSourceParam
```
public final Tuple<XContentType,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.
  - withContentOrSourceParamParserOrNullLenient
```
@Deprecated
public final void withContentOrSourceParamParserOrNullLenient(CheckedConsumer<XContentParser,java.io.IOException> withParser)
                                                                   throws java.io.IOException
```
    Deprecated.
    
    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. This version allows for plain text content
    
    Throws:
    
    java.io.IOException
  - getContentOrSourceParamOnly
```
@Deprecated
public final BytesReference getContentOrSourceParamOnly()
```
    Deprecated. we should only take xcontent
    
    Get the content of the request or the contents of the source param without the xcontent type. This is useful the request can accept non xcontent values.

Class RestRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestRequest

RestRequest

Method Detail

method

uri

rawPath

path

hasContent

content

requiredContent

header

getAllHeaderValues

getHeaders

getXContentType

getRemoteAddress

getLocalAddress

hasParam

param

param

params

paramAsFloat

paramAsInt

paramAsLong

paramAsBoolean

paramAsBoolean

paramAsTime

paramAsSize

paramAsStringArray

paramAsStringArrayOrEmptyIfAll

getXContentRegistry

contentParser

applyContentParser

hasContentOrSourceParam

contentOrSourceParamParser

withContentOrSourceParamParserOrNull

contentOrSourceParam

withContentOrSourceParamParserOrNullLenient

getContentOrSourceParamOnly