org.apache.flink.runtime.rest.handler

类 AbstractHandler<T extends RestfulGateway,R extends RequestBody,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>

类型参数:

T - type of the leader gateway

R - type of the incoming request

M - type of the message parameters

所有已实现的接口:

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

直接已知子类:

AbstractRestHandler, AbstractTaskManagerFileHandler

public abstract class AbstractHandler<T extends RestfulGateway,R extends RequestBody,M extends MessageParameters>
extends LeaderRetrievalHandler<T>
implements org.apache.flink.util.AutoCloseableAsync

Super class for netty-based handlers that work with RequestBody.

Subclasses must be thread-safe

嵌套类概要

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

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

字段概要

字段

限定符和类型	字段和说明
protected org.slf4j.Logger	log
protected static org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper	MAPPER

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

leaderRetriever, logger, responseHeaders, timeout

构造器概要

构造器

限定符	构造器和说明
protected	AbstractHandler(GatewayRetriever<? extends T> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<R,M> untypedResponseMessageHeaders)

方法概要

限定符和类型	方法和说明
CompletableFuture<Void>	closeAsync()
protected CompletableFuture<Void>	closeHandlerAsync()
protected void	respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, RoutedRequest routedRequest, T gateway)
protected abstract CompletableFuture<Void>	respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<R,M> handlerRequest, T gateway) Respond to the given HandlerRequest.

从类继承的方法 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

字段详细资料

log

protected final org.slf4j.Logger log

MAPPER

protected static final org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper MAPPER

构造器详细资料

AbstractHandler

protected AbstractHandler(@Nonnull
                          GatewayRetriever<? extends T> leaderRetriever,
                          @Nonnull
                          org.apache.flink.api.common.time.Time timeout,
                          @Nonnull
                          Map<String,String> responseHeaders,
                          @Nonnull
                          UntypedResponseMessageHeaders<R,M> untypedResponseMessageHeaders)

方法详细资料

respondAsLeader

protected void respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                               RoutedRequest routedRequest,
                               T gateway)

指定者:

respondAsLeader 在类中 LeaderRetrievalHandler<T extends RestfulGateway>

closeAsync

public final CompletableFuture<Void> closeAsync()

指定者:

closeAsync 在接口中 org.apache.flink.util.AutoCloseableAsync

closeHandlerAsync

protected CompletableFuture<Void> closeHandlerAsync()

respondToRequest

protected abstract CompletableFuture<Void> respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                                                            org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest,
                                                            HandlerRequest<R,M> handlerRequest,
                                                            T gateway)
                                                     throws RestHandlerException

Respond to the given HandlerRequest.

参数:

ctx - channel handler context to write the response

httpRequest - original http request

handlerRequest - typed handler request

gateway - leader gateway

返回:

Future which is completed once the request has been processed

抛出:

RestHandlerException - if an exception occurred while responding