org.apache.solr.cluster.placement.BalancePlan Maven / Gradle / Ivy
Show all versions of solr-core Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.cluster.placement;
import java.util.Map;
import org.apache.solr.cluster.Node;
import org.apache.solr.cluster.Replica;
/**
* A fully specified plan or instructions for replica balancing to be applied to the cluster.
*
* Fully specified means the actual {@link Node}'s on which to place replicas have been decided.
*
*
Instances are created by plugin code using {@link 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).
*/
public interface BalancePlan {
/**
* @return the {@link BalanceRequest} at the origin of this {@link BalancePlan}, as passed to the
* {@link BalancePlanFactory} method that created this instance.
*/
BalanceRequest getRequest();
/**
* @return the map of {@link Replica}'s to the {@link ReplicaPlacement}'s that describe where the
* replica should be placed.
*/
Map getReplicaMovements();
}