Package io.jenkins.plugins.safebatch

Class BatchSanitizerGlobalRule

java.lang.Object

io.jenkins.plugins.safebatch.BatchSanitizerGlobalRule

All Implemented Interfaces:

ExtensionPoint, Describable<EnvVarsFilterGlobalRule>, Serializable, EnvVarsFilterGlobalRule, EnvVarsFilterRule

public class BatchSanitizerGlobalRule
extends Object
implements EnvVarsFilterGlobalRule

Global rule to filter freestyle Windows Batch step and also pipeline's one It will be triggered on dangerous characters present in variable's value. The action depends on the BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode configured.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BatchSanitizerGlobalRule.DescriptorImpl
static enum	BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BatchSanitizerGlobalRule()

Method Summary

Modifier and Type	Method	Description
void	filter(EnvVars envVars, EnvVarsFilterRuleContext context)
List<io.jenkins.plugins.environment_filter_utils.matchers.run.RunMatcher>	getJobExclusionList()
BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode	getMode()
boolean	isApplicable(Run<?,?> run, Object builder, Launcher launcher)
void	setJobExclusionList(List<io.jenkins.plugins.environment_filter_utils.matchers.run.RunMatcher> jobExclusionList)
void	setMode(BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode mode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jenkins.tasks.filters.EnvVarsFilterGlobalRule

getDescriptor

Methods inherited from interface jenkins.tasks.filters.EnvVarsFilterRule

getDisplayName

Constructor Details

BatchSanitizerGlobalRule

@DataBoundConstructor
public BatchSanitizerGlobalRule()

Method Details

setMode

@DataBoundSetter
public void setMode(@Nonnull
 BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode mode)

getMode

@Nonnull
public BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode getMode()

setJobExclusionList

@DataBoundSetter
public void setJobExclusionList(List<io.jenkins.plugins.environment_filter_utils.matchers.run.RunMatcher> jobExclusionList)

getJobExclusionList

public List<io.jenkins.plugins.environment_filter_utils.matchers.run.RunMatcher> getJobExclusionList()

isApplicable

public boolean isApplicable(@CheckForNull
 Run<?,?> run,
 @Nonnull
 Object builder,
 @Nonnull
 Launcher launcher)

Specified by:

isApplicable in interface EnvVarsFilterGlobalRule

filter

public void filter(@Nonnull
 EnvVars envVars,
 @Nonnull
 EnvVarsFilterRuleContext context)
            throws EnvVarsFilterException

Specified by:

filter in interface EnvVarsFilterRule

Throws:

EnvVarsFilterException