    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements. See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache license, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License. You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the license for the specific language governing permissions and
    015     * limitations under the license.
    016     */
    017    package org.apache.logging.log4j;
    018
    019    import org.apache.logging.log4j.message.StructuredDataMessage;
    020    import org.apache.logging.log4j.spi.ExtendedLogger;
    021
    022    /**
    023     *  Logs "Events" that are represented as StructuredDataMessages.
    024     */
    025    public final class EventLogger {
    026
    027        private static final String NAME = "EventLogger";
    028
    029        /**
    030         * Define the Event Marker.
    031         */
    032        public static final Marker EVENT_MARKER = MarkerManager.getMarker("EVENT");
    033
    034        private static final String FQCN = EventLogger.class.getName();
    035
    036        private static final ExtendedLogger LOGGER = LogManager.getContext(false).getLogger(NAME);
    037
    038        private EventLogger() {
    039        }
    040
    041        /**
    042         * Log events with a level of ALL.
    043         * @param msg The event StructuredDataMessage.
    044         */
    045        public static void logEvent(final StructuredDataMessage msg) {
    046            LOGGER.logIfEnabled(FQCN, Level.OFF, EVENT_MARKER, msg, null);
    047        }
    048
    049        /**
    050         * Log events and specify the logging level.
    051         * @param msg The event StructuredDataMessage.
    052         * @param level The logging Level.
    053         */
    054        public static void logEvent(final StructuredDataMessage msg, final Level level) {
    055            LOGGER.logIfEnabled(FQCN, level, EVENT_MARKER, msg, null);
    056        }
    057    }