Apache JMeter

org.apache.jmeter.protocol.jms.sampler
Class BaseJMSSampler

java.lang.Object
  extended by org.apache.jmeter.testelement.AbstractTestElement
      extended by org.apache.jmeter.samplers.AbstractSampler
          extended by org.apache.jmeter.protocol.jms.sampler.BaseJMSSampler
All Implemented Interfaces:
Serializable, Cloneable, ConfigMergabilityIndicator, Searchable, Sampler, TestElement
Direct Known Subclasses:
PublisherSampler, SubscriberSampler

public abstract class BaseJMSSampler
extends AbstractSampler

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

See Also:
Serialized Form

Field Summary
 
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
 String getDestination()
          return the destination (topic or queue name)
 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.
static String getMessageHeaders(javax.jms.Message message)
          Returns a String with the JMS Message Header values.
 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 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 isDestinationStatic()
          return whether the sampler should use a static destination.
 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 setDestination(String dest)
          set the destination (topic or queue name)
 void setDestinationStatic(boolean isStatic)
          if the sampler should use a static destination, call the method with true
 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 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.samplers.AbstractSampler
applies
 
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, 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
addTestElement, canRemove, clear, clearTestElementChildren, 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
 

Constructor Detail

BaseJMSSampler

public BaseJMSSampler()
Method Detail

sample

public SampleResult sample(Entry e)
Obtains statistics about the given Entry, and packages the information into a SampleResult.


sample

public abstract SampleResult sample()

setJNDIIntialContextFactory

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

Parameters:
icf -

getJNDIInitialContextFactory

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

Returns:
the initial context factory

setProviderUrl

public void setProviderUrl(String url)
set the provider user for jndi

Parameters:
url - the provider URL

getProviderUrl

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

Returns:
the provider URL

setConnectionFactory

public void setConnectionFactory(String factory)
set the connection factory for

Parameters:
factory -

getConnectionFactory

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

Returns:
the connection factory

setDestination

public void setDestination(String dest)
set the destination (topic or queue name)

Parameters:
dest - the destination

getDestination

public String getDestination()
return the destination (topic or queue name)

Returns:
the destination

setUsername

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

Parameters:
user -

getUsername

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

Returns:
the username used to login to the jms server

setPassword

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

Parameters:
pwd -

getPassword

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

Returns:
the password used to login to the jms server

setIterations

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

Parameters:
count -

getIterations

public String getIterations()
get the iterations as string

Returns:
the number of iterations

getIterationCount

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

Returns:
the number of iterations as int instead of string

setUseAuth

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

Parameters:
useAuth -

isUseAuth

public boolean isUseAuth()
return whether jndi requires authentication

Returns:
whether jndi requires authentication

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

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

setUseJNDIProperties

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

Parameters:
properties -

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.

setDestinationStatic

public void setDestinationStatic(boolean isStatic)
if the sampler should use a static destination, call the method with true

Parameters:
isStatic -

isDestinationStatic

public boolean isDestinationStatic()
return whether the sampler should use a static destination.

Returns:
whether the sampler should use a static destination.

getMessageHeaders

public static String getMessageHeaders(javax.jms.Message message)
Returns a String with the JMS Message Header values.

Parameters:
message - JMS Message
Returns:
String with message header values.

Apache JMeter

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