org.apache.flink.runtime.util

Class LeaderRetrievalUtils

java.lang.Object

org.apache.flink.runtime.util.LeaderRetrievalUtils

public class LeaderRetrievalUtils
extends Object

Utility class to work with LeaderRetrievalService class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeaderRetrievalUtils.LeaderConnectionInfoListener Helper class which is used by the retrieveLeaderConnectionInfo method to retrieve the leader's akka URL and the current leader session ID.
static class	LeaderRetrievalUtils.LeaderGatewayListener Helper class which is used by the retrieveLeaderGateway method as the LeaderRetrievalListener.

Method Summary

Modifier and Type	Method and Description
static LeaderRetrievalService	createLeaderRetrievalService(org.apache.flink.configuration.Configuration configuration) Creates a LeaderRetrievalService based on the provided Configuration object.
static LeaderRetrievalService	createLeaderRetrievalService(org.apache.flink.configuration.Configuration configuration, akka.actor.ActorRef standaloneRef) Creates a LeaderRetrievalService that either uses the distributed leader election configured in the configuration, or, in standalone mode, the given actor reference.
static InetAddress	findConnectingAddress(LeaderRetrievalService leaderRetrievalService, scala.concurrent.duration.FiniteDuration timeout)
static RecoveryMode	getRecoveryMode(org.apache.flink.configuration.Configuration config) Gets the recovery mode as configured, based on the ConfigConstants.RECOVERY_MODE config key.
static LeaderConnectionInfo	retrieveLeaderConnectionInfo(LeaderRetrievalService leaderRetrievalService, scala.concurrent.duration.FiniteDuration timeout) Retrieves the leader akka url and the current leader session ID.
static ActorGateway	retrieveLeaderGateway(LeaderRetrievalService leaderRetrievalService, akka.actor.ActorSystem actorSystem, scala.concurrent.duration.FiniteDuration timeout) Retrieves the current leader gateway using the given LeaderRetrievalService.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createLeaderRetrievalService

public static LeaderRetrievalService createLeaderRetrievalService(org.apache.flink.configuration.Configuration configuration)
                                                           throws Exception

Creates a LeaderRetrievalService based on the provided Configuration object.

Parameters:

configuration - Configuration containing the settings for the LeaderRetrievalService

Returns:

The LeaderRetrievalService specified in the configuration object

Throws:

Exception

createLeaderRetrievalService

public static LeaderRetrievalService createLeaderRetrievalService(org.apache.flink.configuration.Configuration configuration,
                                                                  akka.actor.ActorRef standaloneRef)
                                                           throws Exception

Creates a LeaderRetrievalService that either uses the distributed leader election configured in the configuration, or, in standalone mode, the given actor reference.

Parameters:

configuration - Configuration containing the settings for the LeaderRetrievalService

standaloneRef - Actor reference to be used in standalone mode.

Returns:

The LeaderRetrievalService specified in the configuration object

Throws:

Exception

retrieveLeaderGateway

public static ActorGateway retrieveLeaderGateway(LeaderRetrievalService leaderRetrievalService,
                                                 akka.actor.ActorSystem actorSystem,
                                                 scala.concurrent.duration.FiniteDuration timeout)
                                          throws LeaderRetrievalException

Retrieves the current leader gateway using the given LeaderRetrievalService. If the current leader could not be retrieved after the given timeout, then a LeaderRetrievalException is thrown.

Parameters:

leaderRetrievalService - LeaderRetrievalService which is used for the leader retrieval

actorSystem - ActorSystem which is used for the LeaderRetrievalListener implementation

timeout - Timeout value for the retrieval call

Returns:

The current leader gateway

Throws:

LeaderRetrievalException - If the actor gateway could not be retrieved or the timeout has been exceeded

retrieveLeaderConnectionInfo

public static LeaderConnectionInfo retrieveLeaderConnectionInfo(LeaderRetrievalService leaderRetrievalService,
                                                                scala.concurrent.duration.FiniteDuration timeout)
                                                         throws LeaderRetrievalException

Retrieves the leader akka url and the current leader session ID. The values are stored in a LeaderConnectionInfo instance.

Parameters:

leaderRetrievalService - Leader retrieval service to retrieve the leader connection information

timeout - Timeout when to give up looking for the leader

Returns:

LeaderConnectionInfo containing the leader's akka URL and the current leader session ID

Throws:

LeaderRetrievalException

findConnectingAddress

public static InetAddress findConnectingAddress(LeaderRetrievalService leaderRetrievalService,
                                                scala.concurrent.duration.FiniteDuration timeout)
                                         throws LeaderRetrievalException

Throws:

LeaderRetrievalException

getRecoveryMode

public static RecoveryMode getRecoveryMode(org.apache.flink.configuration.Configuration config)

Gets the recovery mode as configured, based on the ConfigConstants.RECOVERY_MODE config key.

Parameters:

config - The configuration to read the recovery mode from.

Returns:

The recovery mode.

Throws:

org.apache.flink.configuration.IllegalConfigurationException - Thrown, if the recovery mode does not correspond to a known value.