org.apache.bookkeeper.client

Interface ITopologyAwareEnsemblePlacementPolicy<T extends org.apache.bookkeeper.net.Node>

All Superinterfaces:

EnsemblePlacementPolicy

All Known Implementing Classes:

RackawareEnsemblePlacementPolicy, RackawareEnsemblePlacementPolicyImpl, RegionAwareEnsemblePlacementPolicy, TopologyAwareEnsemblePlacementPolicy, ZoneawareEnsemblePlacementPolicy, ZoneawareEnsemblePlacementPolicyImpl

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface ITopologyAwareEnsemblePlacementPolicy<T extends org.apache.bookkeeper.net.Node>
extends EnsemblePlacementPolicy

Interface for topology aware ensemble placement policy.

All the implementations of this interface are using NetworkTopology for placing ensembles.

See Also:

EnsemblePlacementPolicy

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ITopologyAwareEnsemblePlacementPolicy.Ensemble<T extends org.apache.bookkeeper.net.Node> Ensemble used to hold the result of an ensemble selected for placement.
static interface	ITopologyAwareEnsemblePlacementPolicy.Predicate<T extends org.apache.bookkeeper.net.Node> Predicate used when choosing an ensemble.

Nested classes/interfaces inherited from interface org.apache.bookkeeper.client.EnsemblePlacementPolicy

EnsemblePlacementPolicy.PlacementPolicyAdherence, EnsemblePlacementPolicy.PlacementResult<T>

Method Summary

Modifier and Type	Method and Description
void	handleBookiesThatJoined(java.util.Set<org.apache.bookkeeper.net.BookieId> joinedBookies) Handle bookies that joined.
void	handleBookiesThatLeft(java.util.Set<org.apache.bookkeeper.net.BookieId> leftBookies) Handle bookies that left.
EnsemblePlacementPolicy.PlacementResult<java.util.List<org.apache.bookkeeper.net.BookieId>>	newEnsemble(int ensembleSize, int writeQuorumSize, int ackQuorumSize, java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies, ITopologyAwareEnsemblePlacementPolicy.Ensemble<T> parentEnsemble, ITopologyAwareEnsemblePlacementPolicy.Predicate<T> parentPredicate) Create an ensemble with parent ensemble.
void	onBookieRackChange(java.util.List<org.apache.bookkeeper.net.BookieId> bookieAddressList) Handle rack change for the bookies.
T	selectFromNetworkLocation(java.util.Set<java.lang.String> excludeRacks, java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies, ITopologyAwareEnsemblePlacementPolicy.Predicate<org.apache.bookkeeper.net.BookieNode> predicate, ITopologyAwareEnsemblePlacementPolicy.Ensemble<org.apache.bookkeeper.net.BookieNode> ensemble, boolean fallbackToRandom) Select a node from cluster excluding excludeBookies and bookie nodes of excludeRacks.
T	selectFromNetworkLocation(java.lang.String networkLoc, java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies, ITopologyAwareEnsemblePlacementPolicy.Predicate<T> predicate, ITopologyAwareEnsemblePlacementPolicy.Ensemble<T> ensemble, boolean fallbackToRandom) Select a node from a given network location.
T	selectFromNetworkLocation(java.lang.String networkLoc, java.util.Set<java.lang.String> excludeRacks, java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies, ITopologyAwareEnsemblePlacementPolicy.Predicate<org.apache.bookkeeper.net.BookieNode> predicate, ITopologyAwareEnsemblePlacementPolicy.Ensemble<org.apache.bookkeeper.net.BookieNode> ensemble, boolean fallbackToRandom) Select a node from networkLoc rack excluding excludeBookies.

Methods inherited from interface org.apache.bookkeeper.client.EnsemblePlacementPolicy

areAckedBookiesAdheringToPlacementPolicy, getStickyReadBookieIndex, initialize, isEnsembleAdheringToPlacementPolicy, newEnsemble, onClusterChanged, registerSlowBookie, reorderReadLACSequence, reorderReadSequence, replaceBookie, uninitalize, updateBookieInfo

Method Detail

newEnsemble

EnsemblePlacementPolicy.PlacementResult<java.util.List<org.apache.bookkeeper.net.BookieId>> newEnsemble(int ensembleSize,
                                                                                                        int writeQuorumSize,
                                                                                                        int ackQuorumSize,
                                                                                                        java.util.Set<org.apache.bookkeeper.net.BookieId> excludeBookies,
                                                                                                        ITopologyAwareEnsemblePlacementPolicy.Ensemble<T> parentEnsemble,
                                                                                                        ITopologyAwareEnsemblePlacementPolicy.Predicate<T> parentPredicate)
                                                                                                 throws BKException.BKNotEnoughBookiesException

Create an ensemble with parent ensemble.

Parameters:

ensembleSize - ensemble size

writeQuorumSize - write quorum size

ackQuorumSize - ack quorum size

excludeBookies - exclude bookies

parentEnsemble - parent ensemble

Returns:

list of bookies forming the ensemble

Throws:

BKException.BKNotEnoughBookiesException

selectFromNetworkLocation

T selectFromNetworkLocation(java.lang.String networkLoc,
                            java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies,
                            ITopologyAwareEnsemblePlacementPolicy.Predicate<T> predicate,
                            ITopologyAwareEnsemblePlacementPolicy.Ensemble<T> ensemble,
                            boolean fallbackToRandom)
                     throws BKException.BKNotEnoughBookiesException

Select a node from a given network location.

Parameters:

networkLoc - network location

excludeBookies - exclude bookies set

predicate - predicate to apply

ensemble - ensemble

fallbackToRandom - fallbackToRandom

Returns:

the selected bookie.

Throws:

BKException.BKNotEnoughBookiesException

selectFromNetworkLocation

T selectFromNetworkLocation(java.util.Set<java.lang.String> excludeRacks,
                            java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies,
                            ITopologyAwareEnsemblePlacementPolicy.Predicate<org.apache.bookkeeper.net.BookieNode> predicate,
                            ITopologyAwareEnsemblePlacementPolicy.Ensemble<org.apache.bookkeeper.net.BookieNode> ensemble,
                            boolean fallbackToRandom)
                     throws BKException.BKNotEnoughBookiesException

Select a node from cluster excluding excludeBookies and bookie nodes of excludeRacks. If there isn't a BookieNode excluding those racks and nodes, then if fallbackToRandom is set to true then pick a random node from cluster just excluding excludeBookies.

Parameters:

excludeRacks -

excludeBookies -

predicate -

ensemble -

fallbackToRandom -

Returns:

Throws:

BKException.BKNotEnoughBookiesException

selectFromNetworkLocation

T selectFromNetworkLocation(java.lang.String networkLoc,
                            java.util.Set<java.lang.String> excludeRacks,
                            java.util.Set<org.apache.bookkeeper.net.Node> excludeBookies,
                            ITopologyAwareEnsemblePlacementPolicy.Predicate<org.apache.bookkeeper.net.BookieNode> predicate,
                            ITopologyAwareEnsemblePlacementPolicy.Ensemble<org.apache.bookkeeper.net.BookieNode> ensemble,
                            boolean fallbackToRandom)
                     throws BKException.BKNotEnoughBookiesException

Select a node from networkLoc rack excluding excludeBookies. If there isn't any node in 'networkLoc', then it will try to get a node from cluster excluding excludeRacks and excludeBookies. If fallbackToRandom is set to true then it will get a random bookie from cluster excluding excludeBookies if it couldn't find a bookie

Parameters:

networkLoc -

excludeRacks -

excludeBookies -

predicate -

ensemble -

fallbackToRandom -

Returns:

Throws:

BKException.BKNotEnoughBookiesException

handleBookiesThatLeft

void handleBookiesThatLeft(java.util.Set<org.apache.bookkeeper.net.BookieId> leftBookies)

Handle bookies that left.

Parameters:

leftBookies - bookies that left

handleBookiesThatJoined

void handleBookiesThatJoined(java.util.Set<org.apache.bookkeeper.net.BookieId> joinedBookies)

Handle bookies that joined.

Parameters:

joinedBookies - bookies that joined.

onBookieRackChange

void onBookieRackChange(java.util.List<org.apache.bookkeeper.net.BookieId> bookieAddressList)

Handle rack change for the bookies.

Parameters:

bookieAddressList -