org.apache.flink.runtime.webmonitor.handlers

Class DashboardConfigHandler

java.lang.Object

org.apache.flink.runtime.webmonitor.handlers.DashboardConfigHandler

All Implemented Interfaces:

RequestHandler

public class DashboardConfigHandler
extends Object
implements RequestHandler

Responder that returns the parameters that define how the asynchronous requests against this web server should behave. It defines for example the refresh interval, and time zone of the server timestamps.

Constructor Summary

Constructors

Constructor and Description
DashboardConfigHandler(long refreshInterval)

Method Summary

Modifier and Type	Method and Description
String	handleRequest(Map<String,String> pathParams, Map<String,String> queryParams, org.apache.flink.runtime.instance.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

DashboardConfigHandler

public DashboardConfigHandler(long refreshInterval)

Method Detail

handleRequest

public String handleRequest(Map<String,String> pathParams,
                            Map<String,String> queryParams,
                            org.apache.flink.runtime.instance.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.