org.apache.flink.runtime.rest.handler.legacy

Class AbstractJsonRequestHandler

java.lang.Object

org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

All Implemented Interfaces:

RequestHandler

Direct Known Subclasses:

AbstractExecutionGraphRequestHandler, AbstractMetricsHandler, AggregatingJobsMetricsHandler, AggregatingSubtasksMetricsHandler, AggregatingTaskManagersMetricsHandler, ClusterConfigHandler, ClusterOverviewHandler, CurrentJobIdsHandler, DashboardConfigHandler, JobCancellationHandler, JobsOverviewHandler, JobStoppingHandler, TaskManagersHandler

public abstract class AbstractJsonRequestHandler
extends Object
implements RequestHandler

Base class for most request handlers. The handlers must produce a JSON response.

Field Summary

Fields

Modifier and Type	Field and Description
protected Executor	executor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJsonRequestHandler(Executor executor)

Method Summary

Modifier and Type	Method and Description
abstract CompletableFuture<String>	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.
CompletableFuture<org.apache.flink.shaded.netty4.io.netty.handler.codec.http.FullHttpResponse>	handleRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.rest.handler.legacy.RequestHandler

getPaths

Field Detail

executor

protected final Executor executor

Constructor Detail

AbstractJsonRequestHandler

protected AbstractJsonRequestHandler(Executor executor)

Method Detail

handleRequest

public CompletableFuture<org.apache.flink.shaded.netty4.io.netty.handler.codec.http.FullHttpResponse> handleRequest(Map<String,String> pathParams,
                                                                                                                    Map<String,String> queryParams,
                                                                                                                    JobManagerGateway jobManagerGateway)

Description copied from interface: RequestHandler

Core method that handles the request and generates the response. The method needs to respond with a full http response, including content-type, content-length, etc.

Exceptions may be throws and will be handled.

Specified by:

handleRequest in interface RequestHandler

Parameters:

pathParams - The map of REST path parameters, decoded by the router.

queryParams - The map of query parameters.

jobManagerGateway - to talk to the JobManager.

Returns:

The full http response.

handleJsonRequest

public abstract CompletableFuture<String> handleJsonRequest(Map<String,String> pathParams,
                                                            Map<String,String> queryParams,
                                                            JobManagerGateway jobManagerGateway)

Core method that handles the request and generates the response. The method needs to respond with a valid JSON string. Exceptions may be thrown and will be handled.

Parameters:

pathParams - The map of REST path parameters, decoded by the router.

queryParams - The map of query parameters.

jobManagerGateway - to communicate with the JobManager.

Returns:

The JSON string that is the HTTP response.

Throws:

Exception - Handlers may forward exceptions. Exceptions of type NotFoundException will cause a HTTP 404 response with the exception message, other exceptions will cause a HTTP 500 response with the exception stack trace.