Apache JMeter

## org.apache.jmeter.protocol.jms.sampler
Class PublisherSampler

    java.lang.Object
      org.apache.jmeter.testelement.AbstractTestElement
          org.apache.jmeter.samplers.AbstractSampler
              org.apache.jmeter.protocol.jms.sampler.BaseJMSSampler
                  org.apache.jmeter.protocol.jms.sampler.PublisherSampler

All Implemented Interfaces:
  Serializable, Cloneable, Sampler, TestElement, TestListener

    public class PublisherSampler

extends BaseJMSSampler
implements TestListener

This class implements the JMS Publisher sampler.

See Also:
  Serialized Form

Field Summary

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

Constructor Summary
`PublisherSampler()`

Method Summary
`String` `getConfigChoice()` return the source of the message Converts from old JMX files which used the local language string
`String` `getFileContent(String path)` The implementation uses TextFile to load the contents of the file and returns a string.
`String` `getInputFile()` return the path of the input file
`String` `getMessageChoice()` return the type of the message (Text, Object, Map)
`String` `getRandomPath()` return the random path for messages
`String` `getTextMessage()` return the text for the message
`SampleResult` `sample()` The implementation will publish n messages within a for loop.
`void` `setConfigChoice(String choice)` set the source of the message
`void` `setInputFile(String file)` set the input file for the publisher
`void` `setMessageChoice(String choice)` set the type of the message
`void` `setRandomPath(String path)` set the random path for the messages
`void` `setTextMessage(String message)` set the text for the message
`void` `testEnded()` endTest cleans up the client
`void` `testEnded(String host)` the implementation calls testEnded() without any parameters.
`void` `testIterationStart(LoopIterationEvent event)` NO implementation provided for the sampler.
`void` `testStarted()` Called just before the start of the test from the main engine thread.
`void` `testStarted(String test)` the implementation calls testStarted() without any parameters.

Methods inherited from class org.apache.jmeter.protocol.jms.sampler.BaseJMSSampler

`getConnectionFactory, getDestination, getIterationCount, getIterations, getJNDIInitialContextFactory, getMessageHeaders, getPassword, getProviderUrl, getReadResponse, getReadResponseAsBoolean, getUseJNDIProperties, getUseJNDIPropertiesAsBoolean, getUsername, isDestinationStatic, isUseAuth, sample, setConnectionFactory, setDestination, setDestinationStatic, setIterations, setJNDIIntialContextFactory, setPassword, setProviderUrl, setReadResponse, setUseAuth, setUseJNDIProperties, setUsername`

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

`addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, 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`

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, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse`

Constructor Detail

### PublisherSampler

    public PublisherSampler()

Method Detail

### testStarted

    public void testStarted(String test)

  the implementation calls testStarted() without any parameters.

  Specified by:
    `testStarted` in interface `TestListener`
  Parameters:
    `test` - name of host
  See Also:
    `StandardJMeterEngine.run()`

### testEnded

    public void testEnded(String host)

  the implementation calls testEnded() without any parameters.

  Specified by:
    `testEnded` in interface `TestListener`
  Parameters:
    `host` - name of host
  See Also:
    `StandardJMeterEngine.stopTest()`

### testEnded

    public void testEnded()

  endTest cleans up the client

  Specified by:
    `testEnded` in interface `TestListener`
  See Also:
    `TestListener.endTest(junit.framework.Test)`

### testStarted

    public void testStarted()

  Description copied from interface: `TestListener`

  Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.

  N.B. testStarted() and testEnded() are called from different threads.

  Specified by:
    `testStarted` in interface `TestListener`
  See Also:
    `StandardJMeterEngine.run()`

### testIterationStart

    public void testIterationStart(LoopIterationEvent event)

  NO implementation provided for the sampler. It is necessary in this case.

  Specified by:
    `testIterationStart` in interface `TestListener`

### sample

    public SampleResult sample()

  The implementation will publish n messages within a for loop. Once n messages are published, it sets the attributes of SampleResult.

  Specified by:
    `sample` in class `BaseJMSSampler`
  Returns:
    the populated sample result

### getFileContent

    public String getFileContent(String path)

  The implementation uses TextFile to load the contents of the file and returns a string.

  Parameters:
    `path` -
  Returns:
    the contents of the file

### setConfigChoice

    public void setConfigChoice(String choice)

  set the source of the message

  Parameters:
    `choice` -

### getConfigChoice

    public String getConfigChoice()

  return the source of the message Converts from old JMX files which used the local language string

### setMessageChoice

    public void setMessageChoice(String choice)

  set the type of the message

  Parameters:
    `choice` -

### getMessageChoice

    public String getMessageChoice()

  return the type of the message (Text, Object, Map)

### setInputFile

    public void setInputFile(String file)

  set the input file for the publisher

  Parameters:
    `file` -

### getInputFile

    public String getInputFile()

  return the path of the input file

### setRandomPath

    public void setRandomPath(String path)

  set the random path for the messages

  Parameters:
    `path` -

### getRandomPath

    public String getRandomPath()

  return the random path for messages

### setTextMessage

    public void setTextMessage(String message)

  set the text for the message

  Parameters:
    `message` -

### getTextMessage

    public String getTextMessage()

  return the text for the message

Apache JMeter

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