View Javadoc
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 org.apache.logging.log4j.core.jackson.Initializers.SetupContextInitializer;
20  import org.apache.logging.log4j.core.jackson.Initializers.SetupContextJsonInitializer;
21  import org.apache.logging.log4j.core.jackson.Initializers.SimpleModuleInitializer;
22  
23  import com.fasterxml.jackson.core.Version;
24  import com.fasterxml.jackson.databind.module.SimpleModule;
25  
26  /**
27   * <p>
28   * <em>Consider this class private.</em>
29   * </p>
30   */
31  class Log4jJsonModule extends SimpleModule {
32  
33      private static final long serialVersionUID = 1L;
34      private final boolean encodeThreadContextAsList;
35      private final boolean includeStacktrace;
36      private final boolean stacktraceAsString;
37      private final boolean objectMessageAsJsonObject;
38  
39      Log4jJsonModule(final boolean encodeThreadContextAsList, final boolean includeStacktrace, final boolean stacktraceAsString, final boolean objectMessageAsJsonObject) {
40          super(Log4jJsonModule.class.getName(), new Version(2, 0, 0, null, null, null));
41          this.encodeThreadContextAsList = encodeThreadContextAsList;
42          this.includeStacktrace = includeStacktrace;
43          this.stacktraceAsString = stacktraceAsString;
44          this.objectMessageAsJsonObject = objectMessageAsJsonObject;
45          // MUST init here.
46          // Calling this from setupModule is too late!
47          //noinspection ThisEscapedInObjectConstruction
48          new SimpleModuleInitializer().initialize(this, objectMessageAsJsonObject);
49      }
50  
51      @Override
52      public void setupModule(final SetupContext context) {
53          // Calling super is a MUST!
54          super.setupModule(context);
55          if (encodeThreadContextAsList) {
56              new SetupContextInitializer().setupModule(context, includeStacktrace, stacktraceAsString);
57          } else {
58              new SetupContextJsonInitializer().setupModule(context, includeStacktrace, stacktraceAsString);
59          }
60      }
61  }