Package org.apache.hadoop.conf

Class ConfigRedactor

java.lang.Object

org.apache.hadoop.conf.ConfigRedactor

public class ConfigRedactor
extends java.lang.Object

Tool for redacting sensitive information when displaying config parameters.

Some config parameters contain sensitive information (for example, cloud storage keys). When these properties are displayed in plaintext, we should redactor their values as appropriate.

Constructor Summary

Constructors

Constructor	Description
ConfigRedactor(Configuration conf)

Method Summary

Modifier and Type	Method	Description
java.lang.String	redact(java.lang.String key, java.lang.String value)	Given a key / value pair, decides whether or not to redact and returns either the original value or text indicating it has been redacted.
java.lang.String	redactXml(java.lang.String key, java.lang.String value)	Given a key / value pair, decides whether or not to redact and returns either the original value or text indicating it has been redacted.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRedactor

public ConfigRedactor(Configuration conf)

Method Detail

redact

public java.lang.String redact(java.lang.String key,
                               java.lang.String value)

Given a key / value pair, decides whether or not to redact and returns either the original value or text indicating it has been redacted.

Parameters:

key - param key.

value - param value, will return if conditions permit.

Returns:

Original value, or text indicating it has been redacted

redactXml

public java.lang.String redactXml(java.lang.String key,
                                  java.lang.String value)

Given a key / value pair, decides whether or not to redact and returns either the original value or text indicating it has been redacted.

Parameters:

key - param key.

value - param value, will return if conditions permit.

Returns:

Original value, or text indicating it has been redacted