View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.appender.rewrite;
18  
19  import org.apache.logging.log4j.core.LogEvent;
20  
21  /**
22   * Interface to be implemented by components that support modifications to the LogEvent.
23   */
24  
25  public interface RewritePolicy {
26      /**
27       * Rewrite a logging event.
28       * @param source a logging event that may be returned or
29       * used to create a new logging event.
30       * @return a logging event or null to suppress processing.
31       */
32      LogEvent rewrite(final LogEvent source);
33  }