org.apache.logging.log4j.audit.AuditEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of log4j-audit-api Show documentation

There is a newer version: 1.0.1

/*
 * 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.logging.log4j.audit;

/**
 * Interface that is extended by generated classes.
 */
public interface AuditEvent {

    /**
     * Log the event.
     */
    void logEvent();

    /**
     * Set the exception handler to use. The default exception handler will throw an AuditException wrapping the
     * exception that occurred. If null is passed in then the exception will be ignored.
     * @param exceptionHandler The exception handler.
     */
    void setAuditExceptionHandler(AuditExceptionHandler exceptionHandler);

    /**
     * Added to the event after the operation has completed. Identifies whether it was successful or not.
     * @param status The completion status.
     */
    void setCompletionStatus(String status);
}