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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canConfigure(Class clazz)
SecurityRealm
check(CNode config, ConfigurationContext context)
Run the same logic asConfigurator.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 NodesCNode
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
-
-
-
-
Method Detail
-
getTarget
public Class<SecurityRealm> getTarget()
Description copied from interface:Configurator
Target type this configurator can handle.- Specified by:
getTarget
in interfaceConfigurator<SecurityRealm>
-
canConfigure
public boolean canConfigure(Class clazz)
- Specified by:
canConfigure
in interfaceConfigurator<SecurityRealm>
- Returns:
true
if this configurator can handle typeclazz
. Implementation has to be consistent withConfigurator.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 interfaceConfigurator<SecurityRealm>
- Parameters:
config
- Map/List/primitive objects (think YAML) that represents the configuration from which a Jenkins object is configured.- 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 asConfigurator.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 interfaceConfigurator<SecurityRealm>
-
describe
@CheckForNull public CNode describe(SecurityRealm instance, ConfigurationContext context) throws Exception
Description copied from interface:Configurator
Describe a component as a Configuration NodesCNode
to be exported as yaml. Only export attributes which are not set to default value.- Specified by:
describe
in interfaceConfigurator<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 interfaceConfigurator<SecurityRealm>
- Returns:
- A set of
Attribute
s that describes this object
-
-