Package io.jenkins.plugins.casc.core

Class AdminWhitelistRuleConfigurator

java.lang.Object

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

io.jenkins.plugins.casc.core.AdminWhitelistRuleConfigurator

All Implemented Interfaces:

Configurator<AdminWhitelistRule>

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

Virtual configurator for Remoting security settings. See the unit tests for configuration examples.

Author:

Oleg Nenashev

Nested Class Summary

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

BaseConfigurator.TypePair

Constructor Summary

Constructors

Constructor	Description
AdminWhitelistRuleConfigurator()

Method Summary

Modifier and Type	Method	Description
Set<Attribute<AdminWhitelistRule,?>>	describe()	Determine the list of Attribute available for configuration of the managed component.
String	getName()	Get a configurator name.
Class<AdminWhitelistRule>	getTarget()	Target type this configurator can handle.
protected AdminWhitelistRule	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, 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, getNames

Constructor Details

AdminWhitelistRuleConfigurator

public AdminWhitelistRuleConfigurator()

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.

Returns:

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

getTarget

public Class<AdminWhitelistRule> getTarget()

Description copied from interface: Configurator

Target type this configurator can handle.

instance

protected AdminWhitelistRule 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<AdminWhitelistRule>

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)

describe

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

Description copied from interface: Configurator

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

Specified by:

describe in interface Configurator<AdminWhitelistRule>

Overrides:

describe in class BaseConfigurator<AdminWhitelistRule>

Returns:

A set of Attributes that describes this object