io.jenkins.plugins.file_parameters

Class AbstractFileParameterValue

java.lang.Object

hudson.model.ParameterValue

io.jenkins.plugins.file_parameters.AbstractFileParameterValue

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Base64FileParameterValue, StashedFileParameterValue

public abstract class AbstractFileParameterValue
extends ParameterValue

Implement either open(hudson.model.Run<?, ?>) and/or createTempFile(hudson.model.Run<?, ?>, hudson.FilePath, hudson.EnvVars, hudson.Launcher, hudson.model.TaskListener).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	filename

Fields inherited from class hudson.model.ParameterValue

name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileParameterValue(String name)

Method Summary

Modifier and Type	Method and Description
void	buildEnvironment(Run<?,?> build, EnvVars env)
protected FilePath	createTempFile(Run<?,?> build, FilePath tempDir, EnvVars env, Launcher launcher, TaskListener listener)
void	doDownload(Run<?,?> build, org.kohsuke.stapler.StaplerResponse rsp)
protected InputStream	open(Run<?,?> build)

Methods inherited from class hudson.model.ParameterValue

buildEnvVars, buildEnvVars, createBuildWrapper, createVariableResolver, equals, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, getShortDescription, getValue, hashCode, isSensitive, setDescription

Methods inherited from class java.lang.Object

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

Field Detail

filename

@CheckForNull
public String filename

Constructor Detail

AbstractFileParameterValue

protected AbstractFileParameterValue(String name)

Method Detail

open

protected InputStream open(@CheckForNull
                           Run<?,?> build)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

createTempFile

protected FilePath createTempFile(@NonNull
                                  Run<?,?> build,
                                  @NonNull
                                  FilePath tempDir,
                                  @NonNull
                                  EnvVars env,
                                  @NonNull
                                  Launcher launcher,
                                  @NonNull
                                  TaskListener listener)
                           throws IOException,
                                  InterruptedException

Throws:

IOException

InterruptedException

doDownload

public void doDownload(@AncestorInPath
                       Run<?,?> build,
                       org.kohsuke.stapler.StaplerResponse rsp)
                throws Exception

Throws:

Exception

buildEnvironment

public void buildEnvironment(Run<?,?> build,
                             EnvVars env)

Overrides:

buildEnvironment in class ParameterValue