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

Class AbstractExecutionGraphRequestHandler

java.lang.Object

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

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

All Implemented Interfaces:

RequestHandler

Direct Known Subclasses:

AbstractJobVertexRequestHandler, CheckpointConfigHandler, CheckpointStatsDetailsHandler, CheckpointStatsDetailsSubtasksHandler, CheckpointStatsHandler, JobAccumulatorsHandler, JobConfigHandler, JobDetailsHandler, JobExceptionsHandler, JobPlanHandler

public abstract class AbstractExecutionGraphRequestHandler
extends AbstractJsonRequestHandler

Base class for request handlers whose response depends on an ExecutionGraph that can be retrieved via "jobid" parameter.

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

executor

Constructor Summary

Constructors

Constructor and Description
AbstractExecutionGraphRequestHandler(ExecutionGraphCache executionGraphCache, Executor executor)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.
abstract CompletableFuture<String>	handleRequest(AccessExecutionGraph graph, Map<String,String> params)

Methods inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

handleRequest

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

Constructor Detail

AbstractExecutionGraphRequestHandler

public AbstractExecutionGraphRequestHandler(ExecutionGraphCache executionGraphCache,
                                            Executor executor)

Method Detail

handleJsonRequest

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

Description copied from class: AbstractJsonRequestHandler

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.

Specified by:

handleJsonRequest in class AbstractJsonRequestHandler

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.

handleRequest

public abstract CompletableFuture<String> handleRequest(AccessExecutionGraph graph,
                                                        Map<String,String> params)