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.jackson;
18
19 import com.fasterxml.jackson.annotation.JsonInclude;
20 import com.fasterxml.jackson.databind.ObjectMapper;
21 import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
22
23 /**
24 * A Jackson {@link ObjectMapper} initialized for Log4j.
25 * <p>
26 * <em>Consider this class private.</em>
27 * </p>
28 */
29 public class Log4jYamlObjectMapper extends YAMLMapper {
30
31 private static final long serialVersionUID = 1L;
32
33 /**
34 * Create a new instance using the {@link Log4jYamlModule}.
35 */
36 public Log4jYamlObjectMapper() {
37 this(false, true, false);
38 }
39
40 /**
41 * Create a new instance using the {@link Log4jYamlModule}.
42 */
43 public Log4jYamlObjectMapper(final boolean encodeThreadContextAsList, final boolean includeStacktrace, final boolean stacktraceAsString) {
44 this.registerModule(new Log4jYamlModule(encodeThreadContextAsList, includeStacktrace, stacktraceAsString));
45 this.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
46 }
47
48 }