eu.luminis.jmeter.wssampler

Class WebsocketSampler

java.lang.Object

org.apache.jmeter.testelement.AbstractTestElement

org.apache.jmeter.samplers.AbstractSampler

eu.luminis.jmeter.wssampler.WebsocketSampler

All Implemented Interfaces:

Serializable, Cloneable, org.apache.jmeter.engine.util.ConfigMergabilityIndicator, org.apache.jmeter.gui.Searchable, org.apache.jmeter.samplers.Sampler, org.apache.jmeter.testelement.TestElement, org.apache.jmeter.testelement.ThreadListener

Direct Known Subclasses:

CloseWebSocketSampler, OpenWebSocketSampler, PingPongSampler, RequestResponseWebSocketSampler, SingleReadWebSocketSampler, SingleWriteWebSocketSampler

public abstract class WebsocketSampler
extends org.apache.jmeter.samplers.AbstractSampler
implements org.apache.jmeter.testelement.ThreadListener

Base class for websocket samplers. Note on synchronization: JMeter operates samplers from one thread only (the Thread-Group's sampling thread). Only instantiation of these objects is done on another thread (StandardJMeterEngine main thread). Hence, only members set in the constructor must be made thread safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectTimeout
protected org.apache.jmeter.protocol.http.control.CookieManager	cookieManager
static int	DEFAULT_WS_PORT
protected List<FrameFilter>	frameFilters
protected org.apache.jmeter.protocol.http.control.HeaderManager	headerManager
static int	MAX_CONNECTION_TIMEOUT
static int	MAX_READ_TIMEOUT
static int	MIN_CONNECTION_TIMEOUT
static int	MIN_READ_TIMEOUT
protected int	readTimeout
protected static ThreadLocal<WebSocketClient>	threadLocalCachedConnection
protected static boolean	USE_CACHED_SSL_CONTEXT
static String	WS_THREAD_STOP_POLICY_PROPERTY

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

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors

Constructor and Description
WebsocketSampler()

Method Summary

Modifier and Type	Method and Description
void	addTestElement(org.apache.jmeter.testelement.TestElement element)
void	clearTestElementChildren()
protected void	dispose(WebSocketClient webSocketClient)
protected abstract Frame	doSample(WebSocketClient wsClient, org.apache.jmeter.samplers.SampleResult result)
String	getConnectTimeout()
protected String	getConnectUrl(URL url)
org.apache.jmeter.protocol.http.control.CookieManager	getCookieManager()
protected abstract org.apache.log.Logger	getLogger()
String	getReadTimeout()
boolean	getTLS()
protected void	handleUnexpectedFrameException(UnexpectedFrameException e, org.apache.jmeter.samplers.SampleResult result)
protected void	postProcessResponse(Frame response, org.apache.jmeter.samplers.SampleResult result)
protected abstract WebSocketClient	prepareWebSocketClient(org.apache.jmeter.samplers.SampleResult result)
protected void	processDefaultReadResponse(DataFrame response, boolean binary, org.apache.jmeter.samplers.SampleResult result)
protected Frame	readFrame(WebSocketClient wsClient, org.apache.jmeter.samplers.SampleResult result)
protected Frame	readFrame(WebSocketClient wsClient, org.apache.jmeter.samplers.SampleResult result, boolean binary)
org.apache.jmeter.samplers.SampleResult	sample(org.apache.jmeter.samplers.Entry entry)
protected void	sendFrame(WebSocketClient wsClient, org.apache.jmeter.samplers.SampleResult result, boolean binary, String requestData, File requestDataFile)
void	setConnectTimeout(String connectTimeout)
void	setReadTimeout(String readTimeout)
void	setTLS(boolean value)
void	threadFinished()
void	threadStarted()
protected boolean	useTLS()
protected abstract String	validateArguments()
protected String	validateConnectionTimeout(String value)
protected String	validatePortNumber(String value)
protected String	validateReadTimeout(String value)

Methods inherited from class org.apache.jmeter.samplers.AbstractSampler

applies

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

addPropertiesValues, addProperty, addProperty, canRemove, clear, clearTemporary, clone, 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, toString, wait, wait, wait

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

canRemove, clear, clone, 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

WS_THREAD_STOP_POLICY_PROPERTY

public static final String WS_THREAD_STOP_POLICY_PROPERTY

See Also:

Constant Field Values

MIN_CONNECTION_TIMEOUT

public static final int MIN_CONNECTION_TIMEOUT

See Also:

Constant Field Values

MAX_CONNECTION_TIMEOUT

public static final int MAX_CONNECTION_TIMEOUT

See Also:

Constant Field Values

MIN_READ_TIMEOUT

public static final int MIN_READ_TIMEOUT

See Also:

Constant Field Values

MAX_READ_TIMEOUT

public static final int MAX_READ_TIMEOUT

See Also:

Constant Field Values

DEFAULT_WS_PORT

public static final int DEFAULT_WS_PORT

See Also:

Constant Field Values

USE_CACHED_SSL_CONTEXT

protected static final boolean USE_CACHED_SSL_CONTEXT

threadLocalCachedConnection

protected static final ThreadLocal<WebSocketClient> threadLocalCachedConnection

headerManager

protected org.apache.jmeter.protocol.http.control.HeaderManager headerManager

cookieManager

protected org.apache.jmeter.protocol.http.control.CookieManager cookieManager

frameFilters

protected List<FrameFilter> frameFilters

readTimeout

protected int readTimeout

connectTimeout

protected int connectTimeout

Constructor Detail

WebsocketSampler

public WebsocketSampler()

Method Detail

validateArguments

protected abstract String validateArguments()

prepareWebSocketClient

protected abstract WebSocketClient prepareWebSocketClient(org.apache.jmeter.samplers.SampleResult result)

clearTestElementChildren

public void clearTestElementChildren()

Specified by:

clearTestElementChildren in interface org.apache.jmeter.testelement.TestElement

Overrides:

clearTestElementChildren in class org.apache.jmeter.testelement.AbstractTestElement

sample

public org.apache.jmeter.samplers.SampleResult sample(org.apache.jmeter.samplers.Entry entry)

Specified by:

sample in interface org.apache.jmeter.samplers.Sampler

doSample

protected abstract Frame doSample(WebSocketClient wsClient,
                                  org.apache.jmeter.samplers.SampleResult result)
                           throws IOException,
                                  UnexpectedFrameException,
                                  SamplingAbortedException

Throws:

IOException

UnexpectedFrameException

SamplingAbortedException

postProcessResponse

protected void postProcessResponse(Frame response,
                                   org.apache.jmeter.samplers.SampleResult result)

handleUnexpectedFrameException

protected void handleUnexpectedFrameException(UnexpectedFrameException e,
                                              org.apache.jmeter.samplers.SampleResult result)

sendFrame

protected void sendFrame(WebSocketClient wsClient,
                         org.apache.jmeter.samplers.SampleResult result,
                         boolean binary,
                         String requestData,
                         File requestDataFile)
                  throws SamplingAbortedException,
                         IOException

Throws:

SamplingAbortedException

IOException

readFrame

protected Frame readFrame(WebSocketClient wsClient,
                          org.apache.jmeter.samplers.SampleResult result,
                          boolean binary)
                   throws IOException,
                          UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

readFrame

protected Frame readFrame(WebSocketClient wsClient,
                          org.apache.jmeter.samplers.SampleResult result)
                   throws IOException,
                          UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

addTestElement

public void addTestElement(org.apache.jmeter.testelement.TestElement element)

Specified by:

addTestElement in interface org.apache.jmeter.testelement.TestElement

Overrides:

addTestElement in class org.apache.jmeter.testelement.AbstractTestElement

threadStarted

public void threadStarted()

Specified by:

threadStarted in interface org.apache.jmeter.testelement.ThreadListener

threadFinished

public void threadFinished()

Specified by:

threadFinished in interface org.apache.jmeter.testelement.ThreadListener

getCookieManager

public org.apache.jmeter.protocol.http.control.CookieManager getCookieManager()

getConnectUrl

protected String getConnectUrl(URL url)

processDefaultReadResponse

protected void processDefaultReadResponse(DataFrame response,
                                          boolean binary,
                                          org.apache.jmeter.samplers.SampleResult result)

validatePortNumber

protected String validatePortNumber(String value)

validateConnectionTimeout

protected String validateConnectionTimeout(String value)

validateReadTimeout

protected String validateReadTimeout(String value)

dispose

protected void dispose(WebSocketClient webSocketClient)

useTLS

protected boolean useTLS()

getConnectTimeout

public String getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(String connectTimeout)

getReadTimeout

public String getReadTimeout()

setReadTimeout

public void setReadTimeout(String readTimeout)

getTLS

public boolean getTLS()

setTLS

public void setTLS(boolean value)

getLogger

protected abstract org.apache.log.Logger getLogger()