Package org.jenkinsci.plugins.credentialsbinding.masking

Interface SecretPatternFactory

All Superinterfaces:

ExtensionPoint

All Known Implementing Classes:

AlmquistShellSecretPatternFactory, Base64SecretPatternFactory, BashSecretPatternFactory, BatchSecretPatternFactory, DollarSecretPatternFactory, LiteralSecretPatternFactory

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public interface SecretPatternFactory
extends ExtensionPoint

Provides encoded forms to an input for use in masking those forms in logs. These are typically implemented to handle various shell quoting algorithms (sometimes confused with escaping) to pass literal string values to an interpreter.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
static ExtensionList<SecretPatternFactory>	all()	Returns all SecretPatternFactory extensions known at runtime.
Collection<String>	getEncodedForms(String input)	Returns a collection of alternative forms the given input may be encoded as in logs.

Method Details

getEncodedForms

@NonNull
Collection<String> getEncodedForms(@NonNull
 String input)

Returns a collection of alternative forms the given input may be encoded as in logs.

all

@NonNull
static ExtensionList<SecretPatternFactory> all()

Returns all SecretPatternFactory extensions known at runtime.