SampleWriterConsumer (Apache JMeter dist API)

java.lang.Object

org.apache.jmeter.report.processor.AbstractSampleProcessor

org.apache.jmeter.report.processor.AbstractSampleConsumer

org.apache.jmeter.report.processor.SampleWriterConsumer

All Implemented Interfaces:: SampleConsumer, SampleProcessor, SampleProducer

public class SampleWriterConsumer extends AbstractSampleConsumer

Sample consumed by this consumer are written to a file

Since:: 3.0

Constructor Summary

Constructors

Constructor

Description

SampleWriterConsumer()
Method Summary

Modifier and Type

Method

Description

void

consume(Sample s, int channel)

Consumes the specified sample ton the specified channel.

File

getOutputFile()

File

getOutputFile(int channel)

void

setOutputFile(File outputFile)

void

setOutputFile(String outputFile)

void

setWriteHeader(boolean writeHeader)

Enables the CSV header on the output file (defaults to false)

void

startConsuming()

Start the sample consuming.

void

stopConsuming()

Stops the consuming process.

Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleConsumer
addSampleConsumer, getConsumedChannelCount, getConsumedMetadata, getConsumer, getDataFromContext, getName, getWorkingDirectory, produce, removeSampleConsumer, setChannelAttribute, setConsumedMetadata, setDataToContext, setName, setProducedMetadata, setSampleConsumer, setSampleConsumers, setSampleContext, startProducing, stopProducing

Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleProcessor
getChannelAttribute, getSampleContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jmeter.report.processor.SampleProcessor
getChannelAttribute, getSampleContext

Constructor Details
- SampleWriterConsumer
  
  public SampleWriterConsumer()
Method Details
- setOutputFile
  
  public void setOutputFile(String outputFile)
- setOutputFile
  
  public void setOutputFile(File outputFile)
- getOutputFile
  
  public File getOutputFile()
- getOutputFile
  
  public File getOutputFile(int channel)
- setWriteHeader
  
  public void setWriteHeader(boolean writeHeader)
  
  Enables the CSV header on the output file (defaults to false)
  
  Parameters:
  
  writeHeader - flag, whether CSV header should be written
- startConsuming
  
  public void startConsuming()
  
  Description copied from interface: SampleConsumer
  
  Start the sample consuming. This step is used by consumer to initialize their process.
- consume
  
  public void consume(Sample s, int channel)
  
  Description copied from interface: SampleConsumer
  
  Consumes the specified sample ton the specified channel.
  
  Parameters:
  
  s - The sample to be consumed
  
  channel - The channel on which the sample is consumed
- stopConsuming
  
  public void stopConsuming()
  
  Description copied from interface: SampleConsumer
  
  Stops the consuming process. No sample will be processed after this service has been called.