Package jenkins.mvn

Class SettingsProvider

java.lang.Object

jenkins.mvn.SettingsProvider

All Implemented Interfaces:

ExtensionPoint, Describable<SettingsProvider>

Direct Known Subclasses:

DefaultSettingsProvider, FilePathSettingsProvider

public abstract class SettingsProvider
extends Object
implements Describable<SettingsProvider>, ExtensionPoint

Since:

1.491

Author:

Nicolas De Loof, Dominik Bartholdi (imod)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
SettingsProvider()

Method Summary

Modifier and Type	Method	Description
static FilePath	getSettingsFilePath(SettingsProvider settings, AbstractBuild<?,?> build, TaskListener listener)	Convenience method handling all null checks.
static String	getSettingsRemotePath(SettingsProvider settings, AbstractBuild<?,?> build, TaskListener listener)	Convenience method handling all null checks.
static SettingsProvider	parseSettingsProvider(org.kohsuke.stapler.StaplerRequest req)	Deprecated. use parseSettingsProvider(StaplerRequest2)
static SettingsProvider	parseSettingsProvider(org.kohsuke.stapler.StaplerRequest2 req)
abstract FilePath	supplySettings(AbstractBuild<?,?> build, TaskListener listener)	Configure maven launcher argument list with adequate settings path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

SettingsProvider

public SettingsProvider()

Method Details

supplySettings

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

Configure maven launcher argument list with adequate settings path. Implementations should be aware that this method might get called multiple times during a build.

Returns:

the filepath to the provided file. null if no settings will be provided.

parseSettingsProvider

public static SettingsProvider parseSettingsProvider(org.kohsuke.stapler.StaplerRequest2 req)
                                              throws Descriptor.FormException,
jakarta.servlet.ServletException

Throws:

Descriptor.FormException

jakarta.servlet.ServletException

parseSettingsProvider

@Deprecated
public static SettingsProvider parseSettingsProvider(org.kohsuke.stapler.StaplerRequest req)
                                              throws Descriptor.FormException,
javax.servlet.ServletException

Deprecated.

use parseSettingsProvider(StaplerRequest2)

Throws:

Descriptor.FormException

javax.servlet.ServletException

getSettingsFilePath

public static FilePath getSettingsFilePath(SettingsProvider settings,
 AbstractBuild<?,?> build,
 TaskListener listener)

Convenience method handling all null checks. Provides the path on the (possible) remote settings file.

Parameters:

settings - the provider to be used

build - the active build

listener - the listener of the current build

Returns:

the path to the settings.xml

getSettingsRemotePath

public static String getSettingsRemotePath(SettingsProvider settings,
 AbstractBuild<?,?> build,
 TaskListener listener)

Convenience method handling all null checks. Provides the path on the (possible) remote settings file.

Parameters:

settings - the provider to be used

build - the active build

listener - the listener of the current build

Returns:

the path to the settings.xml