Package hudson.model

Class FileParameterValue

    • Field Detail


        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 Detail

      • FileParameterValue

        public FileParameterValue​(String name,
                                  org.apache.commons.fileupload.FileItem file)
      • FileParameterValue

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

        protected FileParameterValue​(String name,
                                     org.apache.commons.fileupload.FileItem file,
                                     String originalFileName)
    • Method Detail

      • 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.
        getValue in class ParameterValue
        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.
        buildEnvironment in class ParameterValue
        build - The build for which this parameter is being used. Never null.
        env - never null.
      • 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.
        the name of the originally uploaded file
      • getFile

        public org.apache.commons.fileupload.FileItem getFile()
      • 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.

        createBuildWrapper in class ParameterValue
        build - The build for which this parameter is being used. Never null.
        null if the parameter has no BuildWrapper to contribute to.
      • equals

        public boolean equals​(Object obj)
        Compares file parameters (existing files will be considered as different).
        equals in class ParameterValue
        1.586 Function has been modified in order to avoid JENKINS-19017 issue (wrong merge of builds in the queue).
      • 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.)

        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.