added file parameter type and added help for all parameter types.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@12249 71c3de6d-444a-0410-be80-ed276b4c234a
This commit is contained in:
kohsuke committed 2008-09-20 18:06:59 +00:00
1 parent b433a9776a
commit d6139d2a06
15 files changed
+181 -24

No files matched your search

@@ -0,0 +1,49 @@
package hudson.model;
import net.sf.json.JSONObject;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
/**
* {@link ParameterDefinition} for doing file upload.
*
* <p>
* The file will be then placed into the workspace at the beginning of a build.
*
* @author Kohsuke Kawaguchi
*/
public class FileParameterDefinition extends ParameterDefinition {
@DataBoundConstructor
public FileParameterDefinition(String name) {
super(name);
}
public ParameterDescriptor getDescriptor() {
return DESCRIPTOR;
}
public FileParameterValue createValue(StaplerRequest req, JSONObject jo) {
FileParameterValue p = req.bindJSON(FileParameterValue.class, jo);
p.setLocation(getName());
return p;
}
public static final ParameterDescriptor DESCRIPTOR = new DescriptorImpl();
public static class DescriptorImpl extends ParameterDescriptor {
protected DescriptorImpl() {
super(FileParameterDefinition.class);
}
@Override
public String getDisplayName() {
return "File Parameter";
}
@Override
public String getHelpFile() {
return "/help/parameter/file.html";
}
}
}
@@ -0,0 +1,53 @@
package hudson.model;
import org.kohsuke.stapler.DataBoundConstructor;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItem;
import hudson.tasks.BuildWrapper;
import hudson.Launcher;
import java.io.IOException;
/**
* {@link ParameterValue} for {@link FileParameterDefinition}.
*
* <h2>Persistence</h2>
* <p>
* {@link DiskFileItem} is persistable via serialization,
* (although the data may get very large in XML) so this object
* as a whole is persistable.
*
* @author Kohsuke Kawaguchi
*/
public class FileParameterValue extends ParameterValue {
private FileItem file;
private String location;
@DataBoundConstructor
public FileParameterValue(String name, FileItem file) {
super(name);
assert file!=null;
this.file = file;
}
// post initialization hook
/*package*/ void setLocation(String location) {
this.location = location;
}
public BuildWrapper createBuildWrapper(AbstractBuild<?,?> build) {
return new BuildWrapper() {
public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener listener) throws IOException, InterruptedException {
listener.getLogger().println("Copying file to "+location);
build.getProject().getWorkspace().child(location).copyFrom(file);
file = null;
return new Environment() {};
}
public Descriptor<BuildWrapper> getDescriptor() {
return null;
}
};
}
}
@@ -113,4 +113,17 @@ public abstract class ParameterValue {
public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build) {
return VariableResolver.NONE;
}
/**
* Accessing {@link ParameterDefinition} is not a good idea.
*
* @deprecated
* parameter definition may change any time. So if you find yourself
* in need of accessing the information from {@link ParameterDefinition},
* instead copy them in {@link ParameterDefinition#createValue(StaplerRequest, JSONObject)}
* into {@link ParameterValue}.
*/
public ParameterDefinition getDefinition() {
throw new UnsupportedOperationException();
}
}
@@ -12,11 +12,10 @@ import java.util.List;
*/
public class ParameterizedProjectTask extends QueueTaskFilter {
private final AbstractProject<?, ?> project;
private final AbstractProject<?,?> project;
private final List<ParameterValue> parameters;
public ParameterizedProjectTask(AbstractProject<?, ?> project,
List<ParameterValue> parameters) {
public ParameterizedProjectTask(AbstractProject<?,?> project, List<ParameterValue> parameters) {
super(project);
this.project = project;
this.parameters = parameters;
@@ -148,5 +148,6 @@ public class ParametersDefinitionProperty extends JobProperty<AbstractProject<?,
static {
ParameterDefinition.LIST.add(StringParameterDefinition.DESCRIPTOR);
ParameterDefinition.LIST.add(FileParameterDefinition.DESCRIPTOR);
}
}
@@ -10,15 +10,12 @@ import org.kohsuke.stapler.StaplerRequest;
*/
public class StringParameterDefinition extends ParameterDefinition {
private boolean optional;
private String defaultValue;
@DataBoundConstructor
public StringParameterDefinition(String name, String defaultValue,
boolean optional) {
public StringParameterDefinition(String name, String defaultValue) {
super(name);
this.defaultValue = defaultValue;
this.optional = optional;
}
@Override
@@ -26,14 +23,6 @@ public class StringParameterDefinition extends ParameterDefinition {
return DESCRIPTOR;
}
public boolean isOptional() {
return optional;
}
public void setOptional(boolean optional) {
this.optional = optional;
}
public String getDefaultValue() {
return defaultValue;
}
@@ -60,11 +49,9 @@ public class StringParameterDefinition extends ParameterDefinition {
}
@Override
public ParameterDefinition newInstance(StaplerRequest req,
JSONObject formData) throws FormException {
return req.bindJSON(StringParameterDefinition.class, formData);
public String getHelpFile() {
return "/help/parameter/string.html";
}
}
@Override