org.apache.flink.runtime.leaderelection

Interface MultipleComponentLeaderElectionService

All Known Implementing Classes:

DefaultMultipleComponentLeaderElectionService

public interface MultipleComponentLeaderElectionService

Leader election service that allows to register multiple LeaderElectionEventHandlers that are identified by different names. For each event handler it is possible to write the corresponding LeaderInformation.

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

Method Detail

close

void close()
    throws Exception

Closes this service.

Throws:

Exception - if the service failed to close

createDriverFactory

LeaderElectionDriverFactory createDriverFactory(String componentId)

Creates a LeaderElectionDriverFactory for the given leader name.

Parameters:

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

Returns:

Leader election driver factory

publishLeaderInformation

void publishLeaderInformation(String componentId,
                              LeaderInformation leaderInformation)

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

Parameters:

componentId - identifying the component

leaderInformation - leader information

registerLeaderElectionEventHandler

void registerLeaderElectionEventHandler(String componentId,
                                        LeaderElectionEventHandler leaderElectionEventHandler)

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

Parameters:

componentId - identifying the leader election event handler

leaderElectionEventHandler - leader election event handler to register

Throws:

IllegalArgumentException - if there is already a handler registered for the given component id

unregisterLeaderElectionEventHandler

void unregisterLeaderElectionEventHandler(String componentId)
                                   throws Exception

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

Parameters:

componentId - identifying the component

Throws:

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

hasLeadership

boolean hasLeadership(String componentId)

Returns whether the given component has leadership.

Parameters:

componentId - identifying the component

Returns:

true if the component has leadership otherwise false