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

Class JobCancellationHandler

java.lang.Object

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

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

All Implemented Interfaces:

RequestHandler

public class JobCancellationHandler
extends AbstractJsonRequestHandler

Request handler for the cancel request.

Field Summary

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

executor

Constructor Summary

Constructors

Constructor and Description
JobCancellationHandler(Executor executor, Time timeout)

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<String>	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.

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

Constructor Detail

JobCancellationHandler

public JobCancellationHandler(Executor executor,
                              Time timeout)

Method Detail

getPaths

public String[] getPaths()

Description copied from interface: RequestHandler

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.

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.