Class HTTPArgument
- java.lang.Object
-
- org.apache.jmeter.testelement.AbstractTestElement
-
- org.apache.jmeter.config.Argument
-
- org.apache.jmeter.protocol.http.util.HTTPArgument
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Searchable
,TestElement
public class HTTPArgument extends Argument implements Serializable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.jmeter.config.Argument
ARG_NAME, DESCRIPTION, METADATA, VALUE
-
Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS
-
-
Constructor Summary
Constructors Constructor Description HTTPArgument()
Constructor for the Argument objectHTTPArgument(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)
Constructor for the Argument object.HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded)
Construct a new HTTPArgument instanceHTTPArgument(String name, String value, String metaData, boolean alreadyEncoded, String contentEncoding)
Construct a new HTTPArgument instanceHTTPArgument(Argument arg)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
convertArgumentsToHTTP(Arguments args)
Converts allArgument
entries in the collection toHTTPArgument
entries.String
getEncodedName()
String
getEncodedValue()
Get the argument value encoded using UTF-8String
getEncodedValue(String contentEncoding)
Get the argument value encoded in the specified encodingboolean
isAlwaysEncoded()
boolean
isUseEquals()
void
setAlwaysEncoded(boolean ae)
void
setName(String newName)
Sets the Name attribute of the Argument object.void
setUseEquals(boolean ue)
-
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.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty
-
-
-
-
Constructor Detail
-
HTTPArgument
public HTTPArgument(String name, String value, String metadata)
Constructor for the Argument object.The value is assumed to be not encoded.
- Parameters:
name
- name of the paramtervalue
- value of the parametermetadata
- the separator to use between name and value
-
HTTPArgument
public HTTPArgument(String name, String value)
Constructor for the Argument object.The value is assumed to be not encoded.
- Parameters:
name
- name of the parametervalue
- value of the parameter
-
HTTPArgument
public HTTPArgument(String name, String value, boolean alreadyEncoded)
- Parameters:
name
- name of the parametervalue
- value of the parameteralreadyEncoded
-true
if the value is already encoded, in which case they are decoded before storage
-
HTTPArgument
public 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
public 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
public 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
public HTTPArgument(Argument arg)
-
HTTPArgument
public HTTPArgument()
Constructor for the Argument object
-
-
Method Detail
-
setUseEquals
public void setUseEquals(boolean ue)
-
isUseEquals
public boolean isUseEquals()
-
setAlwaysEncoded
public void setAlwaysEncoded(boolean ae)
-
isAlwaysEncoded
public boolean isAlwaysEncoded()
-
setName
public void setName(String newName)
Sets the Name attribute of the Argument object.- Specified by:
setName
in interfaceTestElement
- Overrides:
setName
in classArgument
- Parameters:
newName
- the new Name value
-
getEncodedValue
public String getEncodedValue()
Get the argument value encoded using UTF-8- Returns:
- the argument value encoded in UTF-8
-
getEncodedValue
public String getEncodedValue(String contentEncoding) throws UnsupportedEncodingException
Get the argument value encoded in the specified encoding- Parameters:
contentEncoding
- the encoding to use when encoding the argument value- Returns:
- the argument value encoded in the specified encoding
- Throws:
UnsupportedEncodingException
- of the encoding is not supported
-
getEncodedName
public String getEncodedName()
-
convertArgumentsToHTTP
public static void convertArgumentsToHTTP(Arguments args)
Converts allArgument
entries in the collection toHTTPArgument
entries.- Parameters:
args
- collection ofArgument
and/orHTTPArgument
entries
-
-