Package io.jenkins.plugins.casc.core

Class NoneSecurityRealmConfigurator

java.lang.Object

io.jenkins.plugins.casc.core.NoneSecurityRealmConfigurator

All Implemented Interfaces:

Configurator<SecurityRealm>

@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class NoneSecurityRealmConfigurator
extends Object
implements Configurator<SecurityRealm>

Author:

Nicolas De Loof

Constructor Summary

Constructors

Constructor	Description
NoneSecurityRealmConfigurator()

Method Summary

Modifier and Type	Method	Description
boolean	canConfigure(Class clazz)
SecurityRealm	check(CNode config, ConfigurationContext context)	Run the same logic as Configurator.configure(CNode, ConfigurationContext) in dry-run mode.
SecurityRealm	configure(CNode config, ConfigurationContext context)	Configures/creates a Jenkins object based on a tree.
Set<Attribute<SecurityRealm,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
CNode	describe(SecurityRealm instance, ConfigurationContext context)	Describe a component as a Configuration Nodes CNode to be exported as yaml.
Class<SecurityRealm>	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

describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getName, getNames

Constructor Detail

NoneSecurityRealmConfigurator

public NoneSecurityRealmConfigurator()

Method Detail

getTarget

public Class<SecurityRealm> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

Specified by:

getTarget in interface Configurator<SecurityRealm>

canConfigure

public boolean canConfigure(Class clazz)

Specified by:

canConfigure in interface Configurator<SecurityRealm>

Returns:

true if this configurator can handle type clazz. Implementation has to be consistent with Configurator.getTarget()

configure

@NonNull
public SecurityRealm 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<SecurityRealm>

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 SecurityRealm check(CNode config,
                           ConfigurationContext context)

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

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.

describe

@CheckForNull
public CNode describe(SecurityRealm 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<SecurityRealm>

Throws:

Exception

describe

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

Description copied from interface: Configurator

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

Specified by:

describe in interface Configurator<SecurityRealm>

Returns:

A set of Attributes that describes this object