org.apache.flink.runtime.rest

Class 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<org.apache.flink.shaded.netty4.io.netty.handler.codec.http.router.Routed>

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

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

Type Parameters:

T - type of the leader gateway

R - type of the incoming request

M - type of the message parameters

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRestHandler, AbstractTaskManagerFileHandler

public abstract class AbstractHandler<T extends RestfulGateway,R extends RequestBody,M extends MessageParameters>
extends RedirectHandler<T>

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

Subclasses must be thread-safe

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

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected static org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper	MAPPER

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

leaderRetriever, localAddressFuture, logger, responseHeaders, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHandler(CompletableFuture<String> localAddressFuture, GatewayRetriever<? extends T> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<R,M> untypedResponseMessageHeaders)

Method Summary

Modifier and Type	Method and Description
protected void	respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.router.Routed routed, 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.

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

channelRead0

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

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.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

log

protected final org.slf4j.Logger log

MAPPER

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

Constructor Detail

AbstractHandler

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

Method Detail

respondAsLeader

protected void respondAsLeader(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                               org.apache.flink.shaded.netty4.io.netty.handler.codec.http.router.Routed routed,
                               T gateway)
                        throws Exception

Specified by:

respondAsLeader in class RedirectHandler<T extends RestfulGateway>

Throws:

Exception

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.

Parameters:

ctx - channel handler context to write the response

httpRequest - original http request

handlerRequest - typed handler request

gateway - leader gateway

Returns:

Future which is completed once the request has been processed

Throws:

RestHandlerException - if an exception occurred while responding