Package io.jenkins.plugins.safebatch

Enum Class BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode

java.lang.Object

java.lang.Enum<BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode>

io.jenkins.plugins.safebatch.BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode

All Implemented Interfaces:

Serializable, Comparable<BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode>, Constable

Enclosing class:

BatchSanitizerGlobalRule

public static enum BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode
extends Enum<BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Force the job to fail
REPLACE	Replace the dangerous variables by REDACTED
WARN	Just log the character and the name of the field (to avoid disclosing passwords / credentials)

Field Summary

Fields

Modifier and Type	Field	Description
final org.jvnet.localizer.Localizable	label

Method Summary

Modifier and Type	Method	Description
abstract boolean	actOnDangerousVariable(BatchSanitizerGlobalRule rule, EnvVars envVars, String variableName, String variableValue, String dangerousCharacter, EnvVarsFilterRuleContext context)
static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode	getDefault()
static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAIL

public static final BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode FAIL

Force the job to fail

REPLACE

public static final BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode REPLACE

Replace the dangerous variables by REDACTED

WARN

public static final BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode WARN

Just log the character and the name of the field (to avoid disclosing passwords / credentials)

Field Details

label

public final org.jvnet.localizer.Localizable label

Method Details

values

public static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDefault

public static BatchSanitizerGlobalRule.EnvironmentSanitizerStandardMode getDefault()

actOnDangerousVariable

public abstract boolean actOnDangerousVariable(BatchSanitizerGlobalRule rule,
 EnvVars envVars,
 String variableName,
 String variableValue,
 String dangerousCharacter,
 EnvVarsFilterRuleContext context)
                                        throws EnvVarsFilterException

Returns:

true if there is no need to go further with the dangerous characters

Throws:

EnvVarsFilterException