Package org.apache.solr.cluster.placement.impl

Class BalanceRequestImpl

java.lang.Object

org.apache.solr.cluster.placement.impl.BalanceRequestImpl

All Implemented Interfaces:

BalanceRequest, ModificationRequest

public class BalanceRequestImpl
extends Object
implements BalanceRequest

Constructor Summary

Constructors

Constructor	Description
BalanceRequestImpl(Set<Node> nodes)
BalanceRequestImpl(Set<Node> nodes, int maximumBalanceSkew)

Method Summary

Modifier and Type	Method	Description
SolrCollection	getCollection()	The SolrCollection to modify.
int	getMaximumBalanceSkew()
Set<Node>	getNodes()	Replicas should only be balanced on nodes in the set returned by this method.

Methods inherited from class java.lang.Object

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

Constructor Details

BalanceRequestImpl

public BalanceRequestImpl(Set<Node> nodes)

BalanceRequestImpl

public BalanceRequestImpl(Set<Node> nodes,
 int maximumBalanceSkew)

Method Details

getNodes

public Set<Node> getNodes()

Description copied from interface: BalanceRequest

Replicas should only be balanced on nodes in the set returned by this method.

When Collection API calls do not specify a specific set of nodes, replicas can be balanced on all live nodes in the cluster. In such cases, this set will be equal to the set of all live nodes. The plugin placement code does not need to worry (or care) if a set of nodes was explicitly specified or not.

Specified by:

getNodes in interface BalanceRequest

Returns:

never null and never empty set (if that set was to be empty for any reason, no balance would be possible and the Solr infrastructure driving the plugin code would detect the error itself rather than calling the plugin).

getMaximumBalanceSkew

public int getMaximumBalanceSkew()

Specified by:

getMaximumBalanceSkew in interface BalanceRequest

getCollection

public SolrCollection getCollection()

Description copied from interface: ModificationRequest

The SolrCollection to modify.

Specified by:

getCollection in interface ModificationRequest