pivotal-jbarrett commented on a change in pull request #4909: URL: https://github.com/apache/geode/pull/4909#discussion_r412469554
########## File path: geode-core/src/main/java/org/apache/geode/cache/control/RestoreRedundancyResults.java ########## @@ -0,0 +1,148 @@ +/* + * 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.geode.cache.control; + +import java.util.Map; + +import org.apache.geode.cache.partition.PartitionRebalanceInfo; +import org.apache.geode.internal.cache.control.RegionRedundancyStatus; +import org.apache.geode.internal.cache.partitioned.PartitionedRegionRebalanceOp; + +/** + * A class to collect the results of restore redundancy operations for one or more regions and + * determine the success of failure of the operation. + */ +public interface RestoreRedundancyResults { + + /** + * {@link #SUCCESS} is defined as every included region having fully satisfied redundancy. + * {@link #FAILURE} is defined as at least one region that is configured to have redundant copies + * having fewer than its configured number of redundant copies. + * {@link #ERROR} is for cases when the restore redundancy operation was unable to begin or threw + * an exception. + */ + enum Status { + SUCCESS, + FAILURE, + ERROR + } + + /** + * Adds the contents of another {@link RestoreRedundancyResults} object to this one, including + * both {@link RegionRedundancyStatus} objects and information on the number of primaries + * reassigned and the time taken to reassign them. + * + * @param results a {@link RestoreRedundancyResults} object whose contents will be added to this + * one. + */ + void addRegionResults(RestoreRedundancyResults results); + + /** + * Adds information regarding the number of primaries reassigned and the time taken to reassign + * them during a restore redundancy operation. + * + * @param details a {@link PartitionRebalanceInfo} generated by a + * {@link PartitionedRegionRebalanceOp} operation. Review comment: Perhaps this is the opportunity to start a `geode-control-api.jar` that contains all these interfaces. We have to start somewhere and this seems like a good small start. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
