Package hudson.model

Class FileParameterValue

java.lang.Object
hudson.model.ParameterValue
hudson.model.FileParameterValue
All Implemented Interfaces:
Serializable
public class FileParameterValue extends ParameterValue
ParameterValue for FileParameterDefinition.
Author:
Kohsuke Kawaguchi
See Also:

  • Field Details

    • ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE
      Escape 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 public FileParameterValue(String name, org.apache.commons.fileupload.FileItem file)
      Deprecated.
      use FileParameterValue(String, FileItem)

    • FileParameterValue

      public FileParameterValue(String name, File file, String originalFileName)

    • FileParameterValue

      protected FileParameterValue(String name, org.apache.commons.fileupload2.core.FileItem file, String originalFileName)

  • Method Details

    • setLocation

      protected void setLocation(String location)

    • getLocation

      public String getLocation()

    • getValue

      public Object getValue()
      Description copied from class: ParameterValue
      Returns the most natural Java object that represents the actual value, like boolean, string, etc.
      Overrides:
      getValue in class ParameterValue
      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

      public void buildEnvironment(Run<?,?> build, EnvVars env)
      Exposes the originalFileName as an environment variable.
      Overrides:
      buildEnvironment in class ParameterValue
      Parameters:
      build - The build for which this parameter is being used. Never null.
      env - never null.

    • createVariableResolver

      public VariableResolver<String> createVariableResolver(AbstractBuild<?,?> build)
      Description copied from class: ParameterValue
      Returns a VariableResolver so that other components like Builders 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 class ParameterValue
      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

      public String getOriginalFileName()
      Get the name of the originally uploaded file. If this FileParameterValue was created prior to 1.362, this method will return null.
      Returns:
      the name of the originally uploaded file

    • getFile2

      public org.apache.commons.fileupload2.core.FileItem getFile2()

    • getFile

      @Deprecated public org.apache.commons.fileupload.FileItem getFile()
      Deprecated.
      use getFile2()

    • createBuildWrapper

      public BuildWrapper createBuildWrapper(AbstractBuild<?,?> build)
      Description copied from class: ParameterValue
      Called at the beginning of a build (but after 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.

      Overrides:
      createBuildWrapper in class ParameterValue
      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 class ParameterValue

    • equals

      public boolean equals(Object obj)
      Compares file parameters (existing files will be considered as different).
      Overrides:
      equals in class ParameterValue
      Since:
      1.586 Function has been modified in order to avoid JENKINS-19017 issue (wrong merge of builds in the queue).

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getShortDescription

      public String 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 class ParameterValue

    • doDynamic

      public DirectoryBrowserSupport doDynamic(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
      Serve this file parameter in response to a StaplerRequest.