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

Interface RequestHandler

All Known Implementing Classes:

AbstractExecutionGraphRequestHandler, AbstractJobVertexRequestHandler, AbstractJsonRequestHandler, AbstractMetricsHandler, AbstractSubtaskAttemptRequestHandler, AbstractSubtaskRequestHandler, AggregatingJobsMetricsHandler, AggregatingSubtasksMetricsHandler, AggregatingTaskManagersMetricsHandler, CheckpointConfigHandler, CheckpointStatsDetailsHandler, CheckpointStatsDetailsSubtasksHandler, CheckpointStatsHandler, ClusterConfigHandler, ClusterOverviewHandler, CurrentJobIdsHandler, DashboardConfigHandler, JobAccumulatorsHandler, JobCancellationHandler, JobConfigHandler, JobDetailsHandler, JobExceptionsHandler, JobManagerMetricsHandler, JobMetricsHandler, JobPlanHandler, JobsOverviewHandler, JobStoppingHandler, JobVertexAccumulatorsHandler, JobVertexBackPressureHandler, JobVertexDetailsHandler, JobVertexMetricsHandler, JobVertexTaskManagersHandler, SubtaskCurrentAttemptDetailsHandler, SubtaskExecutionAttemptAccumulatorsHandler, SubtaskExecutionAttemptDetailsHandler, SubtaskMetricsHandler, SubtasksAllAccumulatorsHandler, SubtasksTimesHandler, TaskManagerMetricsHandler, TaskManagersHandler

public interface RequestHandler

Base interface for all request handlers.

Most handlers will want to use the AbstractJsonRequestHandler as a starting point, which produces a valid HTTP response.

Method Summary

Modifier and Type	Method and Description
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.
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.

Method Detail

handleRequest

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. The method needs to respond with a full http response, including content-type, content-length, etc.

Exceptions may be throws and will be handled.

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.

getPaths

String[] getPaths()

Returns an array of REST URL's under which this handler can be registered.

Returns:

array containing REST URL's under which this handler can be registered.