org.elasticsearch.rest

Class RestRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.rest.RestRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, ToXContent.Params

Direct Known Subclasses:

NettyHttpRequest

public abstract class RestRequest
extends ContextAndHeaderHolder
implements ToXContent.Params

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequest.Method

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
RestRequest()

Method Summary

Methods

Modifier and Type	Method and Description
abstract BytesReference	content()
SocketAddress	getLocalAddress()
SocketAddress	getRemoteAddress()
abstract boolean	hasContent()
abstract boolean	hasParam(String key)
abstract String	header(String name)
abstract Iterable<Map.Entry<String,String>>	headers()
abstract RestRequest.Method	method()
abstract String	param(String key)
boolean	paramAsBoolean(String key, boolean defaultValue)
Boolean	paramAsBoolean(String key, Boolean defaultValue)
float	paramAsFloat(String key, float defaultValue)
int	paramAsInt(String key, int defaultValue)
long	paramAsLong(String key, long defaultValue)
ByteSizeValue	paramAsSize(String key, ByteSizeValue defaultValue)
String[]	paramAsStringArray(String key, String[] defaultValue)
String[]	paramAsStringArrayOrEmptyIfAll(String key)
TimeValue	paramAsTime(String key, TimeValue defaultValue)
abstract Map<String,String>	params()
String	path() The path part of the URI (without the query string), decoded.
abstract String	rawPath() The non decoded, raw path provided.
abstract String	uri() The uri of the rest request, with the query string.

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent.Params

param

Constructor Detail

RestRequest

public RestRequest()

Method Detail

method

public abstract RestRequest.Method method()

uri

public abstract String uri()

The uri of the rest request, with the query string.

rawPath

public abstract 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 abstract boolean hasContent()

content

public abstract BytesReference content()

header

public abstract String header(String name)

headers

public abstract Iterable<Map.Entry<String,String>> headers()

getRemoteAddress

@Nullable
public SocketAddress getRemoteAddress()

getLocalAddress

@Nullable
public SocketAddress getLocalAddress()

hasParam

public abstract boolean hasParam(String key)

param

public abstract String param(String key)

Specified by:

param in interface ToXContent.Params

params

public abstract Map<String,String> params()

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 ToXContent.Params

paramAsBoolean

public Boolean paramAsBoolean(String key,
                     Boolean defaultValue)

Specified by:

paramAsBoolean in interface ToXContent.Params

paramAsTime

public TimeValue paramAsTime(String key,
                    TimeValue defaultValue)

paramAsSize

public ByteSizeValue paramAsSize(String key,
                        ByteSizeValue defaultValue)

paramAsStringArray

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

paramAsStringArrayOrEmptyIfAll

public String[] paramAsStringArrayOrEmptyIfAll(String key)