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 */
017package org.apache.logging.log4j.core.async;
018
019import org.apache.logging.log4j.message.Message;
020import org.apache.logging.log4j.message.SimpleMessage;
021
022/**
023 * <b>Consider this class private.</b>
024 * <p>
025 * Transforms the specified user message to append an internal Log4j2 message explaining why this message appears out
026 * of order in the appender.
027 * </p>
028 */
029public class AsyncQueueFullMessageUtil {
030    /**
031     * Returns a new {@code Message} based on the original message that appends an internal Log4j2 message
032     * explaining why this message appears out of order in the appender.
033     * <p>
034     * Any parameter objects present in the original message are not included in the returned message.
035     * </p>
036     * @param message the message to replace
037     * @return a new {@code Message} object
038     */
039    public static Message transform(Message message) {
040        SimpleMessage result = new SimpleMessage(message.getFormattedMessage() +
041                " (Log4j2 logged this message out of order to prevent deadlock caused by domain " +
042                "objects logging from their toString method when the async queue is full - LOG4J2-2031)");
043        return result;
044    }
045}