org.apache.flink.runtime.rest.handler.resourcemanager

类 AbstractResourceManagerHandler<T extends RestfulGateway,R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

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

org.apache.flink.runtime.rest.handler.resourcemanager.AbstractResourceManagerHandler<T,R,P,M>

类型参数:

T - type of the RestfulGateway

R - request type

P - response type

M - message parameters type

所有已实现的接口:

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

直接已知子类:

ClusterDataSetListHandler, TaskManagerDetailsHandler, TaskManagerLogListHandler, TaskManagersHandler, TaskManagerThreadDumpHandler

public abstract class AbstractResourceManagerHandler<T extends RestfulGateway,R extends RequestBody,P extends ResponseBody,M extends MessageParameters>
extends AbstractRestHandler<T,R,P,M>

Base class for REST handlers which need access to the ResourceManager.

嵌套类概要

从接口继承的嵌套类/接口 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

构造器概要

构造器

限定符	构造器和说明
protected	AbstractResourceManagerHandler(GatewayRetriever<? extends T> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<R,P,M> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)

方法概要

限定符和类型	方法和说明
static ResourceManagerGateway	getResourceManagerGateway(GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
protected abstract CompletableFuture<P>	handleRequest(HandlerRequest<R> request, ResourceManagerGateway gateway)
protected CompletableFuture<P>	handleRequest(HandlerRequest<R> request, T 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

构造器详细资料

AbstractResourceManagerHandler

protected AbstractResourceManagerHandler(GatewayRetriever<? extends T> leaderRetriever,
                                         org.apache.flink.api.common.time.Time timeout,
                                         Map<String,String> responseHeaders,
                                         MessageHeaders<R,P,M> messageHeaders,
                                         GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)

方法详细资料

handleRequest

protected CompletableFuture<P> handleRequest(@Nonnull
                                             HandlerRequest<R> request,
                                             @Nonnull
                                             T 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<T extends RestfulGateway,R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

参数:

request - request that should be handled

gateway - leader gateway

返回:

future containing a handler response

抛出:

RestHandlerException - if the handling failed

handleRequest

protected abstract CompletableFuture<P> handleRequest(@Nonnull
                                                      HandlerRequest<R> request,
                                                      @Nonnull
                                                      ResourceManagerGateway gateway)
                                               throws RestHandlerException

抛出:

RestHandlerException

getResourceManagerGateway

public static ResourceManagerGateway getResourceManagerGateway(GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
                                                        throws RestHandlerException

抛出:

RestHandlerException