1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache license, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the license for the specific language governing permissions and 15 * limitations under the license. 16 */ 17 package org.apache.logging.log4j.core.async; 18 19 import org.apache.logging.log4j.message.Message; 20 import org.apache.logging.log4j.message.SimpleMessage; 21 22 /** 23 * <b>Consider this class private.</b> 24 * <p> 25 * Transforms the specified user message to append an internal Log4j2 message explaining why this message appears out 26 * of order in the appender. 27 * </p> 28 */ 29 public class AsyncQueueFullMessageUtil { 30 /** 31 * Returns a new {@code Message} based on the original message that appends an internal Log4j2 message 32 * explaining why this message appears out of order in the appender. 33 * <p> 34 * Any parameter objects present in the original message are not included in the returned message. 35 * </p> 36 * @param message the message to replace 37 * @return a new {@code Message} object 38 */ 39 public static Message transform(Message message) { 40 SimpleMessage result = new SimpleMessage(message.getFormattedMessage() + 41 " (Log4j2 logged this message out of order to prevent deadlock caused by domain " + 42 "objects logging from their toString method when the async queue is full - LOG4J2-2031)"); 43 return result; 44 } 45 }