001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver.compactions;
019
020import java.io.IOException;
021
022import org.apache.hadoop.hbase.regionserver.HRegion;
023import org.apache.hadoop.hbase.regionserver.HStore;
024import org.apache.hadoop.hbase.security.User;
025import org.apache.yetus.audience.InterfaceAudience;
026
027import edu.umd.cs.findbugs.annotations.Nullable;
028
029/**
030 * Request a compaction.
031 */
032@InterfaceAudience.Private
033public interface CompactionRequester {
034
035  /**
036   * Request compaction on all the stores of the given region.
037   */
038  void requestCompaction(HRegion region, String why, int priority,
039      CompactionLifeCycleTracker tracker, @Nullable User user) throws IOException;
040
041  /**
042   * Request compaction on the given store.
043   */
044  void requestCompaction(HRegion region, HStore store, String why, int priority,
045      CompactionLifeCycleTracker tracker, @Nullable User user) throws IOException;
046
047  /**
048   * on/off compaction
049   */
050  void switchCompaction(boolean onOrOff);
051
052}