public abstract class RestRequest extends java.lang.Object implements ToXContent.Params
Modifier and Type | Class and Description |
---|---|
static class |
RestRequest.Method |
Constructor and Description |
---|
RestRequest(java.util.Map<java.lang.String,java.lang.String> params,
java.lang.String path) |
RestRequest(java.lang.String uri) |
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.
|
public RestRequest(java.lang.String uri)
public RestRequest(java.util.Map<java.lang.String,java.lang.String> params, java.lang.String path)
public abstract RestRequest.Method method()
public abstract java.lang.String uri()
public java.lang.String rawPath()
public final java.lang.String path()
public abstract boolean hasContent()
public abstract BytesReference content()
public abstract java.lang.String header(java.lang.String name)
public abstract java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> headers()
@Nullable public java.net.SocketAddress getRemoteAddress()
@Nullable public java.net.SocketAddress getLocalAddress()
public final boolean hasParam(java.lang.String key)
public final java.lang.String param(java.lang.String key)
param
in interface ToXContent.Params
public final java.lang.String param(java.lang.String key, java.lang.String defaultValue)
param
in interface ToXContent.Params
public java.util.Map<java.lang.String,java.lang.String> params()
public float paramAsFloat(java.lang.String key, float defaultValue)
public int paramAsInt(java.lang.String key, int defaultValue)
public long paramAsLong(java.lang.String key, long defaultValue)
public boolean paramAsBoolean(java.lang.String key, boolean defaultValue)
paramAsBoolean
in interface ToXContent.Params
public java.lang.Boolean paramAsBoolean(java.lang.String key, java.lang.Boolean defaultValue)
paramAsBoolean
in interface ToXContent.Params
public ByteSizeValue paramAsSize(java.lang.String key, ByteSizeValue defaultValue)
public java.lang.String[] paramAsStringArray(java.lang.String key, java.lang.String[] defaultValue)
public java.lang.String[] paramAsStringArrayOrEmptyIfAll(java.lang.String key)