public class FileParameterValue extends ParameterValue
ParameterValue
for FileParameterDefinition
.
DiskFileItem
is persistable via serialization,
(although the data may get very large in XML) so this object
as a whole is persistable.
Modifier and Type | Class and Description |
---|---|
static class |
FileParameterValue.FileItemImpl
Default implementation from
File . |
Modifier and Type | Field and Description |
---|---|
static boolean |
ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE
Escape hatch for SECURITY-1074, fileParameter used to escape their expected folder.
|
name
Modifier | Constructor and Description |
---|---|
|
FileParameterValue(String name,
org.apache.commons.fileupload.FileItem file) |
protected |
FileParameterValue(String name,
org.apache.commons.fileupload.FileItem file,
String originalFileName) |
|
FileParameterValue(String name,
File file,
String originalFileName) |
Modifier and Type | Method and Description |
---|---|
void |
buildEnvironment(Run<?,?> build,
EnvVars env)
Exposes the originalFileName as an environment variable.
|
BuildWrapper |
createBuildWrapper(AbstractBuild<?,?> build)
Called at the beginning of a build (but after
SCM operations
have taken place) to let a ParameterValue contributes a
BuildWrapper to the build. |
VariableResolver<String> |
createVariableResolver(AbstractBuild<?,?> build)
Returns a
VariableResolver so that other components like Builder s
can perform variable substitution to reflect parameter values into the build process. |
DirectoryBrowserSupport |
doDynamic(org.kohsuke.stapler.StaplerRequest request,
org.kohsuke.stapler.StaplerResponse response)
Serve this file parameter in response to a
StaplerRequest . |
boolean |
equals(Object obj)
Compares file parameters (existing files will be considered as different).
|
org.apache.commons.fileupload.FileItem |
getFile() |
String |
getLocation() |
String |
getOriginalFileName()
Get the name of the originally uploaded file.
|
String |
getShortDescription()
Computes a human-readable possible-localized one-line description of the parameter value.
|
Object |
getValue()
Returns the most natural Java object that represents the actual value, like
boolean, string, etc.
|
int |
hashCode() |
protected void |
setLocation(String location) |
String |
toString() |
buildEnvVars, buildEnvVars, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, isSensitive, setDescription
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE
@DataBoundConstructor public FileParameterValue(String name, org.apache.commons.fileupload.FileItem file)
protected void setLocation(String location)
public String getLocation()
public Object getValue()
ParameterValue
getValue
in class ParameterValue
this
may be used;
null
may be used when the value is normally defined but missing in this case for various reasonspublic void buildEnvironment(Run<?,?> build, EnvVars env)
buildEnvironment
in class ParameterValue
build
- The build for which this parameter is being used. Never null.env
- never null.public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)
ParameterValue
VariableResolver
so that other components like Builder
s
can perform variable substitution to reflect parameter values into the build process.
This is yet another means in which a ParameterValue
can influence
a build.
createVariableResolver
in class ParameterValue
build
- The build for which this parameter is being used. Never null.VariableResolver.NONE
.public String getOriginalFileName()
FileParameterValue
was created prior to 1.362, this method will
return null
.public org.apache.commons.fileupload.FileItem getFile()
public BuildWrapper createBuildWrapper(AbstractBuild<?,?> build)
ParameterValue
SCM
operations
have taken place) to let a ParameterValue
contributes a
BuildWrapper
to the build.
This provides a means for a parameter to perform more extensive set up / tear down during a build.
createBuildWrapper
in class ParameterValue
build
- The build for which this parameter is being used. Never null.BuildWrapper
to contribute to.public int hashCode()
hashCode
in class ParameterValue
public boolean equals(Object obj)
equals
in class ParameterValue
public String getShortDescription()
ParameterValue
This message is used as a tooltip to describe jobs in the queue. The text should be one line without new line. No HTML allowed (the caller will perform necessary HTML escapes, so any text can be returned.)
getShortDescription
in class ParameterValue
public DirectoryBrowserSupport doDynamic(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
StaplerRequest
.Copyright © 2004–2022. All rights reserved.