Package hudson.tools

Class ToolDescriptor<T extends ToolInstallation>

java.lang.Object

hudson.model.Descriptor<ToolInstallation>

hudson.tools.ToolDescriptor<T>

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

JDK.DescriptorImpl, Maven.MavenInstallation.DescriptorImpl

public abstract class ToolDescriptor<T extends ToolInstallation>
extends Descriptor<ToolInstallation>

Descriptor for ToolInstallation.

Since:

1.286

Author:

huybrechts

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToolDescriptor()
protected	ToolDescriptor(Class<T> clazz)

Method Summary

Modifier and Type	Method	Description
protected FormValidation	checkHomeDirectory(File home)	May be overridden to provide tool-specific validation of a tool home directory.
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)	Invoked when the global configuration page is submitted.
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)	Deprecated. use configure(StaplerRequest2, JSONObject)
FormValidation	doCheckHome(File value)	Checks if the home directory is valid.
FormValidation	doCheckName(String value)	Checks if the tool name is valid.
GlobalConfigurationCategory	getCategory()	Define the global configuration category the global config of this Descriptor is in.
List<? extends ToolInstaller>	getDefaultInstallers()	Optional list of installers to be configured by default for new tools of this type.
DescribableList<ToolProperty<?>,ToolPropertyDescriptor>	getDefaultProperties()	Default value for ToolInstallation.getProperties() used in the form binding.
T[]	getInstallations()	Configured instances of ToolInstallations.
List<ToolPropertyDescriptor>	getPropertyDescriptors()	Lists up ToolPropertyDescriptors that are applicable to this ToolInstallation.
void	setInstallations(T... installations)	Overwrites ToolInstallations.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

ToolDescriptor

protected ToolDescriptor()

ToolDescriptor

protected ToolDescriptor(Class<T> clazz)

Since:

2.102

Method Details

getInstallations

public T[] getInstallations()

Configured instances of ToolInstallations.

Returns:

read-only list of installations; can be empty but never null.

setInstallations

public void setInstallations(T... installations)

Overwrites ToolInstallations.

Parameters:

installations - list of installations; can be empty but never null.

getPropertyDescriptors

public List<ToolPropertyDescriptor> getPropertyDescriptors()

Lists up ToolPropertyDescriptors that are applicable to this ToolInstallation.

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Description copied from class: Descriptor

Define the global configuration category the global config of this Descriptor is in.

Overrides:

getCategory in class Descriptor<ToolInstallation>

Returns:

never null, always the same value for a given instance of Descriptor.

getDefaultInstallers

public List<? extends ToolInstaller> getDefaultInstallers()

Optional list of installers to be configured by default for new tools of this type. If there are popular versions of the tool available using generic installation techniques, they can be returned here for the user's convenience.

Since:

1.305

getDefaultProperties

public DescribableList<ToolProperty<?>,ToolPropertyDescriptor> getDefaultProperties()
                                                                             throws IOException

Default value for ToolInstallation.getProperties() used in the form binding.

Throws:

IOException

Since:

1.305

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Description copied from class: Descriptor

Invoked when the global configuration page is submitted. Can be overridden to store descriptor-specific information.

Overrides:

configure in class Descriptor<ToolInstallation>

json - The JSON object that captures the configuration data for this Descriptor. See the developer documentation.

Returns:

false to keep the client in the same config page.

Throws:

Descriptor.FormException

configure

@Deprecated
public boolean configure(org.kohsuke.stapler.StaplerRequest req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Deprecated.

use configure(StaplerRequest2, JSONObject)

Overrides:

configure in class Descriptor<ToolInstallation>

Throws:

Descriptor.FormException

doCheckHome

public FormValidation doCheckHome(@QueryParameter
 File value)

Checks if the home directory is valid.

Since:

1.563

checkHomeDirectory

protected FormValidation checkHomeDirectory(File home)

May be overridden to provide tool-specific validation of a tool home directory.

Parameters:

home - a possible value for ToolInstallation.getHome(), known to already exist on the controller TODO(terminology) or is it built-in?

Returns:

by default, FormValidation.ok()

Since:

1.563

doCheckName

public FormValidation doCheckName(@QueryParameter
 String value)

Checks if the tool name is valid.

Since:

1.563