Package org.apache.flink.runtime.webmonitor

Class WebSubmissionExtension

java.lang.Object

org.apache.flink.runtime.webmonitor.WebSubmissionExtension

All Implemented Interfaces:

AutoCloseable, WebMonitorExtension, AutoCloseableAsync

public class WebSubmissionExtension
extends Object
implements WebMonitorExtension

Container for the web submission handlers.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.webmonitor.WebMonitorExtension

WebMonitorExtension.EmptyWebMonitorExtension

Constructor Summary

Constructors

Constructor	Description
WebSubmissionExtension(Configuration configuration, GatewayRetriever<? extends DispatcherGateway> leaderRetriever, Map<String,String> responseHeaders, CompletableFuture<String> localAddressFuture, Path jarDir, Executor executor, Duration timeout)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	closeAsync()	Trigger the closing of the resource and return the corresponding close future.
Collection<Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	getHandlers()	Gets the collection of extension handlers to register at the WebMonitorEndpoint.

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.util.AutoCloseableAsync

close

Constructor Detail

WebSubmissionExtension

public WebSubmissionExtension(Configuration configuration,
                              GatewayRetriever<? extends DispatcherGateway> leaderRetriever,
                              Map<String,String> responseHeaders,
                              CompletableFuture<String> localAddressFuture,
                              Path jarDir,
                              Executor executor,
                              Duration timeout)
                       throws Exception

Throws:

Exception

Method Detail

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: AutoCloseableAsync

Trigger the closing of the resource and return the corresponding close future.

Specified by:

closeAsync in interface AutoCloseableAsync

Returns:

Future which is completed once the resource has been closed

getHandlers

public Collection<Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> getHandlers()

Description copied from interface: WebMonitorExtension

Gets the collection of extension handlers to register at the WebMonitorEndpoint.

Specified by:

getHandlers in interface WebMonitorExtension

Returns:

Collection of handlers to register at the WebMonitorEndpoint.