org.apache.flink.runtime.rest.handler

Class HandlerRequest<R extends RequestBody,M extends MessageParameters>

java.lang.Object

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

Type Parameters:

R - type of the contained request body

M - type of the contained message parameters

public class HandlerRequest<R extends RequestBody,M extends MessageParameters>
extends Object

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

Constructor Summary

Constructors

Constructor and Description
HandlerRequest(R requestBody, M messageParameters)
HandlerRequest(R requestBody, M messageParameters, Map<String,String> receivedPathParameters, Map<String,List<String>> receivedQueryParameters)
HandlerRequest(R requestBody, M messageParameters, Map<String,String> receivedPathParameters, Map<String,List<String>> receivedQueryParameters, Collection<File> uploadedFiles)

Method Summary

Modifier and Type	Method and Description
<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()

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerRequest

public HandlerRequest(R requestBody,
                      M messageParameters)
               throws HandlerRequestException

Throws:

HandlerRequestException

HandlerRequest

public HandlerRequest(R requestBody,
                      M messageParameters,
                      Map<String,String> receivedPathParameters,
                      Map<String,List<String>> receivedQueryParameters)
               throws HandlerRequestException

Throws:

HandlerRequestException

HandlerRequest

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

Throws:

HandlerRequestException

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