public abstract class SecureSetting<T> extends Setting<T>
Setting.AffixKey, Setting.AffixSetting<T>, Setting.GroupKey, Setting.Key, Setting.ListKey, Setting.Property, Setting.SimpleKey, Setting.Validator<T>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
defaultValue
EMPTY_PARAMS
Modifier and Type | Method and Description |
---|---|
void |
diff(Settings.Builder builder,
Settings source,
Settings defaultSettings)
Overrides the diff operation to make this a no-op for secure settings as they shouldn't be returned in a diff
|
boolean |
exists(Settings settings)
Returns
true iff this setting is present in the given settings object. |
T |
get(Settings settings)
Returns the settings value.
|
T |
getDefault(Settings settings)
Returns the default value for this setting.
|
java.lang.String |
getDefaultRaw(Settings settings)
Returns the default value string representation for this setting.
|
java.lang.String |
getRaw(Settings settings)
Returns the raw (string) settings value.
|
static Setting<SecureString> |
insecureString(java.lang.String name)
A setting which contains a sensitive string, but which for legacy reasons must be found outside secure settings.
|
static Setting<java.io.InputStream> |
secureFile(java.lang.String name,
Setting<java.io.InputStream> fallback,
Setting.Property... properties)
A setting which contains a file.
|
static Setting<SecureString> |
secureString(java.lang.String name,
Setting<SecureString> fallback,
Setting.Property... properties)
A setting which contains a sensitive string.
|
affixKeySetting, boolSetting, boolSetting, boolSetting, byteSizeSetting, byteSizeSetting, byteSizeSetting, byteSizeSetting, byteSizeSetting, doubleSetting, equals, floatSetting, floatSetting, get, getConcreteSetting, getKey, getProperties, getRawKey, getSettingsDependencies, groupSetting, groupSetting, hashCode, hasIndexScope, hasNodeScope, intSetting, intSetting, intSetting, intSetting, intSetting, isDeprecated, isDynamic, isFiltered, isFinal, listSetting, listSetting, listSetting, longSetting, match, memorySizeSetting, memorySizeSetting, memorySizeSetting, parseByteSize, parseInt, parseInt, parseLong, parseTimeValue, positiveTimeSetting, prefixKeySetting, simpleString, simpleString, simpleString, timeSetting, timeSetting, timeSetting, timeSetting, toString, toXContent
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public java.lang.String getDefaultRaw(Settings settings)
Setting
getDefaultRaw
in class Setting<T>
settings
- a settings object for settings that has a default value depending on another setting if availablepublic T getDefault(Settings settings)
Setting
getDefault
in class Setting<T>
settings
- a settings object for settings that has a default value depending on another setting if availablepublic java.lang.String getRaw(Settings settings)
Setting
public boolean exists(Settings settings)
Setting
true
iff this setting is present in the given settings object. Otherwise false
public T get(Settings settings)
Setting
public void diff(Settings.Builder builder, Settings source, Settings defaultSettings)
public static Setting<SecureString> secureString(java.lang.String name, Setting<SecureString> fallback, Setting.Property... properties)
public static Setting<SecureString> insecureString(java.lang.String name)
#secureString(String, Setting, Property...)
public static Setting<java.io.InputStream> secureFile(java.lang.String name, Setting<java.io.InputStream> fallback, Setting.Property... properties)