Package org.apache.flink.runtime.rest.handler.job

Class JobsOverviewHandler

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler<RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.AbstractHandler<T,R,M>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<RestfulGateway,EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters>

org.apache.flink.runtime.rest.handler.job.JobsOverviewHandler

All Implemented Interfaces:

AutoCloseable, JsonArchivist, OnlyExecutionGraphJsonArchivist, org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler, AutoCloseableAsync

public class JobsOverviewHandler
extends AbstractRestHandler<RestfulGateway,EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters>
implements OnlyExecutionGraphJsonArchivist

Overview handler for jobs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

Fields inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Constructor	Description
JobsOverviewHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters> messageHeaders)

Method Summary

Modifier and Type	Method	Description
Collection<ArchivedJson>	archiveJsonWithPath(AccessExecutionGraph graph)	Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
protected CompletableFuture<MultipleJobsDetails>	handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)	This method is called for every incoming request and returns a CompletableFuture containing a the response.

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

Methods inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0, getTimeout

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Methods inherited from interface org.apache.flink.runtime.webmonitor.history.OnlyExecutionGraphJsonArchivist

archiveJsonWithPath

Constructor Detail

JobsOverviewHandler

public JobsOverviewHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                           Duration timeout,
                           Map<String,String> responseHeaders,
                           MessageHeaders<EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters> messageHeaders)

Method Detail

handleRequest

protected CompletableFuture<MultipleJobsDetails> handleRequest(@Nonnull
                                                               HandlerRequest<EmptyRequestBody> request,
                                                               @Nonnull
                                                               RestfulGateway gateway)
                                                        throws RestHandlerException

Description copied from class: AbstractRestHandler

This method is called for every incoming request and returns a CompletableFuture containing a the response.

Implementations may decide whether to throw RestHandlerExceptions or fail the returned CompletableFuture with a RestHandlerException.

Failing the future with another exception type or throwing unchecked exceptions is regarded as an implementation error as it does not allow us to provide a meaningful HTTP status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR will be returned.

Specified by:

handleRequest in class AbstractRestHandler<RestfulGateway,EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph)
                                             throws IOException

Description copied from interface: OnlyExecutionGraphJsonArchivist

Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.

The collection should contain one entry for every response that could be generated for the given job, for example one entry for each task. The REST URLs should be unique and must not contain placeholders.

Specified by:

archiveJsonWithPath in interface OnlyExecutionGraphJsonArchivist

Parameters:

graph - AccessExecutionGraph for which the responses should be generated

Returns:

Collection containing an ArchivedJson for every response that could be generated for the given job

Throws:

IOException - thrown if the JSON generation fails