Package com.cloudbees.plugins.credentials.casc

Class CredentialsRootConfigurator

java.lang.Object

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

com.cloudbees.plugins.credentials.casc.CredentialsRootConfigurator

All Implemented Interfaces:

io.jenkins.plugins.casc.Configurator<GlobalCredentialsConfiguration>, io.jenkins.plugins.casc.RootElementConfigurator<GlobalCredentialsConfiguration>

@Extension(optional=true,
           ordinal=2.0)
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class CredentialsRootConfigurator
extends io.jenkins.plugins.casc.BaseConfigurator<GlobalCredentialsConfiguration>
implements io.jenkins.plugins.casc.RootElementConfigurator<GlobalCredentialsConfiguration>

a root element configurator used for configuring Jenkins credentials through ConfigurationAsCode https://github.com/jenkinsci/configuration-as-code-plugin Credentials from the default SystemCredentialsProvider are handled by default. Credentials provided by CredentialsProvider extensions are handled if there is a BaseConfigurator extension for it, they will be ignored otherwise.

Nested Class Summary

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

io.jenkins.plugins.casc.BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
CredentialsRootConfigurator()

Method Summary

Modifier and Type	Method	Description
Set<io.jenkins.plugins.casc.Attribute<GlobalCredentialsConfiguration,?>>	describe()
io.jenkins.plugins.casc.model.CNode	describe(GlobalCredentialsConfiguration instance, io.jenkins.plugins.casc.ConfigurationContext context)
String	getName()
Class<GlobalCredentialsConfiguration>	getTarget()
GlobalCredentialsConfiguration	getTargetComponent(io.jenkins.plugins.casc.ConfigurationContext context)
GlobalCredentialsConfiguration	instance(io.jenkins.plugins.casc.model.Mapping mapping, io.jenkins.plugins.casc.ConfigurationContext context)

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

check, compare, configure, 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, check, configure, describeStructure, getAttributes, getConfigurators, getDisplayName, getImplementedAPI, getNames

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

isRootElement

Constructor Details

CredentialsRootConfigurator

public CredentialsRootConfigurator()

Method Details

getName

@NonNull
public String getName()

Specified by:

getName in interface io.jenkins.plugins.casc.Configurator<GlobalCredentialsConfiguration>

getTarget

public Class<GlobalCredentialsConfiguration> getTarget()

Specified by:

getTarget in interface io.jenkins.plugins.casc.Configurator<GlobalCredentialsConfiguration>

getTargetComponent

public GlobalCredentialsConfiguration getTargetComponent(io.jenkins.plugins.casc.ConfigurationContext context)

Specified by:

getTargetComponent in interface io.jenkins.plugins.casc.RootElementConfigurator<GlobalCredentialsConfiguration>

instance

public GlobalCredentialsConfiguration instance(io.jenkins.plugins.casc.model.Mapping mapping,
 io.jenkins.plugins.casc.ConfigurationContext context)

Specified by:

instance in class io.jenkins.plugins.casc.BaseConfigurator<GlobalCredentialsConfiguration>

describe

@NonNull
public Set<io.jenkins.plugins.casc.Attribute<GlobalCredentialsConfiguration,?>> describe()

Specified by:

describe in interface io.jenkins.plugins.casc.Configurator<GlobalCredentialsConfiguration>

Overrides:

describe in class io.jenkins.plugins.casc.BaseConfigurator<GlobalCredentialsConfiguration>

describe

@CheckForNull
public io.jenkins.plugins.casc.model.CNode describe(GlobalCredentialsConfiguration instance,
 io.jenkins.plugins.casc.ConfigurationContext context)
                                             throws Exception

Specified by:

describe in interface io.jenkins.plugins.casc.Configurator<GlobalCredentialsConfiguration>

Throws:

Exception