org.elasticsearch.common.logging

Class DeprecationLogger

java.lang.Object

org.elasticsearch.common.logging.DeprecationLogger

public class DeprecationLogger
extends java.lang.Object

A logger that logs deprecation notices.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WARNING_HEADER The "Warning" Header comes from RFC-7234.

Constructor Summary

Constructors

Constructor and Description
DeprecationLogger(org.apache.logging.log4j.Logger parentLogger) Creates a new deprecation logger based on the parent logger.

Method Summary

Modifier and Type	Method and Description
void	deprecated(java.lang.String msg, java.lang.Object... params) Logs a deprecated message.
static void	removeThreadContext(ThreadContext threadContext) Remove the ThreadContext used to add deprecation headers to network responses.
static void	setThreadContext(ThreadContext threadContext) Set the ThreadContext used to add deprecation headers to network responses.

Methods inherited from class java.lang.Object

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

Field Detail

WARNING_HEADER

public static final java.lang.String WARNING_HEADER

The "Warning" Header comes from RFC-7234. As the RFC describes, it's generally used for caching purposes, but it can be used for any warning. https://tools.ietf.org/html/rfc7234#section-5.5

See Also:

Constant Field Values

Constructor Detail

DeprecationLogger

public DeprecationLogger(org.apache.logging.log4j.Logger parentLogger)

Creates a new deprecation logger based on the parent logger. Automatically prefixes the logger name with "deprecation", if it starts with "org.elasticsearch.", it replaces "org.elasticsearch" with "org.elasticsearch.deprecation" to maintain the "org.elasticsearch" namespace.

Method Detail

setThreadContext

public static void setThreadContext(ThreadContext threadContext)

Set the ThreadContext used to add deprecation headers to network responses.

This is expected to only be invoked by the Node's constructor (therefore once outside of tests).

Parameters:

threadContext - The thread context owned by the ThreadPool (and implicitly a Node)

Throws:

java.lang.IllegalStateException - if this threadContext has already been set

removeThreadContext

public static void removeThreadContext(ThreadContext threadContext)

Remove the ThreadContext used to add deprecation headers to network responses.

This is expected to only be invoked by the Node's close method (therefore once outside of tests).

Parameters:

threadContext - The thread context owned by the ThreadPool (and implicitly a Node)

Throws:

java.lang.IllegalStateException - if this threadContext is unknown (and presumably already unset before)

deprecated

public void deprecated(java.lang.String msg,
                       java.lang.Object... params)

Logs a deprecated message.