org.apache.jmeter.protocol.jms.sampler

Class BaseJMSSampler

Implemented Interfaces:
Cloneable, Sampler, Serializable, TestElement, TestListener
Known Direct Subclasses:
PublisherSampler, SubscriberSampler

public abstract class BaseJMSSampler
extends AbstractSampler
implements TestListener

BaseJMSSampler is an abstract class which provides implementation for common properties. Rather than duplicate the code, it's contained in the base class.

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

COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

BaseJMSSampler()

Method Summary

String
getConnectionFactory()
return the connection factory parameter used to lookup the connection factory from the JMS server
int
getIterationCount()
return the number of iterations as int instead of string
String
getIterations()
get the iterations as string
String
getJNDIInitialContextFactory()
method returns the initial context factory for jndi initial context lookup.
String
getPassword()
return the password used to login to the jms server
String
getProviderUrl()
method returns the provider url for jndi to connect to
String
getReadResponse()
return whether the sampler should read the response
boolean
getReadResponseAsBoolean()
return whether the sampler should read the response as a boolean value
String
getTopic()
return the topic used for the benchmark
String
getUseJNDIProperties()
return whether the sampler should use properties file instead of UI parameters.
boolean
getUseJNDIPropertiesAsBoolean()
return the properties as boolean true/false.
String
getUsername()
return the username used to login to the jms server
boolean
isUseAuth()
return whether jndi requires authentication
abstract SampleResult
sample()
SampleResult
sample(Entry e)
Obtains statistics about the given Entry, and packages the information into a SampleResult.
void
setConnectionFactory(String factory)
set the connection factory for
void
setIterations(String count)
set the number of iterations the sampler should aggregate
void
setJNDIIntialContextFactory(String icf)
set the initial context factory
void
setPassword(String pwd)
Set the password to login to the jms server
void
setProviderUrl(String url)
set the provider user for jndi
void
setReadResponse(String read)
set whether the sampler should read the response or not
void
setTopic(String topic)
set the topic
void
setUseAuth(boolean useAuth)
Set whether authentication is required for JNDI
void
setUseJNDIProperties(String properties)
if the sampler should use jndi.properties file, call the method with true
void
setUsername(String user)
set the username to login into the jms server if needed

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

addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Constructor Details

BaseJMSSampler

public BaseJMSSampler()

Method Details

getConnectionFactory

public String getConnectionFactory()
return the connection factory parameter used to lookup the connection factory from the JMS server
Returns:
the connection factory

getIterationCount

public int getIterationCount()
return the number of iterations as int instead of string
Returns:
the number of iterations as int instead of string

getIterations

public String getIterations()
get the iterations as string
Returns:
the number of iterations

getJNDIInitialContextFactory

public String getJNDIInitialContextFactory()
method returns the initial context factory for jndi initial context lookup.
Returns:
the initial context factory

getPassword

public String getPassword()
return the password used to login to the jms server
Returns:
the password used to login to the jms server

getProviderUrl

public String getProviderUrl()
method returns the provider url for jndi to connect to
Returns:
the provider URL

getReadResponse

public String getReadResponse()
return whether the sampler should read the response
Returns:
whether the sampler should read the response

getReadResponseAsBoolean

public boolean getReadResponseAsBoolean()
return whether the sampler should read the response as a boolean value
Returns:
whether the sampler should read the response as a boolean value

getTopic

public String getTopic()
return the topic used for the benchmark
Returns:
the topic

getUseJNDIProperties

public String getUseJNDIProperties()
return whether the sampler should use properties file instead of UI parameters.
Returns:
whether the sampler should use properties file instead of UI parameters.

getUseJNDIPropertiesAsBoolean

public boolean getUseJNDIPropertiesAsBoolean()
return the properties as boolean true/false.
Returns:
whether the sampler should use properties file instead of UI parameters.

getUsername

public String getUsername()
return the username used to login to the jms server
Returns:
the username used to login to the jms server

isUseAuth

public boolean isUseAuth()
return whether jndi requires authentication
Returns:
whether jndi requires authentication

sample

public abstract SampleResult sample()

sample

public SampleResult sample(Entry e)
Obtains statistics about the given Entry, and packages the information into a SampleResult.
Specified by:
sample in interface Sampler

setConnectionFactory

public void setConnectionFactory(String factory)
set the connection factory for
Parameters:
factory -

setIterations

public void setIterations(String count)
set the number of iterations the sampler should aggregate
Parameters:
count -

setJNDIIntialContextFactory

public void setJNDIIntialContextFactory(String icf)
set the initial context factory
Parameters:
icf -

setPassword

public void setPassword(String pwd)
Set the password to login to the jms server
Parameters:
pwd -

setProviderUrl

public void setProviderUrl(String url)
set the provider user for jndi
Parameters:
url - the provider URL

setReadResponse

public void setReadResponse(String read)
set whether the sampler should read the response or not
Parameters:
read - whether the sampler should read the response or not

setTopic

public void setTopic(String topic)
set the topic
Parameters:
topic -

setUseAuth

public void setUseAuth(boolean useAuth)
Set whether authentication is required for JNDI
Parameters:
useAuth -

setUseJNDIProperties

public void setUseJNDIProperties(String properties)
if the sampler should use jndi.properties file, call the method with true
Parameters:
properties -

setUsername

public void setUsername(String user)
set the username to login into the jms server if needed
Parameters:
user -

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.