hbase-server/src/main/java/org/apache/hadoop/hbase/replication/WALCellFilter.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.replication;

import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.HBaseInterfaceAudience;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.wal.WAL.Entry;

/**
 * A filter for WAL entry cells before being sent over to replication.
 */
@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
public interface WALCellFilter {

  /**
   * Applies the filter, possibly returning a different Cell instance.
   * If null is returned, the cell will be skipped.
   * @param entry Entry which contains the cell
   * @param cell Cell to filter
   * @return a (possibly modified) Cell to use.  Returning null will cause the cell
   * to be skipped for replication.
   */
  public Cell filterCell(Entry entry, Cell cell);

}