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.AbstractLogger;
021    import org.apache.logging.log4j.spi.AbstractLoggerWrapper;
022    
023    /**
024     *  Logs "Events" that are represented as StructuredDataMessages.
025     */
026    public final class EventLogger {
027    
028        /**
029         * Define the Event Marker.
030         */
031        public static final Marker EVENT_MARKER = MarkerManager.getMarker("EVENT");
032    
033        private static final String FQCN = EventLogger.class.getName();
034    
035        private static AbstractLoggerWrapper logger;
036    
037        static {
038            final Logger l = LogManager.getLogger("EventLogger");
039            if (!(l instanceof AbstractLogger)) {
040                throw new LoggingException("Logger returned must be based on AbstractLogger");
041            }
042            logger = new AbstractLoggerWrapper((AbstractLogger) l, "EventLogger", null);
043        }
044    
045    
046        private EventLogger() {
047        }
048    
049        /**
050         * Log events with a level of ALL.
051         * @param msg The event StructuredDataMessage.
052         */
053        public static void logEvent(final StructuredDataMessage msg) {
054            logger.log(EVENT_MARKER, FQCN, Level.OFF, msg, null);
055        }
056    
057        /**
058         * Log events and specify the logging level.
059         * @param msg The event StructuredDataMessage.
060         * @param level The logging Level.
061         */
062        public static void logEvent(final StructuredDataMessage msg, final Level level) {
063            logger.log(EVENT_MARKER, FQCN, level, msg, null);
064        }
065    }