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.core.util.Constants;
20 import org.apache.logging.log4j.message.AsynchronouslyFormattable;
21 import org.apache.logging.log4j.message.Message;
22
23 /**
24 * Helper class providing some async logging-related functionality.
25 * <p>
26 * Consider this class private.
27 * </p>
28 */
29 public class InternalAsyncUtil {
30 /**
31 * Returns the specified message, with its content frozen unless system property
32 * {@code log4j.format.msg.async} is true or the message class is annotated with
33 * {@link AsynchronouslyFormattable}.
34 *
35 * @param msg the message object to inspect, modify and return
36 * @return Returns the specified message, with its content frozen
37 */
38 public static Message makeMessageImmutable(final Message msg) {
39 // if the Message instance is reused, there is no point in freezing its message here
40 if (msg != null && !canFormatMessageInBackground(msg)) {
41 msg.getFormattedMessage(); // LOG4J2-763: ask message to makeMessageImmutable parameters
42 }
43 return msg;
44 }
45
46 private static boolean canFormatMessageInBackground(final Message message) {
47 return Constants.FORMAT_MESSAGES_IN_BACKGROUND // LOG4J2-898: user wants to format all msgs in background
48 || message.getClass().isAnnotationPresent(AsynchronouslyFormattable.class); // LOG4J2-1718
49 }
50 }