Module org.elasticsearch.server

Package org.elasticsearch.common.xcontent

Class LoggingDeprecationHandler

java.lang.Object

org.elasticsearch.common.xcontent.LoggingDeprecationHandler

All Implemented Interfaces:

DeprecationHandler

public class LoggingDeprecationHandler
extends Object
implements DeprecationHandler

Logs deprecations to the DeprecationLogger.

This is core's primary implementation of 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final LoggingDeprecationHandler	INSTANCE

Fields inherited from interface org.elasticsearch.xcontent.DeprecationHandler

IGNORE_DEPRECATIONS, THROW_UNSUPPORTED_OPERATION

Method Summary

Modifier and Type	Method	Description
void	logRemovedField(String parserName, Supplier<XContentLocation> location, String removedName)
void	logRemovedField(String parserName, Supplier<XContentLocation> location, String removedName, boolean isCompatibleDeprecation)
void	logRenamedField(String parserName, Supplier<XContentLocation> location, String oldName, String currentName)
void	logRenamedField(String parserName, Supplier<XContentLocation> location, String oldName, String currentName, boolean isCompatibleDeprecation)
void	logReplacedField(String parserName, Supplier<XContentLocation> location, String oldName, String replacedName)
void	logReplacedField(String parserName, Supplier<XContentLocation> location, String oldName, String replacedName, boolean isCompatibleDeprecation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INSTANCE

public static final LoggingDeprecationHandler INSTANCE

Method Details

logRenamedField

public void logRenamedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String currentName)

Specified by:

logRenamedField in interface DeprecationHandler

logReplacedField

public void logReplacedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String replacedName)

Specified by:

logReplacedField in interface DeprecationHandler

logRemovedField

public void logRemovedField(String parserName,
 Supplier<XContentLocation> location,
 String removedName)

Specified by:

logRemovedField in interface DeprecationHandler

logRenamedField

public void logRenamedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String currentName,
 boolean isCompatibleDeprecation)

Specified by:

logRenamedField in interface DeprecationHandler

logReplacedField

public void logReplacedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String replacedName,
 boolean isCompatibleDeprecation)

Specified by:

logReplacedField in interface DeprecationHandler

logRemovedField

public void logRemovedField(String parserName,
 Supplier<XContentLocation> location,
 String removedName,
 boolean isCompatibleDeprecation)

Specified by:

logRemovedField in interface DeprecationHandler