org.elasticsearch.rest

Class RestRequest

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

Constructor Summary

Constructors

Constructor and Description
RestRequest(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String path)
RestRequest(java.lang.String uri)

Method Summary

Modifier and Type	Method and Description
abstract BytesReference	content()
java.net.SocketAddress	getLocalAddress()
java.net.SocketAddress	getRemoteAddress()
abstract boolean	hasContent()
boolean	hasParam(java.lang.String key)
abstract java.lang.String	header(java.lang.String name)
abstract java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>>	headers()
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.
abstract java.lang.String	uri() The uri of the rest request, with the query string.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRequest

public RestRequest(java.lang.String uri)

RestRequest

public RestRequest(java.util.Map<java.lang.String,java.lang.String> params,
                   java.lang.String path)

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()

header

public abstract java.lang.String header(java.lang.String name)

headers

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

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)