org.apache.flink.runtime.rest.handler

Class LegacyRestHandlerAdapter<T extends RestfulGateway,R 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<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>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<T,EmptyRequestBody,R,M>

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

Type Parameters:

T - type of the gateway

R - type of the REST response

M - type of the MessageParameters

All Implemented Interfaces:

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

public class LegacyRestHandlerAdapter<T extends RestfulGateway,R extends ResponseBody,M extends MessageParameters>
extends AbstractRestHandler<T,EmptyRequestBody,R,M>

Adapter for Flink's legacy REST handlers.

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.AbstractHandler

log, MAPPER

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

leaderRetriever, localAddressFuture, logger, responseHeaders, timeout

Constructor Summary

Constructors

Constructor and Description
LegacyRestHandlerAdapter(CompletableFuture<String> localRestAddress, GatewayRetriever<T> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> headers, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, LegacyRestHandler<T,R,M> legacyRestHandler)

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<R>	handleRequest(HandlerRequest<EmptyRequestBody,M> request, T gateway) This method is called for every incoming request and returns a CompletableFuture containing a the response.

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

getMessageHeaders, respondToRequest

Methods inherited from class org.apache.flink.runtime.rest.AbstractHandler

respondAsLeader

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

Constructor Detail

LegacyRestHandlerAdapter

public LegacyRestHandlerAdapter(CompletableFuture<String> localRestAddress,
                                GatewayRetriever<T> leaderRetriever,
                                org.apache.flink.api.common.time.Time timeout,
                                Map<String,String> headers,
                                MessageHeaders<EmptyRequestBody,R,M> messageHeaders,
                                LegacyRestHandler<T,R,M> legacyRestHandler)

Method Detail

handleRequest

protected CompletableFuture<R> handleRequest(@Nonnull
                                             HandlerRequest<EmptyRequestBody,M> request,
                                             @Nonnull
                                             T gateway)
                                      throws RestHandlerException

Description copied from class: 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.

Specified by:

handleRequest in class AbstractRestHandler<T extends RestfulGateway,EmptyRequestBody,R extends ResponseBody,M extends MessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed