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

Class JobExceptionsHandler

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,R,M>

org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler<JobExceptionsInfoWithHistory,JobExceptionsMessageParameters>

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

All Implemented Interfaces:

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

public class JobExceptionsHandler
extends AbstractExecutionGraphHandler<JobExceptionsInfoWithHistory,JobExceptionsMessageParameters>
implements JsonArchivist

Handler serving the job exceptions.

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
JobExceptionsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobExceptionsInfoWithHistory,JobExceptionsMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

Method Summary

Modifier and Type	Method	Description
Collection<ArchivedJson>	archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo)	Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
protected JobExceptionsInfoWithHistory	handleRequest(HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraph)	Called for each request after the corresponding ExecutionGraphInfo has been retrieved from the ExecutionGraphCache.

Methods inherited from class org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler

handleRequest

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

Constructor Detail

JobExceptionsHandler

public JobExceptionsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                            Duration timeout,
                            Map<String,String> responseHeaders,
                            MessageHeaders<EmptyRequestBody,JobExceptionsInfoWithHistory,JobExceptionsMessageParameters> messageHeaders,
                            ExecutionGraphCache executionGraphCache,
                            Executor executor)

Method Detail

handleRequest

protected JobExceptionsInfoWithHistory handleRequest(HandlerRequest<EmptyRequestBody> request,
                                                     ExecutionGraphInfo executionGraph)

Description copied from class: AbstractExecutionGraphHandler

Called for each request after the corresponding ExecutionGraphInfo has been retrieved from the ExecutionGraphCache.

Specified by:

handleRequest in class AbstractExecutionGraphHandler<JobExceptionsInfoWithHistory,JobExceptionsMessageParameters>

Parameters:

request - for further information

executionGraph - for which the handler was called

Returns:

Response

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo)
                                             throws IOException

Description copied from interface: JsonArchivist

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 JsonArchivist

Parameters:

executionGraphInfo - AccessExecutionGraph-related information 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