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

Class BlobServerPortHandler

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.handler.AbstractRestHandler<DispatcherGateway,EmptyRequestBody,BlobServerPortResponseBody,EmptyMessageParameters>

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

All Implemented Interfaces:

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

public final class BlobServerPortHandler
extends AbstractRestHandler<DispatcherGateway,EmptyRequestBody,BlobServerPortResponseBody,EmptyMessageParameters>

This handler can be used to retrieve the port that the blob server runs on.

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.handler.AbstractRestHandler

log

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

leaderRetriever, localAddressFuture, logger, timeout

Constructor Summary

Constructors

Constructor and Description
BlobServerPortHandler(CompletableFuture<String> localRestAddress, GatewayRetriever<DispatcherGateway> leaderRetriever, Time timeout)

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<BlobServerPortResponseBody>	handleRequest(HandlerRequest<EmptyRequestBody,EmptyMessageParameters> request, DispatcherGateway 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, 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

BlobServerPortHandler

public BlobServerPortHandler(CompletableFuture<String> localRestAddress,
                             GatewayRetriever<DispatcherGateway> leaderRetriever,
                             Time timeout)

Method Detail

handleRequest

protected CompletableFuture<BlobServerPortResponseBody> handleRequest(@Nonnull
                                                                      HandlerRequest<EmptyRequestBody,EmptyMessageParameters> request,
                                                                      @Nonnull
                                                                      DispatcherGateway 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<DispatcherGateway,EmptyRequestBody,BlobServerPortResponseBody,EmptyMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed