org.elasticsearch.common.xcontent.LoggingDeprecationHandler Maven / Gradle / Ivy

Go to download
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.common.xcontent;

import org.elasticsearch.common.logging.DeprecationCategory;
import org.elasticsearch.common.logging.DeprecationLogger;
import org.elasticsearch.xcontent.DeprecationHandler;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.XContentLocation;

import java.util.function.Supplier;

/**
 * Logs deprecations to the {@link DeprecationLogger}.
 * 
 * This is core's primary implementation of {@link DeprecationHandler} and
 * should absolutely be used everywhere where it parses
 * requests. It is much less appropriate when parsing responses from external
 * sources because it will report deprecated fields back to the user as
 * though the user sent them.
 */
public class LoggingDeprecationHandler implements DeprecationHandler {
    public static final LoggingDeprecationHandler INSTANCE = new LoggingDeprecationHandler();
    /**
     * The logger to which to send deprecation messages.
     *
     * This uses ParseField's logger because that is the logger that
     * we have been using for many releases for deprecated fields.
     * Changing that will require some research to make super duper
     * sure it is safe.
     */
    private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(ParseField.class);

    private LoggingDeprecationHandler() {
        // Singleton
    }

    @Override
    public void usedDeprecatedName(String parserName, Supplier location, String usedName, String modernName) {
        String prefix = parserName == null ? "" : "[" + parserName + "][" + location.get() + "] ";
        deprecationLogger.critical(
            DeprecationCategory.API,
            "deprecated_field_" + usedName,
            "{}Deprecated field [{}] used, expected [{}] instead",
            prefix,
            usedName,
            modernName
        );
    }

    @Override
    public void usedDeprecatedField(String parserName, Supplier location, String usedName, String replacedWith) {
        String prefix = parserName == null ? "" : "[" + parserName + "][" + location.get() + "] ";
        deprecationLogger.critical(
            DeprecationCategory.API,
            "deprecated_field_" + usedName,
            "{}Deprecated field [{}] used, replaced by [{}]",
            prefix,
            usedName,
            replacedWith
        );
    }

    @Override
    public void usedDeprecatedField(String parserName, Supplier location, String usedName) {
        String prefix = parserName == null ? "" : "[" + parserName + "][" + location.get() + "] ";
        deprecationLogger.critical(
            DeprecationCategory.API,
            "deprecated_field_" + usedName,
            "{}Deprecated field [{}] used, this field is unused and will be removed entirely",
            prefix,
            usedName
        );
    }
}