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.log4j.rewrite;
18
19 import org.apache.log4j.spi.LoggingEvent;
20
21 /**
22 * This interface is implemented to provide a rewrite
23 * strategy for RewriteAppender. RewriteAppender will
24 * call the rewrite method with a source logging event.
25 * The strategy may return that event, create a new event
26 * or return null to suppress the logging request.
27 */
28 public interface RewritePolicy {
29 /**
30 * Rewrite a logging event.
31 * @param source a logging event that may be returned or
32 * used to create a new logging event.
33 * @return a logging event or null to suppress processing.
34 */
35 LoggingEvent rewrite(final LoggingEvent source);
36 }