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 edu.umd.cs.findbugs.annotations.Nullable;
021import java.io.IOException;
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
027/**
028 * Request a compaction.
029 */
030@InterfaceAudience.Private
031public interface CompactionRequester {
032
033  /**
034   * Request compaction on all the stores of the given region.
035   */
036  void requestCompaction(HRegion region, String why, int priority,
037    CompactionLifeCycleTracker tracker, @Nullable User user) throws IOException;
038
039  /**
040   * Request compaction on the given store.
041   */
042  void requestCompaction(HRegion region, HStore store, String why, int priority,
043    CompactionLifeCycleTracker tracker, @Nullable User user) throws IOException;
044
045  /**
046   * Request system compaction on the given store.
047   */
048  void requestSystemCompaction(HRegion region, HStore store, String why,
049    boolean giveUpIfRequestedOrCompacting) throws IOException;
050
051  /**
052   * on/off compaction
053   */
054  void switchCompaction(boolean onOrOff);
055
056}