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

类 JobManagerJobEnvironmentHandler

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,EnvironmentInfo,JobMessageParameters>

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

所有已实现的接口:

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 JobManagerJobEnvironmentHandler
extends AbstractRestHandler<RestfulGateway,EmptyRequestBody,EnvironmentInfo,JobMessageParameters>
implements JsonArchivist

Handler which serves the jobmanager's environment variables of a specific job.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

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

字段概要

从类继承的字段 org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

从类继承的字段 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

构造器概要

构造器

构造器和说明
JobManagerJobEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,EnvironmentInfo,JobMessageParameters> messageHeaders)

方法概要

限定符和类型	方法和说明
Collection<ArchivedJson>	archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo) Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
protected CompletableFuture<EnvironmentInfo>	handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway) This method is called for every incoming request and returns a CompletableFuture containing a the response.

从类继承的方法 org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

从类继承的方法 org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

从类继承的方法 org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

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

从类继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.util.AutoCloseableAsync

close

从接口继承的方法 org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

构造器详细资料

JobManagerJobEnvironmentHandler

public JobManagerJobEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                       org.apache.flink.api.common.time.Time timeout,
                                       Map<String,String> responseHeaders,
                                       MessageHeaders<EmptyRequestBody,EnvironmentInfo,JobMessageParameters> messageHeaders)

方法详细资料

handleRequest

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

从类复制的说明: 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.

指定者:

handleRequest 在类中 AbstractRestHandler<RestfulGateway,EmptyRequestBody,EnvironmentInfo,JobMessageParameters>

参数:

request - request that should be handled

gateway - leader gateway

返回:

future containing a handler response

抛出:

RestHandlerException - if the handling failed

archiveJsonWithPath

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

从接口复制的说明: 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.

指定者:

archiveJsonWithPath 在接口中 JsonArchivist

参数:

executionGraphInfo - AccessExecutionGraph-related information for which the responses should be generated

返回:

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

抛出:

IOException - thrown if the JSON generation fails