Package org.apache.solr.cluster.placement

Interface BalancePlan

public interface BalancePlan

A fully specified plan or instructions for replica balancing to be applied to the cluster.

Fully specified means the actual Node's on which to place replicas have been decided.

Instances are created by plugin code using BalancePlanFactory. This interface obviously doesn't expose much but the underlying Solr side implementation has all that is needed (and will do at least one cast in order to execute the plan, likely then using some type of visitor pattern).

Method Summary

Modifier and Type	Method	Description
Map<Replica,Node>	getReplicaMovements()
BalanceRequest	getRequest()

Method Details

getRequest

BalanceRequest getRequest()

Returns:

the BalanceRequest at the origin of this BalancePlan, as passed to the BalancePlanFactory method that created this instance.

getReplicaMovements

Map<Replica,Node> getReplicaMovements()

Returns:

the map of Replica's to the ReplicaPlacement's that describe where the replica should be placed.