Package io.jenkins.plugins.dotnet
Class DotNetSDKInstaller
java.lang.Object
hudson.tools.ToolInstaller
io.jenkins.plugins.dotnet.DotNetSDKInstaller
- All Implemented Interfaces:
ExtensionPoint
,Describable<ToolInstaller>
A tool installer for downloading .NET SDK installation packages from
microsoft.com
.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A descriptor for a .NET SDK installer.Nested classes/interfaces inherited from class hudson.tools.ToolInstaller
ToolInstaller.ToolInstallerEntry, ToolInstaller.ToolInstallerList
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Field Summary
Fields inherited from class hudson.tools.ToolInstaller
tool
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the name of the .NET release containing the SDK to install.getSdk()
Gets the name of the SDK to install.getUrl()
Gets the URL for the download package of the SDK to install.Gets the name of the .NET version containing the SDK to install.boolean
Determines whether .NET preview releases should be made available for installation.performInstallation
(ToolInstallation tool, Node node, TaskListener log) Performs the installation for a .NET SDK, if not already done.void
setIncludePreview
(boolean includePreview) Determines whether .NET preview releases should be made available for installation.void
setRelease
(String release) Sets the name of the .NET release containing the SDK to install.void
Sets the name of the SDK to install.void
Sets the URL for the download package of the SDK to install.void
setVersion
(String version) Sets the name of the .NET version containing the SDK to install.Methods inherited from class hudson.tools.ToolInstaller
appliesTo, getDescriptor, getLabel, preferredLocation, setTool
-
Constructor Details
-
DotNetSDKInstaller
Creates a new .NET SDK installer.- Parameters:
label
- A label expression identifying the agent(s) for which the installer is suitable.
-
-
Method Details
-
performInstallation
@NonNull public FilePath performInstallation(@NonNull ToolInstallation tool, @NonNull Node node, @NonNull TaskListener log) throws IOException, InterruptedException Performs the installation for a .NET SDK, if not already done.- Specified by:
performInstallation
in classToolInstaller
- Parameters:
tool
- The SDK to install.node
- The agent on which the SDK should be installed.log
- The task listener to use for output.- Returns:
- The SDK's installation location.
- Throws:
IOException
- When an I/O error occurs during processing.InterruptedException
- When processing is interrupted.
-
isIncludePreview
public boolean isIncludePreview()Determines whether .NET preview releases should be made available for installation.- Returns:
true
if installation of .NET preview releases is allowed,false
otherwise.
-
setIncludePreview
@DataBoundSetter public void setIncludePreview(boolean includePreview) Determines whether .NET preview releases should be made available for installation.- Parameters:
includePreview
-true
to allow installation of .NET preview releases,false
otherwise.
-
getRelease
Gets the name of the .NET release containing the SDK to install.- Returns:
- The name of the .NET release containing the SDK to install.
-
setRelease
Sets the name of the .NET release containing the SDK to install.- Parameters:
release
- The name of the .NET release containing the SDK to install.
-
getSdk
Gets the name of the SDK to install.- Returns:
- The name of the SDK to install.
-
setSdk
Sets the name of the SDK to install.- Parameters:
sdk
- The name of the SDK to install.
-
getUrl
Gets the URL for the download package of the SDK to install.- Returns:
- The URL for the download package of the SDK to install.
-
setUrl
Sets the URL for the download package of the SDK to install.- Parameters:
url
- The URL for the download package of the SDK to install.
-
getVersion
Gets the name of the .NET version containing the SDK to install.- Returns:
- The name of the .NET version containing the SDK to install.
-
setVersion
Sets the name of the .NET version containing the SDK to install.- Parameters:
version
- The name of the .NET version containing the SDK to install.
-