Package io.jenkins.plugins.casc
Class ConfigurationContext
- java.lang.Object
-
- io.jenkins.plugins.casc.ConfigurationContext
-
- All Implemented Interfaces:
ConfiguratorRegistry
public class ConfigurationContext extends Object implements ConfiguratorRegistry
- Author:
- Nicolas De Loof
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ConfigurationContext.Listener
-
Field Summary
Fields Modifier and Type Field Description static String
CASC_MERGE_STRATEGY_ENV
static String
CASC_MERGE_STRATEGY_PROPERTY
static String
CASC_YAML_MAX_ALIASES_ENV
static String
CASC_YAML_MAX_ALIASES_PROPERTY
-
Constructor Summary
Constructors Constructor Description ConfigurationContext(ConfiguratorRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(ConfigurationContext.Listener listener)
void
clearListeners()
io.jenkins.plugins.casc.ConfigurationContext.Deprecation
getDeprecated()
String
getMergeStrategy()
io.jenkins.plugins.casc.ConfigurationContext.Restriction
getRestricted()
SecretSourceResolver
getSecretSourceResolver()
List<SecretSource>
getSecretSources()
Get theSecretSource
s used to substitute${XX}
test used as yaml values with sensitive data.io.jenkins.plugins.casc.ConfigurationContext.Unknown
getUnknown()
io.jenkins.plugins.casc.ConfigurationContext.Version
getVersion()
int
getYamlMaxAliasesForCollections()
<T> Configurator<T>
lookup(Type type)
Retrieve aConfigurator
for target type.<T> Configurator<T>
lookupOrFail(Type type)
null-safe flavour ofConfiguratorRegistry.lookup(Type)
.RootElementConfigurator
lookupRootElement(String name)
Retrieve aRootElementConfigurator
by it's yaml element (key) name.void
setDeprecated(io.jenkins.plugins.casc.ConfigurationContext.Deprecation deprecation)
void
setMode(String mode)
void
setRestricted(io.jenkins.plugins.casc.ConfigurationContext.Restriction restriction)
void
setUnknown(io.jenkins.plugins.casc.ConfigurationContext.Unknown unknown)
void
setVersion(io.jenkins.plugins.casc.ConfigurationContext.Version version)
void
warning(CNode node, String message)
-
-
-
Field Detail
-
CASC_YAML_MAX_ALIASES_ENV
public static final String CASC_YAML_MAX_ALIASES_ENV
- See Also:
- Constant Field Values
-
CASC_YAML_MAX_ALIASES_PROPERTY
public static final String CASC_YAML_MAX_ALIASES_PROPERTY
- See Also:
- Constant Field Values
-
CASC_MERGE_STRATEGY_ENV
public static final String CASC_MERGE_STRATEGY_ENV
- See Also:
- Constant Field Values
-
CASC_MERGE_STRATEGY_PROPERTY
public static final String CASC_MERGE_STRATEGY_PROPERTY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConfigurationContext
public ConfigurationContext(ConfiguratorRegistry registry)
-
-
Method Detail
-
getSecretSourceResolver
public SecretSourceResolver getSecretSourceResolver()
-
addListener
public void addListener(ConfigurationContext.Listener listener)
-
clearListeners
public void clearListeners()
-
getDeprecated
public io.jenkins.plugins.casc.ConfigurationContext.Deprecation getDeprecated()
-
getRestricted
public io.jenkins.plugins.casc.ConfigurationContext.Restriction getRestricted()
-
getUnknown
public io.jenkins.plugins.casc.ConfigurationContext.Unknown getUnknown()
-
setDeprecated
public void setDeprecated(io.jenkins.plugins.casc.ConfigurationContext.Deprecation deprecation)
-
setRestricted
public void setRestricted(io.jenkins.plugins.casc.ConfigurationContext.Restriction restriction)
-
setUnknown
public void setUnknown(io.jenkins.plugins.casc.ConfigurationContext.Unknown unknown)
-
getMergeStrategy
public String getMergeStrategy()
-
setMode
public void setMode(String mode)
-
getYamlMaxAliasesForCollections
public int getYamlMaxAliasesForCollections()
-
lookupRootElement
@CheckForNull public RootElementConfigurator lookupRootElement(String name)
Description copied from interface:ConfiguratorRegistry
Retrieve aRootElementConfigurator
by it's yaml element (key) name.- Specified by:
lookupRootElement
in interfaceConfiguratorRegistry
- Returns:
null
if we don't know anyRootElementConfigurator
for requested name
-
lookupOrFail
@NonNull public <T> Configurator<T> lookupOrFail(Type type) throws ConfiguratorException
Description copied from interface:ConfiguratorRegistry
null-safe flavour ofConfiguratorRegistry.lookup(Type)
.- Specified by:
lookupOrFail
in interfaceConfiguratorRegistry
- Throws:
ConfiguratorException
- if we don't know anyRootElementConfigurator
for requested type
-
lookup
@CheckForNull public <T> Configurator<T> lookup(Type type)
Description copied from interface:ConfiguratorRegistry
Retrieve aConfigurator
for target type.- Specified by:
lookup
in interfaceConfiguratorRegistry
- Returns:
null
if we don't know anyRootElementConfigurator
for requested type
-
setVersion
public void setVersion(io.jenkins.plugins.casc.ConfigurationContext.Version version)
-
getVersion
public io.jenkins.plugins.casc.ConfigurationContext.Version getVersion()
-
getSecretSources
public List<SecretSource> getSecretSources()
Get theSecretSource
s used to substitute${XX}
test used as yaml values with sensitive data.
-
-