org.apache.flink.runtime.leaderelection

Interface MultipleComponentLeaderElectionDriver

All Known Implementing Classes:

ZooKeeperMultipleComponentLeaderElectionDriver

public interface MultipleComponentLeaderElectionDriver

A leader election driver that allows to write LeaderInformation for multiple components.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MultipleComponentLeaderElectionDriver.Listener Listener interface for state changes of the MultipleComponentLeaderElectionDriver.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the driver.
void	deleteLeaderInformation(String componentId) Deletes the leader information for the given component.
boolean	hasLeadership() Returns whether the driver has currently leadership.
void	publishLeaderInformation(String componentId, LeaderInformation leaderInformation) Publishes the leader information for the given component.

Method Detail

close

void close()
    throws Exception

Closes the driver.

Throws:

Exception - if closing this driver fails

hasLeadership

boolean hasLeadership()

Returns whether the driver has currently leadership.

Returns:

true if the driver has leadership, otherwise false

publishLeaderInformation

void publishLeaderInformation(String componentId,
                              LeaderInformation leaderInformation)
                       throws Exception

Publishes the leader information for the given component.

Parameters:

componentId - identifying the component for which to publish the leader information

leaderInformation - leader information of the respective component

Throws:

Exception - if publishing fails

deleteLeaderInformation

void deleteLeaderInformation(String componentId)
                      throws Exception

Deletes the leader information for the given component.

Parameters:

componentId - identifying the component for which to delete the leader information

Throws:

Exception - if deleting fails