hudson.model.ParametersDefinitionProperty Maven / Gradle / Ivy

Go to download
package hudson.model;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import net.sf.json.JSONArray;
import net.sf.json.JSONObject;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

import javax.servlet.ServletException;

/**
 * Keeps a list of the parameters defined for a project.
 *
 * 
 * This class also implements {@link Action} so that index.jelly provides
 * a form to enter build parameters. 
 */
public class ParametersDefinitionProperty extends JobProperty>
        implements Action {

    private final List parameterDefinitions;

    public ParametersDefinitionProperty(List parameterDefinitions) {
        this.parameterDefinitions = parameterDefinitions;
    }

    public AbstractProject getOwner() {
        return owner;
    }

    public List getParameterDefinitions() {
        return parameterDefinitions;
    }

    @Override
    public Action getJobAction(AbstractProject job) {
        return this;
    }

    public AbstractProject getProject() {
        return (AbstractProject) owner;
    }

    /**
     * Interprets the form submission and schedules a build for a parameterized job.
     *
     * 
     * This method is supposed to be invoked from {@link AbstractProject#doBuild(StaplerRequest, StaplerResponse)}.
     */
    public void _doBuild(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        if(!req.getMethod().equals("POST")) {
            // show the parameter entry form.
            req.getView(this,"index.jelly").forward(req,rsp);
            return;
        }

        List values = new ArrayList();

        JSONObject formData = req.getSubmittedForm();
        JSONArray a = JSONArray.fromObject(formData.get("parameter"));

        for (Object o : a) {
            JSONObject jo = (JSONObject) o;
            String name = jo.getString("name");

            ParameterDefinition d = getParameterDefinition(name);
            if(d==null)
                throw new IllegalArgumentException("No such parameter definition: " + name);
            values.add(d.createValue(req, jo));
        }

        Hudson.getInstance().getQueue().add(
                new ParameterizedProjectTask(owner, values), 0);

        // send the user back to the job top page.
        rsp.sendRedirect(".");
    }

    /**
     * Gets the {@link ParameterDefinition} of the given name, if any.
     */
    public ParameterDefinition getParameterDefinition(String name) {
        for (ParameterDefinition pd : parameterDefinitions)
            if (pd.getName().equals(name))
                return pd;
        return null;
    }

    @Override
    public JobPropertyDescriptor getDescriptor() {
        return DESCRIPTOR;
    }

    public static final JobPropertyDescriptor DESCRIPTOR = new DescriptorImpl();

    public static class DescriptorImpl extends JobPropertyDescriptor {

        protected DescriptorImpl() {
            super(ParametersDefinitionProperty.class);
        }

        @Override
        public boolean isApplicable(Class jobType) {
            return AbstractProject.class.isAssignableFrom(jobType);
        }

        @Override
        public JobProperty newInstance(StaplerRequest req,
                                          JSONObject formData) throws FormException {
            if (formData.isNullObject()) {
                return null;
            }

            List parameterDefinitions = Descriptor.newInstancesFromHeteroList(
                    req, formData, "parameter", ParameterDefinition.LIST);
            if(parameterDefinitions.isEmpty())
                return null;

            return new ParametersDefinitionProperty(parameterDefinitions);
        }

        @Override
        public String getDisplayName() {
            return "Parameters";
        }

    }

    @Override
    public String getDisplayName() {
        return null;
    }

    @Override
    public String getIconFileName() {
        return null;
    }

    @Override
    public String getUrlName() {
        return "parameters";
    }


    static {
        ParameterDefinition.LIST.add(StringParameterDefinition.DESCRIPTOR);
        ParameterDefinition.LIST.add(FileParameterDefinition.DESCRIPTOR);
    }
}