1 /*
2 * Copyright 2010 The Apache Software Foundation
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20 package org.apache.hadoop.hbase.master;
21
22 import org.apache.hadoop.conf.Configurable;
23 import org.apache.hadoop.fs.Path;
24 import org.apache.hadoop.hbase.Stoppable;
25
26 /**
27 * Interface for the log cleaning function inside the master. By default, three
28 * cleaners <code>TimeToLiveLogCleaner</code>, <code>ReplicationLogCleaner</code>,
29 * <code>SnapshotLogCleaner</code> are called in order. So if other effects are
30 * needed, implement your own LogCleanerDelegate and add it to the configuration
31 * "hbase.master.logcleaner.plugins", which is a comma-separated list of fully
32 * qualified class names. LogsCleaner will add it to the chain.
33 *
34 * <p>HBase ships with LogsCleaner as the default implementation.
35 *
36 * <p>This interface extends Configurable, so setConf needs to be called once
37 * before using the cleaner.
38 * Since LogCleanerDelegates are created in LogsCleaner by reflection. Classes
39 * that implements this interface should provide a default constructor.
40 */
41 public interface LogCleanerDelegate extends Configurable, Stoppable {
42 /**
43 * Should the master delete the log or keep it?
44 * @param filePath full path to log.
45 * @return true if the log is deletable, false if not
46 */
47 public boolean isLogDeletable(Path filePath);
48 }