org.apache.flink.runtime.leaderelection

类 DefaultLeaderElectionService

java.lang.Object

org.apache.flink.runtime.leaderelection.DefaultLeaderElectionService

所有已实现的接口:

AutoCloseable, LeaderElectionDriver.Listener, LeaderElectionService

public class DefaultLeaderElectionService
extends Object
implements LeaderElectionService, LeaderElectionDriver.Listener, AutoCloseable

Default implementation for leader election service. Composed with different LeaderElectionDriver, we could perform a leader election for the contender, and then persist the leader information to various storage.

DefaultLeaderElectionService handles a single LeaderContender.

构造器概要

构造器

构造器和说明
DefaultLeaderElectionService(LeaderElectionDriverFactory leaderElectionDriverFactory)
DefaultLeaderElectionService(LeaderElectionDriverFactory leaderElectionDriverFactory, org.apache.flink.runtime.rpc.FatalErrorHandler fallbackErrorHandler)

方法概要

限定符和类型	方法和说明
void	close()
protected void	confirmLeadership(String componentId, UUID leaderSessionID, String leaderAddress) Confirms the leadership with the leaderSessionID and leaderAddress for the LeaderContender that is associated with the componentId.
LeaderElection	createLeaderElection(String componentId) Creates a new LeaderElection instance that is registered to this LeaderElectionService instance.
UUID	getLeaderSessionID(String componentId) Returns the current leader session ID for the given componentId or null, if the session wasn't confirmed.
protected boolean	hasLeadership(String componentId, UUID leaderSessionId) Checks whether the ParentService has the leadership acquired for the componentId and leaderSessionID.
void	onError(Throwable t) Notifies the listener if an error occurred.
void	onGrantLeadership(UUID leaderSessionID) Callback that is called once the driver obtains the leadership.
void	onLeaderInformationChange(LeaderInformationRegister changedLeaderInformation) Notifies the listener about all currently known leader information.
void	onLeaderInformationChange(String componentId, LeaderInformation leaderInformation) Notifies the listener about a changed leader information for the given component.
void	onRevokeLeadership() Callback that is called once the driver loses the leadership.
protected void	register(String componentId, LeaderContender contender) Registers the LeaderContender under the componentId with the underlying ParentService.
protected void	remove(String componentId) Removes the LeaderContender from the ParentService that is associated with the componentId.

从类继承的方法 java.lang.Object

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

构造器详细资料

DefaultLeaderElectionService

public DefaultLeaderElectionService(LeaderElectionDriverFactory leaderElectionDriverFactory)

DefaultLeaderElectionService

@VisibleForTesting
public DefaultLeaderElectionService(LeaderElectionDriverFactory leaderElectionDriverFactory,
                                                       org.apache.flink.runtime.rpc.FatalErrorHandler fallbackErrorHandler)

方法详细资料

createLeaderElection

public LeaderElection createLeaderElection(String componentId)

从接口复制的说明: LeaderElectionService

Creates a new LeaderElection instance that is registered to this LeaderElectionService instance.

指定者:

createLeaderElection 在接口中 LeaderElectionService

参数:

componentId - a unique identifier that refers to the stored leader information that the newly created LeaderElection manages.

register

protected void register(String componentId,
                        LeaderContender contender)
                 throws Exception

Registers the LeaderContender under the componentId with the underlying ParentService. Leadership changes are starting to be reported to the LeaderContender.

抛出:

Exception

remove

protected final void remove(String componentId)
                     throws Exception

Removes the LeaderContender from the ParentService that is associated with the componentId.

抛出:

Exception

close

public void close()
           throws Exception

指定者:

close 在接口中 AutoCloseable

抛出:

Exception

confirmLeadership

protected void confirmLeadership(String componentId,
                                 UUID leaderSessionID,
                                 String leaderAddress)

Confirms the leadership with the leaderSessionID and leaderAddress for the LeaderContender that is associated with the componentId.

hasLeadership

protected boolean hasLeadership(String componentId,
                                UUID leaderSessionId)

Checks whether the ParentService has the leadership acquired for the componentId and leaderSessionID.

返回:

true if the service has leadership with the passed leaderSessionID acquired; false otherwise.

getLeaderSessionID

@VisibleForTesting
 @Nullable
public UUID getLeaderSessionID(String componentId)

Returns the current leader session ID for the given componentId or null, if the session wasn't confirmed.

onGrantLeadership

public void onGrantLeadership(UUID leaderSessionID)

从接口复制的说明: LeaderElectionDriver.Listener

Callback that is called once the driver obtains the leadership.

指定者:

onGrantLeadership 在接口中 LeaderElectionDriver.Listener

onRevokeLeadership

public void onRevokeLeadership()

从接口复制的说明: LeaderElectionDriver.Listener

Callback that is called once the driver loses the leadership.

指定者:

onRevokeLeadership 在接口中 LeaderElectionDriver.Listener

onLeaderInformationChange

public void onLeaderInformationChange(String componentId,
                                      LeaderInformation leaderInformation)

从接口复制的说明: LeaderElectionDriver.Listener

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

指定者:

onLeaderInformationChange 在接口中 LeaderElectionDriver.Listener

参数:

componentId - identifying the component whose leader information has changed

leaderInformation - new leader information

onLeaderInformationChange

public void onLeaderInformationChange(LeaderInformationRegister changedLeaderInformation)

从接口复制的说明: LeaderElectionDriver.Listener

Notifies the listener about all currently known leader information.

指定者:

onLeaderInformationChange 在接口中 LeaderElectionDriver.Listener

onError

public void onError(Throwable t)

从接口复制的说明: LeaderElectionDriver.Listener

Notifies the listener if an error occurred.

指定者:

onError 在接口中 LeaderElectionDriver.Listener