org.apache.flink.runtime.rest.handler

Class HandlerRequest<R extends RequestBody>

java.lang.Object

org.apache.flink.runtime.rest.handler.HandlerRequest<R>

Type Parameters:

R - type of the contained request body

public class HandlerRequest<R extends RequestBody>
extends Object

Simple container for the request to a handler, that contains the RequestBody and path/query parameters.

Method Summary

Modifier and Type	Method and Description
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	create(R requestBody, M messageParameters) Short-cut for create(RequestBody, MessageParameters, Collection) without any uploaded files.
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	create(R requestBody, M messageParameters, Collection<File> uploadedFiles) Creates a new HandlerRequest.
<X,PP extends MessagePathParameter<X>> X	getPathParameter(Class<PP> parameterClass) Returns the value of the MessagePathParameter for the given class.
<X,QP extends MessageQueryParameter<X>> List<X>	getQueryParameter(Class<QP> parameterClass) Returns the value of the MessageQueryParameter for the given class.
R	getRequestBody() Returns the request body.
Collection<File>	getUploadedFiles()
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	resolveParametersAndCreate(R requestBody, M messageParameters, Map<String,String> receivedPathParameters, Map<String,List<String>> receivedQueryParameters, Collection<File> uploadedFiles) Creates a new HandlerRequest after resolving the given MessageParameters against the given query/path parameter maps.

Methods inherited from class java.lang.Object

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

Method Detail

getRequestBody

public R getRequestBody()

Returns the request body.

Returns:

request body

getPathParameter

public <X,PP extends MessagePathParameter<X>> X getPathParameter(Class<PP> parameterClass)

Returns the value of the MessagePathParameter for the given class.

Type Parameters:

X - the value type that the parameter contains

PP - type of the path parameter

Parameters:

parameterClass - class of the parameter

Returns:

path parameter value for the given class

Throws:

IllegalStateException - if no value is defined for the given parameter class

getQueryParameter

public <X,QP extends MessageQueryParameter<X>> List<X> getQueryParameter(Class<QP> parameterClass)

Returns the value of the MessageQueryParameter for the given class.

Type Parameters:

X - the value type that the parameter contains

QP - type of the query parameter

Parameters:

parameterClass - class of the parameter

Returns:

query parameter value for the given class, or an empty list if no parameter value exists for the given class

getUploadedFiles

@Nonnull
public Collection<File> getUploadedFiles()

create

@VisibleForTesting
public static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R> create(R requestBody,
                                                                                                              M messageParameters)

Short-cut for create(RequestBody, MessageParameters, Collection) without any uploaded files.

create

@VisibleForTesting
public static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R> create(R requestBody,
                                                                                                              M messageParameters,
                                                                                                              Collection<File> uploadedFiles)

Creates a new HandlerRequest. The given MessageParameters are expected to be resolved.

resolveParametersAndCreate

public static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R> resolveParametersAndCreate(R requestBody,
                                                                                                               M messageParameters,
                                                                                                               Map<String,String> receivedPathParameters,
                                                                                                               Map<String,List<String>> receivedQueryParameters,
                                                                                                               Collection<File> uploadedFiles)
                                                                                                        throws HandlerRequestException

Creates a new HandlerRequest after resolving the given MessageParameters against the given query/path parameter maps.

For tests it is recommended to resolve the parameters manually and use create(R, M).

Throws:

HandlerRequestException