Package io.jenkins.plugins.casc.core

Class UpdateCenterConfigurator

java.lang.Object

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

io.jenkins.plugins.casc.core.UpdateCenterConfigurator

All Implemented Interfaces:

Configurator<UpdateCenter>

@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class UpdateCenterConfigurator
extends BaseConfigurator<UpdateCenter>

TODO would not be required if UpdateCenter had a DataBoundConstructor

Nested Class Summary

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

BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
UpdateCenterConfigurator()

Method Summary

Modifier and Type	Method	Description
protected void	configure(Mapping config, UpdateCenter instance, boolean dryrun, ConfigurationContext context)	Run configuration process on the target instance
Set<Attribute<UpdateCenter,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
Class<UpdateCenter>	getTarget()	Target type this configurator can handle.
protected UpdateCenter	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, 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, describe, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getName, getNames

Constructor Detail

UpdateCenterConfigurator

public UpdateCenterConfigurator()

Method Detail

getTarget

public Class<UpdateCenter> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

configure

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

Description copied from class: BaseConfigurator

Run configuration process on the target instance

Overrides:

configure in class BaseConfigurator<UpdateCenter>

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

instance

protected UpdateCenter instance(Mapping mapping,
                                ConfigurationContext context)
                         throws ConfiguratorException

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

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)

Throws:

ConfiguratorException - something went wrong...

describe

@NonNull
public Set<Attribute<UpdateCenter,?>> describe()

Description copied from interface: Configurator

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

Specified by:

describe in interface Configurator<UpdateCenter>

Overrides:

describe in class BaseConfigurator<UpdateCenter>

Returns:

A set of Attributes that describes this object