org.apache.flink.runtime.webmonitor.handlers

Class JobCancellationHandler

java.lang.Object

org.apache.flink.runtime.webmonitor.handlers.AbstractJsonRequestHandler

org.apache.flink.runtime.webmonitor.handlers.JobCancellationHandler

All Implemented Interfaces:

RequestHandler

public class JobCancellationHandler
extends AbstractJsonRequestHandler

Request handler for the CANCEL request.

Constructor Summary

Constructors

Constructor and Description
JobCancellationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.
String	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, ActorGateway jobManager) Core method that handles the request and generates the response.

Methods inherited from class org.apache.flink.runtime.webmonitor.handlers.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()

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 String handleJsonRequest(Map<String,String> pathParams,
                       Map<String,String> queryParams,
                       ActorGateway jobManager)
                         throws Exception

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.

jobManager - The JobManager actor.

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.