/*
* The MIT License
*
* Copyright (c) 2004-2009, Sun Microsystems, Inc., Tom Huybrechts
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.tools;
import hudson.model.Descriptor;
import hudson.util.DescribableList;
import hudson.util.FormValidation;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Array;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.Collections;
import java.util.List;
import jenkins.model.GlobalConfigurationCategory;
import jenkins.model.Jenkins;
import jenkins.tools.ToolConfigurationCategory;
import net.sf.json.JSONObject;
import org.jvnet.tiger_types.Types;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
/**
* {@link Descriptor} for {@link ToolInstallation}.
*
* @author huybrechts
* @since 1.286
*/
public abstract class ToolDescriptor<T extends ToolInstallation> extends Descriptor<ToolInstallation> {
private T[] installations;
/**
* Configured instances of {@link ToolInstallation}s.
*
* @return read-only list of installations;
* can be empty but never null.
*/
public T[] getInstallations() {
if (installations != null)
return installations.clone();
Type bt = Types.getBaseClass(getClass(), ToolDescriptor.class);
if (bt instanceof ParameterizedType) {
ParameterizedType pt = (ParameterizedType) bt;
// this 't' is the closest approximation of T of Descriptor<T>.
Class t = Types.erasure(pt.getActualTypeArguments()[0]);
return (T[])Array.newInstance(t,0);
} else {
// can't infer the type. fallacbk
return (T[])new Object[0];
}
}
/**
* Overwrites {@link ToolInstallation}s.
*
* @param installations list of installations;
* can be empty but never null.
*/
public void setInstallations(T... installations) {
this.installations = installations.clone();
}
/**
* Lists up {@link ToolPropertyDescriptor}s that are applicable to this {@link ToolInstallation}.
*/
public List<ToolPropertyDescriptor> getPropertyDescriptors() {
return PropertyDescriptor.for_(ToolProperty.all(),clazz);
}
@Override
public GlobalConfigurationCategory getCategory() {
return GlobalConfigurationCategory.get(ToolConfigurationCategory.class);
}
/**
* 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
*/
public List<? extends ToolInstaller> getDefaultInstallers() {
return Collections.emptyList();
}
/**
* Default value for {@link ToolInstallation#getProperties()} used in the form binding.
* @since 1.305
*/
public DescribableList<ToolProperty<?>,ToolPropertyDescriptor> getDefaultProperties() throws IOException {
DescribableList<ToolProperty<?>,ToolPropertyDescriptor> r
= new DescribableList<ToolProperty<?>, ToolPropertyDescriptor>(NOOP);
List<? extends ToolInstaller> installers = getDefaultInstallers();
if(!installers.isEmpty())
r.add(new InstallSourceProperty(installers));
return r;
}
@Override
@SuppressWarnings("unchecked") // cast to T[]
public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
setInstallations(req.bindJSONToList(clazz, json.get("tool")).toArray((T[]) Array.newInstance(clazz, 0)));
return true;
}
/**
* Checks if the home directory is valid.
* @since 1.563
*/
public FormValidation doCheckHome(@QueryParameter File value) {
// this can be used to check the existence of a file on the server, so needs to be protected
Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
if (value.getPath().isEmpty()) {
return FormValidation.ok();
}
if (!value.isDirectory()) {
return FormValidation.warning(Messages.ToolDescriptor_NotADirectory(value));
}
return checkHomeDirectory(value);
}
/**
* May be overridden to provide tool-specific validation of a tool home directory.
* @param home a possible value for {@link ToolInstallation#getHome}, known to already exist on the master
* @return by default, {@link FormValidation#ok()}
* @since 1.563
*/
protected FormValidation checkHomeDirectory(File home) {
return FormValidation.ok();
}
/**
* Checks if the tool name is valid.
* @since 1.563
*/
public FormValidation doCheckName(@QueryParameter String value) {
return FormValidation.validateRequired(value);
}
}