001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.master.normalizer;
020
021import org.apache.hadoop.hbase.master.MasterServices;
022import org.apache.yetus.audience.InterfaceAudience;
023import java.io.IOException;
024
025/**
026 * Interface for normalization plan.
027 */
028@InterfaceAudience.Private
029public interface NormalizationPlan {
030  enum PlanType {
031    SPLIT,
032    MERGE,
033    NONE
034  }
035
036  /**
037   * Submits normalization plan on cluster (does actual splitting/merging work) and
038   * returns proc Id to caller.
039   * @param masterServices instance of {@link MasterServices}
040   * @return Proc Id for the submitted task
041   * @throws IOException If plan submission to Admin fails
042   */
043  long submit(MasterServices masterServices) throws IOException;
044
045  /**
046   * @return the type of this plan
047   */
048  PlanType getType();
049}