org.apache.juli.logging.net.logstash.logback.decorate.PrettyPrintingJsonGeneratorDecorator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tomcat10-slf4j-logback Show documentation

Tomcat10 Slf4j Logback Integration

There is a newer version: 10.1.23

Show newest version

/*
 * Copyright 2013-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.juli.logging.net.logstash.logback.decorate;

import org.apache.juli.logging.ch.qos.logback.core.CoreConstants;
import org.apache.juli.logging.com.fasterxml.jackson.core.JsonGenerator;
import org.apache.juli.logging.com.fasterxml.jackson.core.util.DefaultPrettyPrinter;

/**
 * Enables pretty printing on the {@link JsonGenerator}
 */
public class PrettyPrintingJsonGeneratorDecorator implements JsonGeneratorDecorator {

    private DefaultPrettyPrinter prettyPrinter = new DefaultPrettyPrinter()
            .withRootSeparator(CoreConstants.EMPTY_STRING);

    @Override
    public JsonGenerator decorate(JsonGenerator generator) {
        return generator.setPrettyPrinter(prettyPrinter);
    }

    /**
     * Sets the root separator used by the pretty printer.
     *
     * Replaces occurrences of the string literal {@code [SPACE]} with a space character
     * to work around the fact that logback trims values read from xml before calling the setter.
     * Therefore, to set the root separator to a single space, you can specify
     * {@code [SPACE]} in the xml configuration.
     *
     * @param rootSeparator the new root separator
     * @see DefaultPrettyPrinter#withRootSeparator(String)
     */
    public void setRootSeparator(String rootSeparator) {
        prettyPrinter = prettyPrinter.withRootSeparator(
                rootSeparator == null ? null : rootSeparator.replace("[SPACE]", " "));
    }

    /**
     * Sets whether spaces appear in object entries.
     *
     * @param spacesInObjectEntries whether spaces appear in object entries.
     * @see DefaultPrettyPrinter#withSpacesInObjectEntries()
     * @see DefaultPrettyPrinter#withoutSpacesInObjectEntries()
     */
    public void setSpacesInObjectEntries(boolean spacesInObjectEntries) {
        if (spacesInObjectEntries) {
            prettyPrinter = prettyPrinter.withSpacesInObjectEntries();
        } else {
            prettyPrinter = prettyPrinter.withoutSpacesInObjectEntries();
        }
    }
}