Package org.elasticsearch.common.settings

Class SettingsFilter

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.settings.SettingsFilter

public final class SettingsFilter
extends AbstractComponent

A class that allows to filter settings objects by simple regular expression patterns or full settings keys. It's used for response filtering on the rest layer to for instance filter out sensitive information like access keys.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SETTINGS_FILTER_PARAM	Can be used to specify settings filter that will be used to filter out matching settings in toXContent method

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor	Description
SettingsFilter(Settings settings, java.util.Collection<java.lang.String> patterns)

Method Summary

Modifier and Type	Method	Description
void	addFilterSettingParams(RestRequest request)
Settings	filter(Settings settings)
static Settings	filterSettings(ToXContent.Params params, Settings settings)
java.util.Set<java.lang.String>	getPatterns()	Returns a set of patterns
static boolean	isValidPattern(java.lang.String pattern)	Returns true iff the given string is either a valid settings key pattern or a simple regular expression

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

SETTINGS_FILTER_PARAM

public static java.lang.String SETTINGS_FILTER_PARAM

Can be used to specify settings filter that will be used to filter out matching settings in toXContent method

Constructor Detail

SettingsFilter

public SettingsFilter(Settings settings,
                      java.util.Collection<java.lang.String> patterns)

Method Detail

getPatterns

public java.util.Set<java.lang.String> getPatterns()

Returns a set of patterns

isValidPattern

public static boolean isValidPattern(java.lang.String pattern)

Returns true iff the given string is either a valid settings key pattern or a simple regular expression

See Also:

Regex, AbstractScopedSettings.isValidKey(String)

addFilterSettingParams

public void addFilterSettingParams(RestRequest request)

filterSettings

public static Settings filterSettings(ToXContent.Params params,
                                      Settings settings)

filter

public Settings filter(Settings settings)