org.apache.flink.runtime.webmonitor.handlers

Class ClusterOverviewHandler

java.lang.Object

org.apache.flink.runtime.webmonitor.handlers.ClusterOverviewHandler

All Implemented Interfaces:

RequestHandler

public class ClusterOverviewHandler
extends Object
implements RequestHandler

Responder that returns the status of the Flink cluster, such as how many TaskManagers are currently connected, and how many jobs are running.

Constructor Summary

Constructors

Constructor and Description
ClusterOverviewHandler(scala.concurrent.duration.FiniteDuration timeout)

Method Summary

Modifier and Type	Method and Description
String	handleRequest(Map<String,String> pathParams, Map<String,String> queryParams, ActorGateway jobManager) 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

Constructor Detail

ClusterOverviewHandler

public ClusterOverviewHandler(scala.concurrent.duration.FiniteDuration timeout)

Method Detail

handleRequest

public String handleRequest(Map<String,String> pathParams,
                            Map<String,String> queryParams,
                            ActorGateway jobManager)
                     throws Exception

Description copied from interface: RequestHandler

Core method that handles the request and generates the response. The method needs to respond with a valid JSON string. 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.

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.