Package org.apache.pulsar.broker.loadbalance.extensions.channel

Class ServiceUnitStateChannelImpl

java.lang.Object

org.apache.pulsar.broker.loadbalance.extensions.channel.ServiceUnitStateChannelImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ServiceUnitStateChannel

public class ServiceUnitStateChannelImpl
extends Object
implements ServiceUnitStateChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServiceUnitStateChannelImpl.Counters
static enum	ServiceUnitStateChannelImpl.EventType

Field Summary

Fields

Modifier and Type	Field	Description
static final long	MAX_CLEAN_UP_DELAY_TIME_IN_SECS
static final long	VERSION_ID_INIT

Constructor Summary

Constructors

Constructor	Description
ServiceUnitStateChannelImpl(PulsarService pulsar)

Method Summary

Modifier and Type	Method	Description
void	cancelOwnershipMonitor()	Cancels the ownership monitor.
void	cleanOwnerships()	Cleans(gives up) any service unit ownerships from this broker.
void	close()	Closes the ServiceUnitStateChannel.
protected void	disable()
protected void	enable()
static ServiceUnitStateChannel	get(PulsarService pulsar)
Optional<String>	getAssigned(String serviceUnit)	Asynchronously gets the assigned broker of the service unit.
protected BrokerRegistry	getBrokerRegistry()
CompletableFuture<Optional<String>>	getChannelOwnerAsync()	Asynchronously gets the current owner broker of this channel.
protected LoadManagerContext	getContext()
protected LeaderElectionService	getLeaderElectionService()
protected ExtensibleLoadManagerImpl	getLoadManager()
List<org.apache.pulsar.common.stats.Metrics>	getMetrics()	Generates the metrics to monitor.
Set<NamespaceBundle>	getOwnedServiceUnits()	Asynchronously returns service units owned by this broker.
CompletableFuture<Optional<String>>	getOwnerAsync(String serviceUnit)	Case 1: If the service unit is owned, it returns the completed future object with the current owner.
Set<Map.Entry<String,ServiceUnitStateData>>	getOwnershipEntrySet()	Asynchronously returns service unit ownership entry set.
protected PulsarAdmin	getPulsarAdmin()
protected void	handleBrokerRegistrationEvent(String broker, org.apache.pulsar.metadata.api.NotificationType type)	Case 1: If NotificationType is Deleted, it will schedule a clean-up operation to release the ownerships of the deleted broker.
protected void	handleMetadataSessionEvent(org.apache.pulsar.metadata.api.extended.SessionEvent e)	The stability of the metadata connection is important to determine how to handle the broker deletion(unavailable) event notified from the metadata store.
boolean	isChannelOwner()	Checks if the current broker is the owner broker of this channel.
CompletableFuture<Boolean>	isChannelOwnerAsync()	Asynchronously checks if the current broker is the owner broker of this channel.
boolean	isOwner(String serviceUnit)	Checks if the current broker is the owner of the service unit.
boolean	isOwner(String serviceUnit, String targetBrokerId)	Checks if the target broker is the owner of the service unit.
void	listen(StateChangeListener listener)	Adds a state change listener.
protected void	monitorOwnerships(List<String> brokers)
CompletableFuture<String>	publishAssignEventAsync(String serviceUnit, String brokerId)	Asynchronously publishes the service unit assignment event to this channel.
CompletableFuture<Void>	publishSplitEventAsync(Split split)	Asynchronously publishes the bundle split event to this channel.
CompletableFuture<Void>	publishUnloadEventAsync(Unload unload)	Asynchronously publishes the service unit unload event to this channel.
void	scheduleOwnershipMonitor()	Schedules ownership monitor to periodically check and correct invalid ownership states.
protected void	splitServiceUnitOnceAndRetry(NamespaceService namespaceService, NamespaceBundleFactory bundleFactory, NamespaceBundleSplitAlgorithm algorithm, NamespaceBundle parentBundle, List<NamespaceBundle> childBundles, List<Long> boundaries, ServiceUnitStateData parentData, AtomicInteger counter, long startTime, CompletableFuture<Void> completionFuture)
void	start()	Starts the ServiceUnitStateChannel.
boolean	started()	Whether the channel started.

Methods inherited from class java.lang.Object

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

Field Details

VERSION_ID_INIT

public static final long VERSION_ID_INIT

See Also:

• Constant Field Values

MAX_CLEAN_UP_DELAY_TIME_IN_SECS

public static final long MAX_CLEAN_UP_DELAY_TIME_IN_SECS

See Also:

• Constant Field Values

Constructor Details

ServiceUnitStateChannelImpl

public ServiceUnitStateChannelImpl(PulsarService pulsar)

Method Details

scheduleOwnershipMonitor

public void scheduleOwnershipMonitor()

Description copied from interface: ServiceUnitStateChannel

Schedules ownership monitor to periodically check and correct invalid ownership states.

Specified by:

scheduleOwnershipMonitor in interface ServiceUnitStateChannel

cancelOwnershipMonitor

public void cancelOwnershipMonitor()

Description copied from interface: ServiceUnitStateChannel

Cancels the ownership monitor.

Specified by:

cancelOwnershipMonitor in interface ServiceUnitStateChannel

cleanOwnerships

public void cleanOwnerships()

Description copied from interface: ServiceUnitStateChannel

Cleans(gives up) any service unit ownerships from this broker.

Specified by:

cleanOwnerships in interface ServiceUnitStateChannel

started

public boolean started()

Description copied from interface: ServiceUnitStateChannel

Whether the channel started.

Specified by:

started in interface ServiceUnitStateChannel

start

public void start()
           throws PulsarServerException

Description copied from interface: ServiceUnitStateChannel

Starts the ServiceUnitStateChannel.

Specified by:

start in interface ServiceUnitStateChannel

Throws:

PulsarServerException - if it fails to start the channel.

getBrokerRegistry

protected BrokerRegistry getBrokerRegistry()

getContext

protected LoadManagerContext getContext()

getLoadManager

protected ExtensibleLoadManagerImpl getLoadManager()

getLeaderElectionService

protected LeaderElectionService getLeaderElectionService()

getPulsarAdmin

protected PulsarAdmin getPulsarAdmin()
                              throws PulsarServerException

Throws:

PulsarServerException

close

public void close()
           throws PulsarServerException

Description copied from interface: ServiceUnitStateChannel

Closes the ServiceUnitStateChannel.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ServiceUnitStateChannel

Throws:

PulsarServerException - if it fails to close the channel.

getChannelOwnerAsync

public CompletableFuture<Optional<String>> getChannelOwnerAsync()

Description copied from interface: ServiceUnitStateChannel

Asynchronously gets the current owner broker of this channel.

Specified by:

getChannelOwnerAsync in interface ServiceUnitStateChannel

Returns:

a future of owner brokerId to track the completion of the operation

isChannelOwnerAsync

public CompletableFuture<Boolean> isChannelOwnerAsync()

Description copied from interface: ServiceUnitStateChannel

Asynchronously checks if the current broker is the owner broker of this channel.

Specified by:

isChannelOwnerAsync in interface ServiceUnitStateChannel

Returns:

a future of check result to track the completion of the operation

isChannelOwner

public boolean isChannelOwner()
                       throws ExecutionException,
InterruptedException,
TimeoutException

Description copied from interface: ServiceUnitStateChannel

Checks if the current broker is the owner broker of this channel.

Specified by:

isChannelOwner in interface ServiceUnitStateChannel

Returns:

True if the current broker is the owner. Otherwise, false.

Throws:

ExecutionException

InterruptedException

TimeoutException

isOwner

public boolean isOwner(String serviceUnit,
 String targetBrokerId)

Description copied from interface: ServiceUnitStateChannel

Checks if the target broker is the owner of the service unit.

Specified by:

isOwner in interface ServiceUnitStateChannel

Parameters:

serviceUnit - (e.g. bundle)

Returns:

true if the target brokerId is the owner brokerId. false if unknown.

isOwner

public boolean isOwner(String serviceUnit)

Description copied from interface: ServiceUnitStateChannel

Checks if the current broker is the owner of the service unit.

Specified by:

isOwner in interface ServiceUnitStateChannel

Parameters:

serviceUnit - (e.g. bundle))

Returns:

true if the current broker is the owner. false if unknown.

getOwnerAsync

public CompletableFuture<Optional<String>> getOwnerAsync(String serviceUnit)

Case 1: If the service unit is owned, it returns the completed future object with the current owner. Case 2: If the service unit's assignment is ongoing, it returns the non-completed future object. Sub-case1: If the assigned broker is available and finally takes the ownership, the future object will complete and return the owner broker. Sub-case2: If the assigned broker does not take the ownership in time, the future object will time out. Case 3: If none of them, it returns Optional.empty().

Specified by:

getOwnerAsync in interface ServiceUnitStateChannel

Parameters:

serviceUnit - (e.g. bundle)

Returns:

a future of owner brokerId to track the completion of the operation

getAssigned

public Optional<String> getAssigned(String serviceUnit)

Description copied from interface: ServiceUnitStateChannel

Asynchronously gets the assigned broker of the service unit.

Specified by:

getAssigned in interface ServiceUnitStateChannel

Parameters:

serviceUnit - (e.g. bundle))

Returns:

assigned brokerId

publishAssignEventAsync

public CompletableFuture<String> publishAssignEventAsync(String serviceUnit,
 String brokerId)

Description copied from interface: ServiceUnitStateChannel

Asynchronously publishes the service unit assignment event to this channel.

Specified by:

publishAssignEventAsync in interface ServiceUnitStateChannel

Parameters:

serviceUnit - (e.g bundle)

brokerId - the assigned brokerId

Returns:

a future of owner brokerId to track the completion of the operation

publishUnloadEventAsync

public CompletableFuture<Void> publishUnloadEventAsync(Unload unload)

Description copied from interface: ServiceUnitStateChannel

Asynchronously publishes the service unit unload event to this channel.

Specified by:

publishUnloadEventAsync in interface ServiceUnitStateChannel

Parameters:

unload - (unload specification object)

Returns:

a future to track the completion of the operation

publishSplitEventAsync

public CompletableFuture<Void> publishSplitEventAsync(Split split)

Description copied from interface: ServiceUnitStateChannel

Asynchronously publishes the bundle split event to this channel.

Specified by:

publishSplitEventAsync in interface ServiceUnitStateChannel

Parameters:

split - (split specification object)

Returns:

a future to track the completion of the operation

splitServiceUnitOnceAndRetry

protected void splitServiceUnitOnceAndRetry(NamespaceService namespaceService,
 NamespaceBundleFactory bundleFactory,
 NamespaceBundleSplitAlgorithm algorithm,
 NamespaceBundle parentBundle,
 List<NamespaceBundle> childBundles,
 List<Long> boundaries,
 ServiceUnitStateData parentData,
 AtomicInteger counter,
 long startTime,
 CompletableFuture<Void> completionFuture)

handleMetadataSessionEvent

protected void handleMetadataSessionEvent(org.apache.pulsar.metadata.api.extended.SessionEvent e)

The stability of the metadata connection is important to determine how to handle the broker deletion(unavailable) event notified from the metadata store.

handleBrokerRegistrationEvent

protected void handleBrokerRegistrationEvent(String broker,
 org.apache.pulsar.metadata.api.NotificationType type)

Case 1: If NotificationType is Deleted, it will schedule a clean-up operation to release the ownerships of the deleted broker. Sub-case1: If the metadata connection has been stable for long time, it will immediately execute the cleanup operation to guarantee high-availability. Sub-case2: If the metadata connection has been stable only for short time, it will defer the clean-up operation for some time and execute it. This is to gracefully handle the case when metadata connection is flaky -- If the deleted broker comes back very soon, we better cancel the clean-up operation for high-availability. Sub-case3: If the metadata connection is unstable, it will not schedule the clean-up operation, as the broker-metadata connection is lost. The brokers will continue to serve existing topics connections, and we better not to interrupt the existing topic connections for high-availability. Case 2: If NotificationType is Created, it will cancel any scheduled clean-up operation if still not executed.

monitorOwnerships

protected void monitorOwnerships(List<String> brokers)

getMetrics

public List<org.apache.pulsar.common.stats.Metrics> getMetrics()

Description copied from interface: ServiceUnitStateChannel

Generates the metrics to monitor.

Specified by:

getMetrics in interface ServiceUnitStateChannel

Returns:

a list of the metrics

listen

public void listen(StateChangeListener listener)

Description copied from interface: ServiceUnitStateChannel

Adds a state change listener.

Specified by:

listen in interface ServiceUnitStateChannel

Parameters:

listener - State change listener.

getOwnershipEntrySet

public Set<Map.Entry<String,ServiceUnitStateData>> getOwnershipEntrySet()

Description copied from interface: ServiceUnitStateChannel

Asynchronously returns service unit ownership entry set.

Specified by:

getOwnershipEntrySet in interface ServiceUnitStateChannel

Returns:

a set of service unit ownership entries to track the completion of the operation

getOwnedServiceUnits

public Set<NamespaceBundle> getOwnedServiceUnits()

Description copied from interface: ServiceUnitStateChannel

Asynchronously returns service units owned by this broker.

Specified by:

getOwnedServiceUnits in interface ServiceUnitStateChannel

Returns:

a set of owned service units to track the completion of the operation

get

public static ServiceUnitStateChannel get(PulsarService pulsar)

disable

protected void disable()

enable

protected void enable()