public abstract class Request extends 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 . |
Constructor and Description |
---|
Request() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getMediaType()
Returns the requested MIME type, or
"application/octet-stream" if not specified. |
Request.StringParam |
getParam(String key) |
<T> Request.Param<T> |
getParam(String key,
BiFunction<Request,String,T> retrieveAndValidate) |
Request.StringParam |
getParam(String key,
Consumer<String> validate) |
abstract String |
getPath()
Return path of the request
|
abstract boolean |
hasParam(String key)
Return true of the parameter is set in the request.
|
abstract Optional<String> |
header(String name)
Optional value of the HTTP header with specified name.
|
abstract LocalConnector |
localConnector()
Allows a web service to call another web service.
|
List<String> |
mandatoryMultiParam(String key) |
String |
mandatoryParam(String key)
Returns a non-null value.
|
boolean |
mandatoryParamAsBoolean(String key)
Returns a boolean value.
|
<E extends Enum<E>> |
mandatoryParamAsEnum(String key,
Class<E> enumClass) |
int |
mandatoryParamAsInt(String key)
Returns an int value.
|
long |
mandatoryParamAsLong(String key)
Returns a long value.
|
Request.Part |
mandatoryParamAsPart(String key) |
List<String> |
mandatoryParamAsStrings(String key) |
abstract String |
method()
Returns the name of the HTTP method with which this request was made.
|
abstract List<String> |
multiParam(String key) |
abstract String |
param(String key) |
String |
param(String key,
String defaultValue)
Deprecated.
to be dropped in 4.4. Default values are declared in ws metadata
|
Boolean |
paramAsBoolean(String key) |
boolean |
paramAsBoolean(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) . |
Date |
paramAsDate(String key) |
Date |
paramAsDateTime(String key) |
<E extends Enum<E>> |
paramAsEnum(String key,
Class<E> enumClass) |
<E extends Enum<E>> |
paramAsEnums(String key,
Class<E> enumClass) |
abstract InputStream |
paramAsInputStream(String key) |
Integer |
paramAsInt(String key) |
int |
paramAsInt(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) . |
Long |
paramAsLong(String key) |
long |
paramAsLong(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(String key) |
abstract List<String> |
paramAsStrings(String key) |
public Request()
public abstract String method()
public abstract String getMediaType()
"application/octet-stream"
if not specified.public abstract boolean hasParam(String key)
public String mandatoryParam(String key)
IllegalArgumentException
- is value is null or blankpublic boolean mandatoryParamAsBoolean(String key)
IllegalArgumentException
- is value is null or blankpublic int mandatoryParamAsInt(String key)
IllegalArgumentException
- is value is null or blankpublic long mandatoryParamAsLong(String key)
IllegalArgumentException
- is value is null or blankpublic <E extends Enum<E>> E mandatoryParamAsEnum(String key, Class<E> enumClass)
public List<String> mandatoryParamAsStrings(String key)
public List<String> mandatoryMultiParam(String key)
@CheckForNull public abstract List<String> paramAsStrings(String key)
@CheckForNull public abstract String param(String key)
public abstract List<String> multiParam(String key)
@CheckForNull public abstract InputStream paramAsInputStream(String key)
@CheckForNull public abstract Request.Part paramAsPart(String key)
public Request.Part mandatoryParamAsPart(String key)
@CheckForNull @Deprecated public String param(String key, @CheckForNull String defaultValue)
@Deprecated public boolean paramAsBoolean(String key, boolean defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsBoolean(String)
.@Deprecated public int paramAsInt(String key, int defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsInt(String)
.@Deprecated public long paramAsLong(String key, long defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsLong(String)
.@CheckForNull public Boolean paramAsBoolean(String key)
@CheckForNull public Integer paramAsInt(String key)
@CheckForNull public Long paramAsLong(String key)
@CheckForNull public <E extends Enum<E>> E paramAsEnum(String key, Class<E> enumClass)
@CheckForNull public <E extends Enum<E>> List<E> paramAsEnums(String key, Class<E> enumClass)
@CheckForNull public Date paramAsDateTime(String key)
@CheckForNull public Date paramAsDate(String key)
public <T> Request.Param<T> getParam(String key, BiFunction<Request,String,T> retrieveAndValidate)
public Request.StringParam getParam(String key, Consumer<String> validate)
public Request.StringParam getParam(String key)
public abstract Optional<String> header(String name)
""
).public abstract LocalConnector localConnector()
LocalConnector
Copyright © 2009–2017 SonarSource. All rights reserved.