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.replication;
019
020import org.apache.hadoop.hbase.Cell;
021import org.apache.hadoop.hbase.HBaseInterfaceAudience;
022import org.apache.hadoop.hbase.wal.WAL.Entry;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * A filter for WAL entry cells before being sent over to replication.
027 */
028@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
029public interface WALCellFilter {
030
031  /**
032   * Applies the filter, possibly returning a different Cell instance. If null is returned, the cell
033   * will be skipped.
034   * @param entry Entry which contains the cell
035   * @param cell  Cell to filter
036   * @return a (possibly modified) Cell to use. Returning null will cause the cell to be skipped for
037   *         replication.
038   */
039  public Cell filterCell(Entry entry, Cell cell);
040
041}