Package hudson.model
Class FileParameterValue
java.lang.Object
hudson.model.ParameterValue
hudson.model.FileParameterValue
- All Implemented Interfaces:
Serializable
- Author:
- Kohsuke Kawaguchi
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Deprecated.static final class
Default implementation fromFile
. -
Field Summary
Modifier and TypeFieldDescriptionstatic boolean
Escape hatch for SECURITY-1074, fileParameter used to escape their expected folder.Fields inherited from class hudson.model.ParameterValue
name
-
Constructor Summary
ModifierConstructorDescriptionFileParameterValue
(String name, File file, String originalFileName) FileParameterValue
(String name, org.apache.commons.fileupload.FileItem file) Deprecated.FileParameterValue
(String name, org.apache.commons.fileupload2.core.FileItem file) protected
FileParameterValue
(String name, org.apache.commons.fileupload2.core.FileItem file, String originalFileName) -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildEnvironment
(Run<?, ?> build, EnvVars env) Exposes the originalFileName as an environment variable.createBuildWrapper
(AbstractBuild<?, ?> build) Called at the beginning of a build (but afterSCM
operations have taken place) to let aParameterValue
contributes aBuildWrapper
to the build.createVariableResolver
(AbstractBuild<?, ?> build) Returns aVariableResolver
so that other components likeBuilder
s can perform variable substitution to reflect parameter values into the build process.doDynamic
(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response) Serve this file parameter in response to aStaplerRequest2
.boolean
Compares file parameters (existing files will be considered as different).org.apache.commons.fileupload.FileItem
getFile()
Deprecated.usegetFile2()
org.apache.commons.fileupload2.core.FileItem
getFile2()
Get the name of the originally uploaded file.Computes a human-readable possible-localized one-line description of the parameter value.getValue()
Returns the most natural Java object that represents the actual value, like boolean, string, etc.int
hashCode()
protected void
setLocation
(String location) toString()
Methods inherited from class hudson.model.ParameterValue
buildEnvVars, buildEnvVars, getAssignedLabel, getDefinition, getDescription, getFormattedDescription, getName, isSensitive, setDescription
-
Field Details
-
ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACEEscape hatch for SECURITY-1074, fileParameter used to escape their expected folder. It's not recommended to enable for security reasons. That option is only present for backward compatibility.
-
-
Constructor Details
-
FileParameterValue
@DataBoundConstructor public FileParameterValue(String name, org.apache.commons.fileupload2.core.FileItem file) -
FileParameterValue
Deprecated. -
FileParameterValue
-
FileParameterValue
-
-
Method Details
-
setLocation
-
getLocation
-
getValue
Description copied from class:ParameterValue
Returns the most natural Java object that represents the actual value, like boolean, string, etc.- Overrides:
getValue
in classParameterValue
- Returns:
- if there is no natural value for this parameter type,
this
may be used;null
may be used when the value is normally defined but missing in this case for various reasons
-
buildEnvironment
Exposes the originalFileName as an environment variable.- Overrides:
buildEnvironment
in classParameterValue
- Parameters:
build
- The build for which this parameter is being used. Never null.env
- never null.
-
createVariableResolver
Description copied from class:ParameterValue
Returns aVariableResolver
so that other components likeBuilder
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.- Overrides:
createVariableResolver
in classParameterValue
- Parameters:
build
- The build for which this parameter is being used. Never null.- Returns:
- if the parameter value is not interested in participating to the
variable replacement process, return
VariableResolver.NONE
.
-
getOriginalFileName
Get the name of the originally uploaded file. If thisFileParameterValue
was created prior to 1.362, this method will returnnull
.- Returns:
- the name of the originally uploaded file
-
getFile2
public org.apache.commons.fileupload2.core.FileItem getFile2() -
getFile
Deprecated.usegetFile2()
-
createBuildWrapper
Description copied from class:ParameterValue
Called at the beginning of a build (but afterSCM
operations have taken place) to let aParameterValue
contributes aBuildWrapper
to the build.This provides a means for a parameter to perform more extensive set up / tear down during a build.
- Overrides:
createBuildWrapper
in classParameterValue
- Parameters:
build
- The build for which this parameter is being used. Never null.- Returns:
- null if the parameter has no
BuildWrapper
to contribute to.
-
hashCode
public int hashCode()- Overrides:
hashCode
in classParameterValue
-
equals
Compares file parameters (existing files will be considered as different).- Overrides:
equals
in classParameterValue
- Since:
- 1.586 Function has been modified in order to avoid JENKINS-19017 issue (wrong merge of builds in the queue).
-
toString
-
getShortDescription
Description copied from class:ParameterValue
Computes a human-readable possible-localized one-line description of the parameter value.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.)
- Overrides:
getShortDescription
in classParameterValue
-
doDynamic
public DirectoryBrowserSupport doDynamic(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response) Serve this file parameter in response to aStaplerRequest2
.
-
FileParameterValue.FileItemImpl2