Class HTTPArgument
-
- All Implemented Interfaces:
-
java.io.Serializable,java.lang.Cloneable,org.apache.jmeter.gui.Searchable,org.apache.jmeter.testelement.TestElement
public class HTTPArgument extends Argument implements Serializable
-
-
Field Summary
Fields Modifier and Type Field Description public final static StringARG_NAMEpublic final static StringVALUEpublic final static StringDESCRIPTIONpublic final static StringMETADATApublic transient JMeterContextthreadContextpublic transient StringthreadNamepublic final static TestElement.CompanionCompanionpublic final static StringNAMEpublic final static StringGUI_CLASSpublic final static StringENABLEDpublic final static StringTEST_CLASSpublic final static StringCOMMENTS
-
Constructor Summary
Constructors Constructor Description HTTPArgument(String name, String value, String metadata)Constructor for the Argument object. HTTPArgument(String name, String value)Constructor for the Argument object. HTTPArgument(String name, String value, boolean alreadyEncoded)HTTPArgument(String name, String value, boolean alreadyEncoded, String contentEncoding)Construct a new HTTPArgument instance; alwaysEncoded is set to true. HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded)Construct a new HTTPArgument instance HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded, String contentEncoding)Construct a new HTTPArgument instance HTTPArgument(Argument arg)HTTPArgument()Constructor for the Argument object
-
Method Summary
Modifier and Type Method Description HTTPArgumentSchemagetSchema()PropertiesAccessor<out HTTPArgument, out HTTPArgumentSchema>getProps()voidsetUseEquals(boolean ue)booleanisUseEquals()voidsetContentType(String ct)StringgetContentType()voidsetAlwaysEncoded(boolean ae)booleanisAlwaysEncoded()voidsetName(String newName)Sets the Name attribute of the Argument object. StringgetEncodedValue()Get the argument value encoded using UTF-8 StringgetEncodedValue(String contentEncoding)Get the argument value encoded in the specified encoding StringgetEncodedName()static voidconvertArgumentsToHTTP(Arguments args)Converts all Argument entries in the collection to HTTPArgument entries. -
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addTestElement, canRemove, clear, clearTestElementChildren, clone, equals, getComment, getProperty, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse -
Methods inherited from class org.apache.jmeter.config.Argument
getDescription, getMetaData, getName, getValue, isSkippable, setDescription, setMetaData, setValue, toString -
Methods inherited from class org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProps, getSchema, getString, removed, set -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
HTTPArgument
HTTPArgument(String name, String value, String metadata)
Constructor for the Argument object.- Parameters:
name- name of the parametervalue- value of the parametermetadata- the separator to use between name and value
-
HTTPArgument
HTTPArgument(String name, String value)
Constructor for the Argument object.- Parameters:
name- name of the parametervalue- value of the parameter
-
HTTPArgument
HTTPArgument(String name, String value, boolean alreadyEncoded)
- Parameters:
name- name of the parametervalue- value of the parameteralreadyEncoded-trueif the value is already encoded, in which case they are decoded before storage
-
HTTPArgument
HTTPArgument(String name, String value, boolean alreadyEncoded, String contentEncoding)
Construct a new HTTPArgument instance; alwaysEncoded is set to true.- Parameters:
name- the name of the parametervalue- the value of the parameteralreadyEncoded- true if the name and value is already encoded, in which case they are decoded before storage.contentEncoding- the encoding used for the parameter value
-
HTTPArgument
HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded)
Construct a new HTTPArgument instance- Parameters:
name- the name of the parametervalue- the value of the parametermetaData- the separator to use between name and valuealreadyEncoded- true if the name and value is already encoded
-
HTTPArgument
HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded, String contentEncoding)
Construct a new HTTPArgument instance- Parameters:
name- the name of the parametervalue- the value of the parametermetaData- the separator to use between name and valuealreadyEncoded- true if the name and value is already encodedcontentEncoding- the encoding used for the parameter value
-
HTTPArgument
HTTPArgument(Argument arg)
-
HTTPArgument
HTTPArgument()
Constructor for the Argument object
-
-
Method Detail
-
getSchema
HTTPArgumentSchema getSchema()
-
getProps
PropertiesAccessor<out HTTPArgument, out HTTPArgumentSchema> getProps()
-
setUseEquals
void setUseEquals(boolean ue)
-
isUseEquals
boolean isUseEquals()
-
setContentType
void setContentType(String ct)
-
getContentType
String getContentType()
-
setAlwaysEncoded
void setAlwaysEncoded(boolean ae)
-
isAlwaysEncoded
boolean isAlwaysEncoded()
-
setName
void setName(String newName)
Sets the Name attribute of the Argument object.
- Parameters:
newName- the new Name value
-
getEncodedValue
String getEncodedValue()
Get the argument value encoded using UTF-8
-
getEncodedValue
String getEncodedValue(String contentEncoding)
Get the argument value encoded in the specified encoding
- Parameters:
contentEncoding- the encoding to use when encoding the argument value
-
getEncodedName
String getEncodedName()
-
convertArgumentsToHTTP
static void convertArgumentsToHTTP(Arguments args)
Converts all Argument entries in the collection to HTTPArgument entries.
- Parameters:
args- collection of Argument and/or HTTPArgument entries
-
-
-
-