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 org.apache.hadoop.hbase.HBaseInterfaceAudience;
021import org.apache.hadoop.hbase.regionserver.Store;
022import org.apache.yetus.audience.InterfaceAudience;
023import org.apache.yetus.audience.InterfaceStability;
024
025/**
026 * Used to track compaction execution.
027 */
028@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
029@InterfaceStability.Evolving
030public interface CompactionLifeCycleTracker {
031
032  static CompactionLifeCycleTracker DUMMY = new CompactionLifeCycleTracker() {
033  };
034
035  /**
036   * Called if the compaction request is failed for some reason.
037   */
038  default void notExecuted(Store store, String reason) {
039  }
040
041  /**
042   * Called before compaction is executed by CompactSplitThread.
043   * <p>
044   * Requesting compaction on a region can lead to multiple compactions on different stores, so we
045   * will pass the {@link Store} in to tell you the store we operate on.
046   */
047  default void beforeExecution(Store store) {
048  }
049
050  /**
051   * Called after compaction is executed by CompactSplitThread.
052   * <p>
053   * Requesting compaction on a region can lead to multiple compactions on different stores, so we
054   * will pass the {@link Store} in to tell you the store we operate on.
055   */
056  default void afterExecution(Store store) {
057  }
058
059  /**
060   * Called after all the requested compactions are completed.
061   * <p>
062   * The compaction scheduling is per Store so if you request a compaction on a region it may lead
063   * to multiple compactions.
064   */
065  default void completed() {
066  }
067}