Package org.keycloak.config

Class Option<T>

java.lang.Object

org.keycloak.config.Option<T>

public class Option<T>
extends Object

Constructor Summary

Constructors

Constructor	Description
Option(Class<T> type, String key, OptionCategory category, boolean hidden, boolean buildTime, String description, Optional<T> defaultValue, List<String> expectedValues, boolean strictExpectedValues, boolean caseInsensitiveExpectedValues, DeprecatedMetadata deprecatedMetadata, Set<String> connectedOptions, String wildcardKey)

Method Summary

Modifier and Type	Method	Description
OptionCategory	getCategory()
Set<String>	getConnectedOptions()	Get connected options that have a certain relationship with the current option.
Optional<T>	getDefaultValue()
static String	getDefaultValueString(Object value)
Optional<DeprecatedMetadata>	getDeprecatedMetadata()
String	getDescription()
List<String>	getExpectedValues()	If isStrictExpectedValues() is false, custom values can be provided Otherwise, only specified expected values can be used
String	getKey()
Class<T>	getType()
Optional<String>	getWildcardKey()	Get sibling option name that is able to use a named key - like using wildcards Useful mainly for references in docs f.e.
boolean	isBuildTime()
boolean	isCaseInsensitiveExpectedValues()
boolean	isHidden()
boolean	isStrictExpectedValues()	Denotes whether a custom value can be provided among the expected values If strict, application fails when some custom value is provided
OptionBuilder<T>	toBuilder()
static String	transformEnumValue(String value)	Transform enum values from upper underscore to lower hyphen Transform enum type HAS_SOMETHING -> has-something
Option<T>	withRuntimeSpecificDefault(T defaultValue)

Methods inherited from class java.lang.Object

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

Constructor Details

Option

public Option(Class<T> type,
 String key,
 OptionCategory category,
 boolean hidden,
 boolean buildTime,
 String description,
 Optional<T> defaultValue,
 List<String> expectedValues,
 boolean strictExpectedValues,
 boolean caseInsensitiveExpectedValues,
 DeprecatedMetadata deprecatedMetadata,
 Set<String> connectedOptions,
 String wildcardKey)

Method Details

getType

public Class<T> getType()

isHidden

public boolean isHidden()

isBuildTime

public boolean isBuildTime()

getKey

public String getKey()

getCategory

public OptionCategory getCategory()

getDescription

public String getDescription()

getDefaultValue

public Optional<T> getDefaultValue()

getExpectedValues

public List<String> getExpectedValues()

If isStrictExpectedValues() is false, custom values can be provided Otherwise, only specified expected values can be used

Returns:

expected values

isStrictExpectedValues

public boolean isStrictExpectedValues()

Denotes whether a custom value can be provided among the expected values If strict, application fails when some custom value is provided

isCaseInsensitiveExpectedValues

public boolean isCaseInsensitiveExpectedValues()

getDeprecatedMetadata

public Optional<DeprecatedMetadata> getDeprecatedMetadata()

withRuntimeSpecificDefault

public Option<T> withRuntimeSpecificDefault(T defaultValue)

getConnectedOptions

public Set<String> getConnectedOptions()

Get connected options that have a certain relationship with the current option. Usually when the current option is set, the connected options should be set as well.

getWildcardKey

public Optional<String> getWildcardKey()

Get sibling option name that is able to use a named key - like using wildcards Useful mainly for references in docs f.e. db-username has wildcard option db-username-<datasource>

toBuilder

public OptionBuilder<T> toBuilder()

getDefaultValueString

public static String getDefaultValueString(Object value)

transformEnumValue

public static String transformEnumValue(String value)

Transform enum values from upper underscore to lower hyphen Transform enum type HAS_SOMETHING -> has-something