org.wildfly.security.audit.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2017 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.
 */

/**
 * Audit logging related resources.
 *
 * Audit logging registers with the {@link org.wildfly.security.auth.server.SecurityDomain} by registering a
 * {@link java.util.function.Consumer} to receive the emitted {@link org.wildfly.security.auth.server.event.SecurityEvent}s.
 *
 * The audit logging framework is comprised of three core components.
 * 
 * Priority Mapper ({@code Function})
 * Event Formatter ({@code Function})
 * Audit Endpoint ({@code ExceptionBiConsumer})
 * 
 *
 * The priority mapper takes an incoming security event and maps it to one of nine priority levels including a level 'OFF' to
 * cause the event to be immediately discarded.
 *
 * The event formatter takes a security event and converts it to a formatted String ready to be recorded.
 *
 * The audit endpoint is the final component and takes the resulting priority and formatted String to be logged according to the
 * endpoint's configuration.
 *
 * @author Darran Lofthouse
 */
package org.wildfly.security.audit;