Package org.jenkinsci.plugins.configfiles.maven.job

Class MvnSettingsProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<SettingsProvider>

jenkins.mvn.SettingsProvider

org.jenkinsci.plugins.configfiles.maven.job.MvnSettingsProvider

All Implemented Interfaces:

ExtensionPoint, Describable<SettingsProvider>

public class MvnSettingsProvider
extends SettingsProvider

This provider delivers the settings.xml to the job during job/project execution.
Important: Do not rename this class!! For backward compatibility, this class is also created via reflection from the maven-plugin.

Author:

Dominik Bartholdi (imod)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MvnSettingsProvider.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MvnSettingsProvider()	Deprecated.
MvnSettingsProvider(String settingsConfigId)

Method Summary

Modifier and Type	Method	Description
List<String>	getSensitiveContentForMasking(AbstractBuild<?,?> build)	Obtain a list of sensitive Strings to mask for the given provider and build.
String	getSettingsConfigId()
void	setSettingsConfigId(String settingsConfigId)
FilePath	supplySettings(AbstractBuild<?,?> build, TaskListener listener)

Methods inherited from class jenkins.mvn.SettingsProvider

getSettingsFilePath, getSettingsRemotePath, parseSettingsProvider

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

MvnSettingsProvider

@Deprecated
public MvnSettingsProvider()

Deprecated.

Default constructor used to load class via reflection by the maven-plugin for backward compatibility

MvnSettingsProvider

@DataBoundConstructor
public MvnSettingsProvider(String settingsConfigId)

Method Details

getSettingsConfigId

public String getSettingsConfigId()

setSettingsConfigId

public void setSettingsConfigId(String settingsConfigId)

supplySettings

public FilePath supplySettings(AbstractBuild<?,?> build,
 TaskListener listener)

Specified by:

supplySettings in class SettingsProvider

getSensitiveContentForMasking

@NonNull
public List<String> getSensitiveContentForMasking(AbstractBuild<?,?> build)

Obtain a list of sensitive Strings to mask for the given provider and build. For example if a UsernamePasswordCredentials credential is being injected into the file then the password (and possibly the username) would need to be masked and should be returned here.

Returns:

List of Strings that need to be masked in the console.