Class HTTPFileArg

    • Constructor Detail

      • HTTPFileArg

        public HTTPFileArg()
        Constructor for an empty HTTPFileArg object
      • HTTPFileArg

        public HTTPFileArg​(String path)
        Constructor for the HTTPFileArg object with given path.
        Parameters:
        path - path to the file to use
        Throws:
        IllegalArgumentException - if path is null
      • HTTPFileArg

        public HTTPFileArg​(String path,
                           String paramname,
                           String mimetype)
        Constructor for the HTTPFileArg object with full information.
        Parameters:
        path - path of the file to use
        paramname - name of the http parameter to use for the file
        mimetype - mimetype of the file
        Throws:
        IllegalArgumentException - if any parameter is null
      • HTTPFileArg

        public HTTPFileArg​(JMeterProperty path,
                           JMeterProperty paramname,
                           JMeterProperty mimetype)
        Constructor for the HTTPFileArg object with full information, using existing properties
        Parameters:
        path - path of the file to use
        paramname - name of the http parameter to use for the file
        mimetype - mimetype of the file
        Throws:
        IllegalArgumentException - if any parameter is null
      • HTTPFileArg

        public HTTPFileArg​(HTTPFileArg file)
        Copy Constructor.
        Parameters:
        file - HTTPFileArg to get information about the path, http parameter name and mimetype of the file
        Throws:
        IllegalArgumentException - if any of those retrieved information is null
    • Method Detail

      • setParamName

        public void setParamName​(String newParamName)
        Set the http parameter name of the File.
        Parameters:
        newParamName - the new http parameter name
      • getParamName

        public String getParamName()
        Get the http parameter name of the File.
        Returns:
        the http parameter name
      • setMimeType

        public void setMimeType​(String newMimeType)
        Set the mimetype of the File.
        Parameters:
        newMimeType - the new mimetype
      • getMimeType

        public String getMimeType()
        Get the mimetype of the File.
        Returns:
        the http parameter mimetype
      • setPath

        public void setPath​(String newPath)
        Set the path of the File.
        Parameters:
        newPath - the new path
      • getPath

        public String getPath()
        Get the path of the File.
        Returns:
        the file's path
      • setHeader

        public void setHeader​(String newHeader)
        Sets the body header for the HTTPFileArg object. Header contains path, parameter name and mime type information. This is only intended for use by methods which need to store information temporarily whilst creating the HTTP body.
        Parameters:
        newHeader - the new Header value
      • getHeader

        public String getHeader()
        Gets the saved body header for the HTTPFileArg object.
        Returns:
        saved body header
      • toString

        public String toString()
        returns path, param name, mime type information of HTTPFileArg object.
        Overrides:
        toString in class Object
        Returns:
        the string demonstration of HTTPFileArg object in this format: "path:'<PATH>'|param:'<PARAM NAME>'|mimetype:'<MIME TYPE>'"
      • isNotEmpty

        public boolean isNotEmpty()
        Check if the entry is not empty.
        Returns:
        true if Path, name or mimetype fields are not the empty string