Package io.jenkins.plugins.casc.impl.configurators

Class PrimitiveConfigurator

java.lang.Object

io.jenkins.plugins.casc.impl.configurators.PrimitiveConfigurator

All Implemented Interfaces:

Configurator

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class PrimitiveConfigurator
extends Object
implements Configurator

Author:

Nicolas De Loof

Constructor Summary

Constructors

Constructor	Description
PrimitiveConfigurator(Class clazz)

Method Summary

Modifier and Type	Method	Description
Object	check(CNode config, ConfigurationContext context)	Run the same logic as Configurator.configure(CNode, ConfigurationContext) in dry-run mode.
Object	configure(CNode config, ConfigurationContext context)	Configures/creates a Jenkins object based on a tree.
Set<Attribute>	describe()	Determine the list of Attribute available for configuration of the managed component.
CNode	describe(Object instance, ConfigurationContext context)	Describe a component as a Configuration Nodes CNode to be exported as yaml.
List<Configurator>	getConfigurators(ConfigurationContext context)
Class	getTarget()	Target type this configurator can handle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenkins.plugins.casc.Configurator

canConfigure, describeStructure, getAttributes, getDisplayName, getImplementedAPI, getName, getNames

Constructor Detail

PrimitiveConfigurator

public PrimitiveConfigurator(Class clazz)

Method Detail

getTarget

public Class getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator

describe

@NonNull
public Set<Attribute> describe()

Description copied from interface: Configurator

Determine the list of Attribute available for configuration of the managed component.

Specified by:

describe in interface Configurator

Returns:

A set of Attributes that describes this object

configure

@NonNull
public Object configure(CNode config,
                        ConfigurationContext context)
                 throws ConfiguratorException

Description copied from interface: Configurator

Configures/creates a Jenkins object based on a tree.

Specified by:

configure in interface Configurator

Parameters:

config - Map/List/primitive objects (think YAML) that represents the configuration from which a Jenkins object is configured.

context - Fully configured Jenkins object used as the starting point for this configuration.

Returns:

Fully configured Jenkins object that results from this configuration. if no new objects got created, but some existing objects may have been modified, return updated target object.

Throws:

ConfiguratorException - if something went wrong, depends on the concrete implementation

check

public Object check(CNode config,
                    ConfigurationContext context)
             throws ConfiguratorException

Description copied from interface: Configurator

Run the same logic as Configurator.configure(CNode, ConfigurationContext) in dry-run mode. Used to verify configuration is fine before being actually applied to a live jenkins controller.

Specified by:

check in interface Configurator

Parameters:

config - Map/List/primitive objects (think YAML) that represents the configuration from which a Jenkins object is configured.

context - Fully configured Jenkins object used as the starting point for this configuration.

Throws:

ConfiguratorException - on configuration error

describe

@CheckForNull
public CNode describe(Object instance,
                      ConfigurationContext context)

Description copied from interface: Configurator

Describe a component as a Configuration Nodes CNode to be exported as yaml. Only export attributes which are not set to default value.

Specified by:

describe in interface Configurator

getConfigurators

@NonNull
public List<Configurator> getConfigurators(ConfigurationContext context)

Specified by:

getConfigurators in interface Configurator

Returns:

list of Configurators to be considered so one can fully configure this component. Typically, configurator for an abstract extension point will return Configurators for available implementations.