org.apache.flink.runtime.leaderelection

Class StandaloneLeaderElectionService

java.lang.Object

org.apache.flink.runtime.leaderelection.StandaloneLeaderElectionService

All Implemented Interfaces:

LeaderElectionService

public class StandaloneLeaderElectionService
extends Object
implements LeaderElectionService

Standalone implementation of the LeaderElectionService interface. The standalone implementation assumes that there is only a single LeaderContender and thus directly grants him the leadership upon start up. Furthermore, there is no communication needed between multiple standalone leader election services.

Constructor Summary

Constructors

Constructor and Description
StandaloneLeaderElectionService()

Method Summary

Modifier and Type	Method and Description
void	confirmLeaderSessionID(UUID leaderSessionID) Confirms that the new leader session ID has been successfully received by the new leader.
boolean	hasLeadership() Returns true if the LeaderContender with which the service has been started owns currently the leadership.
void	start(LeaderContender newContender) Starts the leader election service.
void	stop() Stops the leader election service.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneLeaderElectionService

public StandaloneLeaderElectionService()

Method Detail

start

public void start(LeaderContender newContender)
           throws Exception

Description copied from interface: LeaderElectionService

Starts the leader election service. This method can only be called once.

Specified by:

start in interface LeaderElectionService

Parameters:

newContender - LeaderContender which applies for the leadership

Throws:

Exception

stop

public void stop()

Description copied from interface: LeaderElectionService

Stops the leader election service.

Specified by:

stop in interface LeaderElectionService

confirmLeaderSessionID

public void confirmLeaderSessionID(UUID leaderSessionID)

Description copied from interface: LeaderElectionService

Confirms that the new leader session ID has been successfully received by the new leader. This method is usually called by the newly appointed LeaderContender. The rational behind this method is to establish an order between setting the new leader session ID in the LeaderContender and publishing the new leader session ID to the leader retrieval services.

Specified by:

confirmLeaderSessionID in interface LeaderElectionService

Parameters:

leaderSessionID - The new leader session ID

hasLeadership

public boolean hasLeadership()

Description copied from interface: LeaderElectionService

Returns true if the LeaderContender with which the service has been started owns currently the leadership.

Specified by:

hasLeadership in interface LeaderElectionService

Returns:

true if the associated LeaderContender is the leader, otherwise false