View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.replication;
19  
20  import org.apache.hadoop.hbase.Cell;
21  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
22  import org.apache.hadoop.hbase.classification.InterfaceAudience;
23  import org.apache.hadoop.hbase.wal.WAL.Entry;
24  
25  /**
26   * A filter for WAL entry cells before being sent over to replication.
27   */
28  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
29  public interface WALCellFilter {
30  
31    /**
32     * Applies the filter, possibly returning a different Cell instance.
33     * If null is returned, the cell will be skipped.
34     * @param entry Entry which contains the cell
35     * @param cell Cell to filter
36     * @return a (possibly modified) Cell to use.  Returning null will cause the cell
37     * to be skipped for replication.
38     */
39    public Cell filterCell(Entry entry, Cell cell);
40  
41  }