SoapSampler (Apache JMeter API)

java.lang.Object
- org.apache.jmeter.testelement.AbstractTestElement
- - org.apache.jmeter.samplers.AbstractSampler
  - - org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase
    - - org.apache.jmeter.protocol.http.sampler.HTTPSampler2
      - org.apache.jmeter.protocol.http.sampler.SoapSampler

All Implemented Interfaces:

Serializable, Cloneable, ConfigMergabilityIndicator, Searchable, HTTPConstantsInterface, Interruptible, Sampler, TestElement, TestIterationListener, TestStateListener, ThreadListener

Deprecated.
since 3.0, will be removed in next version
```
@Deprecated
public class SoapSampler
extends HTTPSampler2
implements Interruptible
```
Commons HTTPClient based soap sampler

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase
  HTTPSamplerBase.SourceType

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SEND_SOAP_ACTION` Deprecated.
`static String`	`SOAP_ACTION` Deprecated.
`static String`	`URL_DATA` Deprecated.
`static String`	`XML_DATA` Deprecated.
`static String`	`XML_DATA_FILE` Deprecated.

Fields inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase
ARGUMENTS, AUTH_MANAGER, AUTO_REDIRECTS, BROWSER_COMPATIBLE_MULTIPART, BROWSER_COMPATIBLE_MULTIPART_MODE_DEFAULT, CACHE_MANAGER, CONCURRENT_DWN, CONCURRENT_POOL, CONCURRENT_POOL_SIZE, CONNECT_TIMEOUT, CONTENT_ENCODING, CONTENT_TYPE, COOKIE_MANAGER, DEFAULT_METHOD, DNS_CACHE_MANAGER, DO_MULTIPART_POST, DOMAIN, EMBEDDED_URL_RE, FOLLOW_REDIRECTS, HEADER_MANAGER, IMAGE_PARSER, IMPLEMENTATION, IP_SOURCE, IP_SOURCE_TYPE, MAX_FRAME_DEPTH, MAX_REDIRECTS, MD5, METHOD, MONITOR, NON_HTTP_RESPONSE_CODE, NON_HTTP_RESPONSE_MESSAGE, PATH, PORT, POST_BODY_RAW, POST_BODY_RAW_DEFAULT, PROTOCOL, PROXYHOST, PROXYPASS, PROXYPORT, PROXYUSER, RESPONSE_TIMEOUT, SOURCE_TYPE_DEFAULT, UNSPECIFIED_PORT, UNSPECIFIED_PORT_AS_STRING, URL, URL_UNSPECIFIED_PORT, URL_UNSPECIFIED_PORT_AS_STRING, USE_KEEPALIVE

Fields inherited from interface org.apache.jmeter.protocol.http.util.HTTPConstantsInterface
APPLICATION_X_WWW_FORM_URLENCODED, CACHE_CONTROL, CONNECT, CONNECTION_CLOSE, COPY, DATE, DEFAULT_HTTP_PORT, DEFAULT_HTTP_PORT_STRING, DEFAULT_HTTPS_PORT, DEFAULT_HTTPS_PORT_STRING, DELETE, ENCODING_BROTLI, ENCODING_DEFLATE, ENCODING_GZIP, ETAG, EXPIRES, GET, HEAD, HEADER_AUTHORIZATION, HEADER_CONNECTION, HEADER_CONTENT_DISPOSITION, HEADER_CONTENT_ENCODING, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_COOKIE, HEADER_HOST, HEADER_LOCAL_ADDRESS, HEADER_LOCATION, HEADER_SET_COOKIE, HTTP_1_1, IF_MODIFIED_SINCE, IF_NONE_MATCH, KEEP_ALIVE, LAST_MODIFIED, LOCK, MKCALENDAR, MKCOL, MOVE, MULTIPART_FORM_DATA, OPTIONS, PATCH, POST, PROPFIND, PROPPATCH, PROTOCOL_HTTP, PROTOCOL_HTTPS, PUT, REPORT, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_SEE_OTHER, SC_TEMPORARY_REDIRECT, SEARCH, TRACE, TRANSFER_ENCODING, UNLOCK, VARY

Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors
Constructor and Description

SoapSampler()
Deprecated.

Constructors
Constructor and Description
`SoapSampler()` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getSendSOAPAction()` Deprecated.
`String`	`getSOAPAction()` Deprecated.
`String`	`getSOAPActionQuoted()` Deprecated.
`URL`	`getUrl()` Deprecated. Get the URL, built from its component parts.
`String`	`getURLData()` Deprecated.
`String`	`getXmlData()` Deprecated.
`String`	`getXmlFile()` Deprecated. Get the file location of the xml file.
`protected HTTPSampleResult`	`sample(URL url, String method, boolean areFollowingRedirect, int frameDepth)` Deprecated. Samples the URL passed in and stores the result in `HTTPSampleResult`, following redirects and downloading page resources as appropriate.
`protected int`	`setPostHeaders(org.apache.commons.httpclient.methods.PostMethod post)` Deprecated.
`void`	`setSendSOAPAction(boolean action)` Deprecated.
`void`	`setSOAPAction(String action)` Deprecated.
`void`	`setURLData(String url)` Deprecated.
`void`	`setXmlData(String data)` Deprecated.
`void`	`setXmlFile(String filename)` Deprecated. it's kinda obvious, but we state it anyways.

Methods inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSampler2
getConnectionHeaders, getResponseHeaders, interrupt, saveConnectionCookies, setSavedClient, setupConnection, testIterationStart

Methods inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase
addArgument, addArgument, addEncodedArgument, addEncodedArgument, addEncodedArgument, addNonEncodedArgument, addTestElement, applies, clearTestElementChildren, clone, downloadPageResources, encodeBackSlashes, encodeSpaces, errorResult, followRedirects, getArguments, getAuthManager, getAutoRedirects, getCacheManager, getConcurrentPool, getConnectTimeout, getContentEncoding, getCookieManager, getDefaultPort, getDNSResolver, getDoBrowserCompatibleMultipart, getDomain, getDoMultipartPost, getEmbeddedUrlRE, getFollowRedirects, getHeaderManager, getHTTPFileCount, getHTTPFiles, getImplementation, getIpSource, getIpSourceType, getMethod, getMonitor, getPath, getPort, getPortIfSpecified, getPostBodyRaw, getProtocol, getProxyHost, getProxyPass, getProxyPortInt, getProxyUser, getQueryString, getQueryString, getResponseTimeout, getSendFileAsPostBody, getSendParameterValuesAsPostBody, getSourceTypeList, getUseKeepAlive, getUseMultipartForPost, getValidMethodsAsArray, hasArguments, isConcurrentDwn, isImageParser, isMonitor, isProtocolDefaultPort, isSecure, isSecure, isSuccessCode, parseArguments, parseArguments, readResponse, resultProcessing, sample, sample, setArguments, setAuthManager, setAutoRedirects, setCacheManager, setConcurrentDwn, setConcurrentPool, setConnectTimeout, setContentEncoding, setCookieManager, setDNSResolver, setDoBrowserCompatibleMultipart, setDomain, setDoMultipartPost, setEmbeddedUrlRE, setFollowRedirects, setHeaderManager, setHTTPFiles, setImageParser, setImplementation, setIpSource, setIpSourceType, setMD5, setMethod, setMonitor, setMonitor, setPath, setPath, setPort, setPostBodyRaw, setProtocol, setResponseTimeout, setUseKeepAlive, testEnded, testEnded, testStarted, testStarted, threadFinished, threadStarted, toString, useMD5

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, canRemove, clear, clearTemporary, emptyTemporary, equals, getComment, getName, 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, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jmeter.samplers.Interruptible
interrupt

Methods inherited from interface org.apache.jmeter.testelement.TestElement
canRemove, clear, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse

- Field Detail
  - XML_DATA
```
public static final String XML_DATA
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - URL_DATA
```
public static final String URL_DATA
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - SOAP_ACTION
```
public static final String SOAP_ACTION
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - SEND_SOAP_ACTION
```
public static final String SEND_SOAP_ACTION
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - XML_DATA_FILE
```
public static final String XML_DATA_FILE
```
    Deprecated.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SoapSampler
```
public SoapSampler()
```
    Deprecated.
- Method Detail
  - setXmlData
```
public void setXmlData(String data)
```
    Deprecated.
  - getXmlData
```
public String getXmlData()
```
    Deprecated.
  - setXmlFile
```
public void setXmlFile(String filename)
```
    Deprecated.
    
    it's kinda obvious, but we state it anyways. Set the xml file with a string path.
    
    Parameters:
    filename - path to the xml file
  - getXmlFile
```
public String getXmlFile()
```
    Deprecated.
    
    Get the file location of the xml file.
    
    Returns:
    String file path.
  - getURLData
```
public String getURLData()
```
    Deprecated.
  - setURLData
```
public void setURLData(String url)
```
    Deprecated.
  - getSOAPAction
```
public String getSOAPAction()
```
    Deprecated.
  - getSOAPActionQuoted
```
public String getSOAPActionQuoted()
```
    Deprecated.
  - setSOAPAction
```
public void setSOAPAction(String action)
```
    Deprecated.
  - getSendSOAPAction
```
public boolean getSendSOAPAction()
```
    Deprecated.
  - setSendSOAPAction
```
public void setSendSOAPAction(boolean action)
```
    Deprecated.
  - setPostHeaders
```
protected int setPostHeaders(org.apache.commons.httpclient.methods.PostMethod post)
```
    Deprecated.
  - sample
```
protected HTTPSampleResult sample(URL url,
                      String method,
                      boolean areFollowingRedirect,
                      int frameDepth)
```
    Deprecated.
    
    Description copied from class: HTTPSamplerBase
    
    Samples the URL passed in and stores the result in HTTPSampleResult, following redirects and downloading page resources as appropriate.
    When getting a redirect target, redirects are not followed and resources are not downloaded. The caller will take care of this.
    
    Overrides:
    
    sample in class HTTPSampler2
    
    Parameters:
    url - URL to sample
    method - HTTP method: GET, POST,...
    areFollowingRedirect - whether we're getting a redirect target
    frameDepth - Depth of this target in the frame structure. Used only to prevent infinite recursion.
    
    Returns:
    results of the sampling, can be null if u is in CacheManager
  - getUrl
```
public URL getUrl()
           throws MalformedURLException
```
    Deprecated.
    
    Description copied from class: HTTPSamplerBase
    
    Get the URL, built from its component parts.
    As a special case, if the path starts with "http[s]://", then the path is assumed to be the entire URL.
    
    Overrides:
    
    getUrl in class HTTPSamplerBase
    
    Returns:
    The URL to be requested by this sampler.
    
    Throws:
    
    MalformedURLException - if url is malformed

Class SoapSampler

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase

Field Summary

Fields inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase

Fields inherited from interface org.apache.jmeter.protocol.http.util.HTTPConstantsInterface

Fields inherited from interface org.apache.jmeter.testelement.TestElement

Constructor Summary

Method Summary

Methods inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSampler2

Methods inherited from class org.apache.jmeter.protocol.http.sampler.HTTPSamplerBase

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.jmeter.samplers.Interruptible

Methods inherited from interface org.apache.jmeter.testelement.TestElement

Field Detail

XML_DATA

URL_DATA

SOAP_ACTION

SEND_SOAP_ACTION

XML_DATA_FILE

Constructor Detail

SoapSampler

Method Detail

setXmlData

getXmlData

setXmlFile

getXmlFile

getURLData

setURLData

getSOAPAction

getSOAPActionQuoted

setSOAPAction

getSendSOAPAction

setSendSOAPAction

setPostHeaders

sample

getUrl