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;
019
020import org.apache.hadoop.hbase.client.RegionInfo;
021import org.apache.yetus.audience.InterfaceAudience;
022import org.apache.yetus.audience.InterfaceStability;
023
024/**
025 * A more restricted interface for HStore. Only gives the caller access to information about store
026 * configuration/settings that cannot easily be obtained from XML config object. Example user would
027 * be CompactionPolicy that doesn't need entire (H)Store, only this. Add things here as needed.
028 */
029@InterfaceAudience.Private
030@InterfaceStability.Unstable
031public interface StoreConfigInformation {
032  /** Returns Gets the Memstore flush size for the region that this store works with. */
033  // TODO: Why is this in here? It should be in Store and it should return the Store flush size,
034  // not the Regions. St.Ack
035  long getMemStoreFlushSize();
036
037  /** Returns Gets the cf-specific time-to-live for store files. */
038  long getStoreFileTtl();
039
040  /**
041   * @return Gets the cf-specific compaction check frequency multiplier. The need for compaction
042   *         (outside of normal checks during flush, open, etc.) will be ascertained every
043   *         multiplier * HConstants.THREAD_WAKE_FREQUENCY milliseconds.
044   */
045  long getCompactionCheckMultiplier();
046
047  /**
048   * The number of files required before flushes for this store will be blocked.
049   */
050  long getBlockingFileCount();
051
052  RegionInfo getRegionInfo();
053
054  String getColumnFamilyName();
055}