Class HTTPFileArgs
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.config.ConfigTestElement
org.apache.jmeter.protocol.http.util.HTTPFileArgs
- All Implemented Interfaces:
Serializable,Cloneable,ConfigElement,Searchable,org.apache.jmeter.testelement.TestElement
A set of HTTPFileArg objects.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement
org.apache.jmeter.testelement.TestElement.Companion -
Field Summary
Fields inherited from class org.apache.jmeter.config.ConfigTestElement
PASSWORD, USERNAMEFields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a new empty file to the list.voidaddHTTPFileArg(String path) Add a new file with the given path.voidaddHTTPFileArg(String path, String param, String mime) adds a new File to the HTTPFileArgs list to be uploaded with http request.voidaddHTTPFileArg(HTTPFileArg file) Add a new file.asArray()Get the current arguments as an array.voidclear()Clear the files.getHTTPFileArg(int row) Get a single file.intGet the number of files in the list.Get the files.org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends HTTPFileArgs,? extends org.apache.jmeter.protocol.http.util.HTTPFileArgsSchema> getProps()org.apache.jmeter.protocol.http.util.HTTPFileArgsSchemaiterator()Get a PropertyIterator of the files.voidRemove all files from the list.voidremoveHTTPFileArg(int row) Remove the specified file from the list.voidremoveHTTPFileArg(String filePath) Remove the file with the specified path.voidremoveHTTPFileArg(HTTPFileArg file) Remove the specified file from the list.voidsetHTTPFileArgs(List<HTTPFileArg> files) Set the list of files.toString()Create a string representation of the files.Methods inherited from class org.apache.jmeter.config.ConfigTestElement
addConfigElement, addTestElement, expectsModificationMethods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, canRemove, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traversePropertyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.jmeter.config.ConfigElement
cloneMethods inherited from interface org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getPropertyOrNull, getString, removed, removeProperty, set, set, set, set, set, set, set, set, set
-
Constructor Details
-
HTTPFileArgs
public HTTPFileArgs()Create a new HTTPFileArgs object with no files.
-
-
Method Details
-
getSchema
public org.apache.jmeter.protocol.http.util.HTTPFileArgsSchema getSchema()- Specified by:
getSchemain interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
getSchemain classConfigTestElement
-
getProps
public org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends HTTPFileArgs,? extends org.apache.jmeter.protocol.http.util.HTTPFileArgsSchema> getProps()- Specified by:
getPropsin interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
getPropsin classConfigTestElement
-
getHTTPFileArgsCollection
Get the files.- Returns:
- the files
-
clear
public void clear()Clear the files.- Specified by:
clearin interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
clearin classAbstractTestElement
-
setHTTPFileArgs
Set the list of files. Any existing files will be lost.- Parameters:
files- the new files
-
addHTTPFileArg
Add a new file with the given path.- Parameters:
path- the path of the file
-
addHTTPFileArg
Add a new file.- Parameters:
file- the new file
-
addHTTPFileArg
adds a new File to the HTTPFileArgs list to be uploaded with http request.- Parameters:
path- file full path.param- http parameter name.mime- mime type of file.
-
iterator
Get a PropertyIterator of the files.- Returns:
- an iteration of the files
-
asArray
Get the current arguments as an array.- Returns:
- an array of file arguments
-
toString
Create a string representation of the files. -
removeHTTPFileArg
public void removeHTTPFileArg(int row) Remove the specified file from the list.- Parameters:
row- the index of the file to remove
-
removeHTTPFileArg
Remove the specified file from the list.- Parameters:
file- the file to remove
-
removeHTTPFileArg
Remove the file with the specified path.- Parameters:
filePath- the path of the file to remove
-
removeAllHTTPFileArgs
public void removeAllHTTPFileArgs()Remove all files from the list. -
addEmptyHTTPFileArg
public void addEmptyHTTPFileArg()Add a new empty file to the list. The new file will have the empty string as its path. -
getHTTPFileArgCount
public int getHTTPFileArgCount()Get the number of files in the list.- Returns:
- the number of files
-
getHTTPFileArg
Get a single file.- Parameters:
row- the index of the file to return.- Returns:
- the file at the specified index, or null if no file exists at that index.
-