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.master.cleaner;
019
020import org.apache.hadoop.conf.Configuration;
021import org.apache.hadoop.fs.Path;
022import org.apache.hadoop.hbase.HBaseInterfaceAudience;
023import org.apache.hadoop.hbase.master.region.MasterRegionFactory;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Master local storage WAL cleaner that uses the timestamp of the WAL file to determine if it
028 * should be deleted. By default they are allowed to live for {@value #DEFAULT_TTL}
029 */
030@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
031public class TimeToLiveMasterLocalStoreWALCleaner extends BaseTimeToLiveFileCleaner {
032
033  public static final String TTL_CONF_KEY = "hbase.master.local.store.walcleaner.ttl";
034
035  // default ttl = 7 days
036  public static final long DEFAULT_TTL = 604_800_000L;
037
038  @Override
039  protected long getTtlMs(Configuration conf) {
040    return conf.getLong(TTL_CONF_KEY, DEFAULT_TTL);
041  }
042
043  @Override
044  protected boolean valiateFilename(Path file) {
045    return file.getName().endsWith(MasterRegionFactory.ARCHIVED_WAL_SUFFIX);
046  }
047}