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