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.audit;
18
19 /**
20 * Interface that is extended by generated classes.
21 */
22 public interface AuditEvent {
23
24 /**
25 * Log the event.
26 */
27 void logEvent();
28
29 /**
30 * Set the exception handler to use. The default exception handler will throw an AuditException wrapping the
31 * exception that occurred. If null is passed in then the exception will be ignored.
32 * @param exceptionHandler The exception handler.
33 */
34 void setAuditExceptionHandler(AuditExceptionHandler exceptionHandler);
35
36 /**
37 * Added to the event after the operation has completed. Identifies whether it was successful or not.
38 * @param status The completion status.
39 */
40 void setCompletionStatus(String status);
41 }