public abstract class Request
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static interface |
Request.Param<T>
Represents a Request parameter, provides information whether is was specified or not (check
Request.Param.isPresent() )
and utility method to nicely handles cases where the parameter is not present. |
static interface |
Request.Part |
static interface |
Request.StringParam
Extends
Request.Param with convenience methods specific to the type String . |
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
MSG_PARAMETER_MISSING |
Constructor and Description |
---|
Request() |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.String> |
getHeaders() |
abstract java.lang.String |
getMediaType()
Returns the requested MIME type, or
"application/octet-stream" if not specified. |
Request.StringParam |
getParam(java.lang.String key) |
<T> Request.Param<T> |
getParam(java.lang.String key,
java.util.function.BiFunction<Request,java.lang.String,T> retrieveAndValidate) |
Request.StringParam |
getParam(java.lang.String key,
java.util.function.Consumer<java.lang.String> validate) |
abstract java.util.Map<java.lang.String,java.lang.String[]> |
getParams() |
abstract java.lang.String |
getPath()
Return path of the request
|
java.io.BufferedReader |
getReader() |
abstract boolean |
hasParam(java.lang.String key)
Return true of the parameter is set in the request.
|
abstract java.util.Optional<java.lang.String> |
header(java.lang.String name)
Optional value of the HTTP header with specified name.
|
abstract LocalConnector |
localConnector()
Allows a web service to call another web service.
|
java.util.List<java.lang.String> |
mandatoryMultiParam(java.lang.String key) |
java.lang.String |
mandatoryParam(java.lang.String key)
Returns a non-null value.
|
boolean |
mandatoryParamAsBoolean(java.lang.String key)
Returns a boolean value.
|
<E extends java.lang.Enum<E>> |
mandatoryParamAsEnum(java.lang.String key,
java.lang.Class<E> enumClass) |
int |
mandatoryParamAsInt(java.lang.String key)
Returns an int value.
|
long |
mandatoryParamAsLong(java.lang.String key)
Returns a long value.
|
Request.Part |
mandatoryParamAsPart(java.lang.String key) |
java.util.List<java.lang.String> |
mandatoryParamAsStrings(java.lang.String key) |
abstract java.lang.String |
method()
Returns the name of the HTTP method with which this request was made.
|
abstract java.util.List<java.lang.String> |
multiParam(java.lang.String key) |
abstract java.lang.String |
param(java.lang.String key) |
java.lang.String |
param(java.lang.String key,
java.lang.String defaultValue)
Deprecated.
to be dropped in 4.4. Default values are declared in ws metadata
|
java.lang.Boolean |
paramAsBoolean(java.lang.String key) |
boolean |
paramAsBoolean(java.lang.String key,
boolean defaultValue)
Deprecated.
to be dropped in 4.4. Default values must be declared in
WebService then
this method can be replaced by mandatoryParamAsBoolean(String) . |
java.util.Date |
paramAsDate(java.lang.String key) |
java.util.Date |
paramAsDateTime(java.lang.String key) |
<E extends java.lang.Enum<E>> |
paramAsEnum(java.lang.String key,
java.lang.Class<E> enumClass) |
<E extends java.lang.Enum<E>> |
paramAsEnums(java.lang.String key,
java.lang.Class<E> enumClass) |
abstract java.io.InputStream |
paramAsInputStream(java.lang.String key) |
java.lang.Integer |
paramAsInt(java.lang.String key) |
int |
paramAsInt(java.lang.String key,
int defaultValue)
Deprecated.
to be dropped in 4.4. Default values must be declared in
WebService then
this method can be replaced by mandatoryParamAsInt(String) . |
java.lang.Long |
paramAsLong(java.lang.String key) |
long |
paramAsLong(java.lang.String key,
long defaultValue)
Deprecated.
to be dropped in 4.4. Default values must be declared in
WebService then
this method can be replaced by mandatoryParamAsLong(String) . |
abstract Request.Part |
paramAsPart(java.lang.String key) |
abstract java.util.List<java.lang.String> |
paramAsStrings(java.lang.String key) |
protected static final java.lang.String MSG_PARAMETER_MISSING
public abstract java.lang.String method()
public java.io.BufferedReader getReader()
public abstract java.lang.String getMediaType()
"application/octet-stream"
if not specified.public abstract boolean hasParam(java.lang.String key)
public java.lang.String mandatoryParam(java.lang.String key)
java.lang.IllegalArgumentException
- is value is null or blankpublic boolean mandatoryParamAsBoolean(java.lang.String key)
java.lang.IllegalArgumentException
- is value is null or blankpublic int mandatoryParamAsInt(java.lang.String key)
java.lang.IllegalArgumentException
- is value is null or blankpublic long mandatoryParamAsLong(java.lang.String key)
java.lang.IllegalArgumentException
- is value is null or blankpublic <E extends java.lang.Enum<E>> E mandatoryParamAsEnum(java.lang.String key, java.lang.Class<E> enumClass)
public java.util.List<java.lang.String> mandatoryParamAsStrings(java.lang.String key)
public java.util.List<java.lang.String> mandatoryMultiParam(java.lang.String key)
@CheckForNull public abstract java.util.List<java.lang.String> paramAsStrings(java.lang.String key)
public abstract java.util.Map<java.lang.String,java.lang.String[]> getParams()
@CheckForNull public abstract java.lang.String param(java.lang.String key)
public abstract java.util.List<java.lang.String> multiParam(java.lang.String key)
@CheckForNull public abstract java.io.InputStream paramAsInputStream(java.lang.String key)
@CheckForNull public abstract Request.Part paramAsPart(java.lang.String key)
public Request.Part mandatoryParamAsPart(java.lang.String key)
@CheckForNull @Deprecated public java.lang.String param(java.lang.String key, @CheckForNull java.lang.String defaultValue)
@Deprecated public boolean paramAsBoolean(java.lang.String key, boolean defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsBoolean(String)
.@Deprecated public int paramAsInt(java.lang.String key, int defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsInt(String)
.@Deprecated public long paramAsLong(java.lang.String key, long defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsLong(String)
.@CheckForNull public java.lang.Boolean paramAsBoolean(java.lang.String key)
@CheckForNull public java.lang.Integer paramAsInt(java.lang.String key)
@CheckForNull public java.lang.Long paramAsLong(java.lang.String key)
@CheckForNull public <E extends java.lang.Enum<E>> E paramAsEnum(java.lang.String key, java.lang.Class<E> enumClass)
@CheckForNull public <E extends java.lang.Enum<E>> java.util.List<E> paramAsEnums(java.lang.String key, java.lang.Class<E> enumClass)
@CheckForNull public java.util.Date paramAsDateTime(java.lang.String key)
@CheckForNull public java.util.Date paramAsDate(java.lang.String key)
public <T> Request.Param<T> getParam(java.lang.String key, java.util.function.BiFunction<Request,java.lang.String,T> retrieveAndValidate)
public Request.StringParam getParam(java.lang.String key, java.util.function.Consumer<java.lang.String> validate)
public Request.StringParam getParam(java.lang.String key)
public abstract java.util.Optional<java.lang.String> header(java.lang.String name)
""
).public java.util.Map<java.lang.String,java.lang.String> getHeaders()
public abstract LocalConnector localConnector()
LocalConnector
public abstract java.lang.String getPath()