Package org.apache.flink.runtime.rest.handler.util

Class HandlerRequestUtils

java.lang.Object

org.apache.flink.runtime.rest.handler.util.HandlerRequestUtils

public class HandlerRequestUtils
extends Object

Utils for getting query parameters from HandlerRequest.

Constructor Summary

Constructors

Constructor	Description
HandlerRequestUtils()

Method Summary

Modifier and Type	Method	Description
static <T> T	fromRequestBodyOrQueryParameter(T requestValue, org.apache.flink.util.function.SupplierWithException<T,RestHandlerException> queryParameterExtractor, T defaultValue, org.slf4j.Logger log)	Returns requestValue if it is not null, otherwise returns the query parameter value if it is not null, otherwise returns the default value.
static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X	getQueryParameter(HandlerRequest<R> request, Class<P> queryParameterClass)	Returns the value of a query parameter, or null if the query parameter is not set.
static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X	getQueryParameter(HandlerRequest<R> request, Class<P> queryParameterClass, X defaultValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerRequestUtils

public HandlerRequestUtils()

Method Detail

getQueryParameter

public static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X getQueryParameter(HandlerRequest<R> request,
                                                                                                                                             Class<P> queryParameterClass)
                                                                                                                                      throws RestHandlerException

Returns the value of a query parameter, or null if the query parameter is not set.

Throws:

RestHandlerException - If the query parameter is repeated.

getQueryParameter

public static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X getQueryParameter(HandlerRequest<R> request,
                                                                                                                                             Class<P> queryParameterClass,
                                                                                                                                             X defaultValue)
                                                                                                                                      throws RestHandlerException

Throws:

RestHandlerException

fromRequestBodyOrQueryParameter

public static <T> T fromRequestBodyOrQueryParameter(T requestValue,
                                                    org.apache.flink.util.function.SupplierWithException<T,RestHandlerException> queryParameterExtractor,
                                                    T defaultValue,
                                                    org.slf4j.Logger log)
                                             throws RestHandlerException

Returns requestValue if it is not null, otherwise returns the query parameter value if it is not null, otherwise returns the default value.

Throws:

RestHandlerException