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 final String	CASC_MERGE_STRATEGY_ENV
static final String	CASC_MERGE_STRATEGY_PROPERTY
static final String	CASC_YAML_CODE_POINT_LIMIT_ENV
static final String	CASC_YAML_CODE_POINT_LIMIT_PROPERTY
static final String	CASC_YAML_MAX_ALIASES_ENV
static final String	CASC_YAML_MAX_ALIASES_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ConfigurationContext(ConfiguratorRegistry registry)
ConfigurationContext(ConfiguratorRegistry registry, String mergeStrategy)

Method Summary

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 the SecretSources 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	getYamlCodePointLimit()
int	getYamlMaxAliasesForCollections()
<T> Configurator<T>	lookup(Type type)	Retrieve a Configurator for target type.
<T> Configurator<T>	lookupOrFail(Type type)	null-safe flavour of ConfiguratorRegistry.lookup(Type).
RootElementConfigurator	lookupRootElement(String name)	Retrieve a RootElementConfigurator 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)

Methods inherited from class java.lang.Object

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

Field Details

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_YAML_CODE_POINT_LIMIT_ENV

public static final String CASC_YAML_CODE_POINT_LIMIT_ENV

See Also:

• Constant Field Values

CASC_YAML_CODE_POINT_LIMIT_PROPERTY

public static final String CASC_YAML_CODE_POINT_LIMIT_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 Details

ConfigurationContext

public ConfigurationContext(ConfiguratorRegistry registry)

ConfigurationContext

public ConfigurationContext(ConfiguratorRegistry registry,
 String mergeStrategy)

Method Details

getSecretSourceResolver

public SecretSourceResolver getSecretSourceResolver()

addListener

public void addListener(ConfigurationContext.Listener listener)

clearListeners

public void clearListeners()

warning

public void warning(@NonNull
 CNode node,
 @NonNull
 String message)

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()

getYamlCodePointLimit

public int getYamlCodePointLimit()

lookupRootElement

@CheckForNull
public RootElementConfigurator lookupRootElement(String name)

Description copied from interface: ConfiguratorRegistry

Retrieve a RootElementConfigurator by it's yaml element (key) name.

Specified by:

lookupRootElement in interface ConfiguratorRegistry

Returns:

null if we don't know any RootElementConfigurator for requested name

lookupOrFail

@NonNull
public <T> Configurator<T> lookupOrFail(Type type)
                                 throws ConfiguratorException

Description copied from interface: ConfiguratorRegistry

null-safe flavour of ConfiguratorRegistry.lookup(Type).

Specified by:

lookupOrFail in interface ConfiguratorRegistry

Throws:

ConfiguratorException - if we don't know any RootElementConfigurator for requested type

lookup

@CheckForNull
public <T> Configurator<T> lookup(Type type)

Description copied from interface: ConfiguratorRegistry

Retrieve a Configurator for target type.

Specified by:

lookup in interface ConfiguratorRegistry

Returns:

null if we don't know any RootElementConfigurator 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 the SecretSources used to substitute ${XX} test used as yaml values with sensitive data.