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

Class SelfConfigurator

java.lang.Object

io.jenkins.plugins.casc.BaseConfigurator<ConfigurationContext>

io.jenkins.plugins.casc.impl.configurators.SelfConfigurator

All Implemented Interfaces:

Configurator<ConfigurationContext>, RootElementConfigurator<ConfigurationContext>

@Extension(ordinal=1.7976931348623157E308)
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class SelfConfigurator
extends BaseConfigurator<ConfigurationContext>
implements RootElementConfigurator<ConfigurationContext>

Author:

Nicolas De Loof

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.casc.BaseConfigurator

BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
SelfConfigurator()

Method Summary

Modifier and Type	Method	Description
protected void	configure(Mapping config, ConfigurationContext instance, boolean dryrun, ConfigurationContext context)	Run configuration process on the target instance
CNode	describe(ConfigurationContext instance, ConfigurationContext context)	Describe a component as a Configuration Nodes CNode to be exported as yaml.
String	getName()	Get a configurator name.
Class<ConfigurationContext>	getTarget()	Target type this configurator can handle.
ConfigurationContext	getTargetComponent(ConfigurationContext context)	Retrieve the target component managed by this RootElementConfigurator
protected ConfigurationContext	instance(Mapping mapping, ConfigurationContext context)	Build or identify the target component this configurator has to handle based on the provided configuration node.

Methods inherited from class io.jenkins.plugins.casc.BaseConfigurator

check, compare, configure, createAttribute, describe, equals, exclusions, handleUnknown, hashCode

Methods inherited from class java.lang.Object

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

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

canConfigure, check, configure, describe, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

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

isRootElement

Constructor Details

SelfConfigurator

public SelfConfigurator()

Method Details

getName

@NonNull
public String getName()

Description copied from interface: Configurator

Get a configurator name. This should return the default name for the configurator, used for exporting yaml see Configurator.getNames() for all possible names which will be considered when configuring.

Specified by:

getName in interface Configurator<ConfigurationContext>

Returns:

short name for this component when used in a configuration.yaml file

getTarget

public Class<ConfigurationContext> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<ConfigurationContext>

getTargetComponent

public ConfigurationContext getTargetComponent(ConfigurationContext context)

Description copied from interface: RootElementConfigurator

Retrieve the target component managed by this RootElementConfigurator

Specified by:

getTargetComponent in interface RootElementConfigurator<ConfigurationContext>

Returns:

instance

protected ConfigurationContext instance(Mapping mapping,
 ConfigurationContext context)

Description copied from class: BaseConfigurator

Build or identify the target component this configurator has to handle based on the provided configuration node.

Specified by:

instance in class BaseConfigurator<ConfigurationContext>

Parameters:

mapping - configuration for target component. Implementation may consume some entries to create a fresh new instance.

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

Returns:

instance to be configured, but not yet fully configured, see BaseConfigurator.configure(Mapping, Object, boolean, ConfigurationContext)

configure

protected void configure(Mapping config,
 ConfigurationContext instance,
 boolean dryrun,
 ConfigurationContext context)
                  throws ConfiguratorException

Description copied from class: BaseConfigurator

Run configuration process on the target instance

Overrides:

configure in class BaseConfigurator<ConfigurationContext>

Parameters:

config - configuration to apply. Can be partial if BaseConfigurator.instance(Mapping, ConfigurationContext) did already used some entries

instance - target instance to configure

dryrun - only check configuration is valid regarding target component. Don't actually apply changes to jenkins controller instance

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

Throws:

ConfiguratorException - something went wrong...

describe

@CheckForNull
public CNode describe(ConfigurationContext instance,
 ConfigurationContext context)
               throws Exception

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<ConfigurationContext>

Throws:

Exception