org.apache.flink.runtime.leaderelection

Class DefaultMultipleComponentLeaderElectionService

java.lang.Object

org.apache.flink.runtime.leaderelection.DefaultMultipleComponentLeaderElectionService

All Implemented Interfaces:

MultipleComponentLeaderElectionDriver.Listener, MultipleComponentLeaderElectionService

public class DefaultMultipleComponentLeaderElectionService
extends Object
implements MultipleComponentLeaderElectionService, MultipleComponentLeaderElectionDriver.Listener

Default implementation of a MultipleComponentLeaderElectionService that allows to register multiple LeaderElectionEventHandler.

Constructor Summary

Constructors

Constructor and Description
DefaultMultipleComponentLeaderElectionService(org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler, MultipleComponentLeaderElectionDriverFactory multipleComponentLeaderElectionDriverFactory)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this service.
LeaderElectionDriverFactory	createDriverFactory(String componentId) Creates a LeaderElectionDriverFactory for the given leader name.
boolean	hasLeadership(String componentId) Returns whether the given component has leadership.
void	isLeader() Callback that is called once the driver obtains the leadership.
void	notifyAllKnownLeaderInformation(Collection<LeaderInformationWithComponentId> leaderInformationWithComponentIds) Notifies the listener about all currently known leader information.
void	notifyLeaderInformationChange(String componentId, LeaderInformation leaderInformation) Notifies the listener about a changed leader information for the given component.
void	notLeader() Callback that is called once the driver loses the leadership.
void	publishLeaderInformation(String componentId, LeaderInformation leaderInformation) Publishes the given leader information for the component identified by the given leader name.
void	registerLeaderElectionEventHandler(String componentId, LeaderElectionEventHandler leaderElectionEventHandler) Registers a new leader election event handler under the given component id.
void	unregisterLeaderElectionEventHandler(String componentId) Unregisters the leader election event handler with the given component id.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMultipleComponentLeaderElectionService

public DefaultMultipleComponentLeaderElectionService(org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler,
                                                     MultipleComponentLeaderElectionDriverFactory multipleComponentLeaderElectionDriverFactory)
                                              throws Exception

Throws:

Exception

Method Detail

close

public void close()
           throws Exception

Description copied from interface: MultipleComponentLeaderElectionService

Closes this service.

Specified by:

close in interface MultipleComponentLeaderElectionService

Throws:

Exception - if the service failed to close

createDriverFactory

public LeaderElectionDriverFactory createDriverFactory(String componentId)

Description copied from interface: MultipleComponentLeaderElectionService

Creates a LeaderElectionDriverFactory for the given leader name.

Specified by:

createDriverFactory in interface MultipleComponentLeaderElectionService

Parameters:

componentId - identifying the component for which to create a leader election driver factory

Returns:

Leader election driver factory

publishLeaderInformation

public void publishLeaderInformation(String componentId,
                                     LeaderInformation leaderInformation)

Description copied from interface: MultipleComponentLeaderElectionService

Publishes the given leader information for the component identified by the given leader name.

Specified by:

publishLeaderInformation in interface MultipleComponentLeaderElectionService

Parameters:

componentId - identifying the component

leaderInformation - leader information

registerLeaderElectionEventHandler

public void registerLeaderElectionEventHandler(String componentId,
                                               LeaderElectionEventHandler leaderElectionEventHandler)

Description copied from interface: MultipleComponentLeaderElectionService

Registers a new leader election event handler under the given component id.

Specified by:

registerLeaderElectionEventHandler in interface MultipleComponentLeaderElectionService

Parameters:

componentId - identifying the leader election event handler

leaderElectionEventHandler - leader election event handler to register

unregisterLeaderElectionEventHandler

public void unregisterLeaderElectionEventHandler(String componentId)
                                          throws Exception

Description copied from interface: MultipleComponentLeaderElectionService

Unregisters the leader election event handler with the given component id.

Specified by:

unregisterLeaderElectionEventHandler in interface MultipleComponentLeaderElectionService

Parameters:

componentId - identifying the component

Throws:

Exception - if the leader election event handler could not be unregistered

hasLeadership

public boolean hasLeadership(String componentId)

Description copied from interface: MultipleComponentLeaderElectionService

Returns whether the given component has leadership.

Specified by:

hasLeadership in interface MultipleComponentLeaderElectionService

Parameters:

componentId - identifying the component

Returns:

true if the component has leadership otherwise false

isLeader

public void isLeader()

Description copied from interface: MultipleComponentLeaderElectionDriver.Listener

Callback that is called once the driver obtains the leadership.

Specified by:

isLeader in interface MultipleComponentLeaderElectionDriver.Listener

notLeader

public void notLeader()

Description copied from interface: MultipleComponentLeaderElectionDriver.Listener

Callback that is called once the driver loses the leadership.

Specified by:

notLeader in interface MultipleComponentLeaderElectionDriver.Listener

notifyLeaderInformationChange

public void notifyLeaderInformationChange(String componentId,
                                          LeaderInformation leaderInformation)

Description copied from interface: MultipleComponentLeaderElectionDriver.Listener

Notifies the listener about a changed leader information for the given component.

Specified by:

notifyLeaderInformationChange in interface MultipleComponentLeaderElectionDriver.Listener

Parameters:

componentId - identifying the component whose leader information has changed

leaderInformation - new leader information

notifyAllKnownLeaderInformation

public void notifyAllKnownLeaderInformation(Collection<LeaderInformationWithComponentId> leaderInformationWithComponentIds)

Description copied from interface: MultipleComponentLeaderElectionDriver.Listener

Notifies the listener about all currently known leader information.

Specified by:

notifyAllKnownLeaderInformation in interface MultipleComponentLeaderElectionDriver.Listener

Parameters:

leaderInformationWithComponentIds - leader information with component ids