Package org.apache.jmeter.protocol.java.sampler

# Class BeanShellSampler

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.util.BeanShellTestElement
org.apache.jmeter.protocol.java.sampler.BeanShellSampler

All Implemented Interfaces:
  `Serializable`, `Cloneable`, `ConfigMergabilityIndicator`, `Searchable`, `Interruptible`, `Sampler`, `org.apache.jmeter.testelement.TestElement`, `TestStateListener`, `ThreadListener`

public class BeanShellSampler extends BeanShellTestElement implements Sampler, Interruptible, ConfigMergabilityIndicator
A sampler which understands BeanShell

See Also:
  - Serialized Form

## Nested Class Summary

## Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement

`org.apache.jmeter.testelement.TestElement.Companion`

## Field Summary

Fields
Modifier and Type
Field
Description
`static final String`
`FILENAME`
`static final String`
`INIT_FILE`
`static final String`
`PARAMETERS`
`static final String`
`RESET_INTERPRETER`
`static final String`
`SCRIPT`

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

`COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS`

## Constructor Summary

Constructors
Constructor
Description
`BeanShellSampler()`

## Method Summary

Modifier and Type
Method
Description
`boolean`
`applies(ConfigTestElement configElement)`
Does configElement apply to Sampler
`String`
`getFilename()`
`protected String`
`getInitFileProperty()`
`String`
`getParameters()`
`org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends BeanShellSampler,? extends org.apache.jmeter.protocol.java.sampler.BeanShellSamplerSchema>`
`getProps()`
`org.apache.jmeter.protocol.java.sampler.BeanShellSamplerSchema`
`getSchema()`
`String`
`getScript()`
Return the script (TestBean version).
`boolean`
`interrupt()`
Interrupt the current operation if possible.
`boolean`
`isResetInterpreter()`
`SampleResult`
`sample(Entry e)`
Obtains statistics about the given Entry, and packages the information into a SampleResult.

### Methods inherited from class org.apache.jmeter.util.BeanShellTestElement

`clone, getBeanShellInterpreter, processFileOrScript, processFileOrScript, readResolve, setFilename, setParameters, setResetInterpreter, setScript, testEnded, testEnded, testStarted, testStarted, threadFinished, threadStarted`

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

`addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, 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, get, get, get, get, get, get, get, get, get, getComment, getName, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getPropertyOrNull, getString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removed, removeProperty, removeProperty, set, set, set, set, set, set, set, set, set, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse`

## Field Details

### FILENAME

public static final String FILENAME

See Also:
  - Constant Field Values

### SCRIPT

public static final String SCRIPT

See Also:
  - Constant Field Values

### PARAMETERS

public static final String PARAMETERS

See Also:
  - Constant Field Values

### INIT_FILE

public static final String INIT_FILE

See Also:
  - Constant Field Values

### RESET_INTERPRETER

public static final String RESET_INTERPRETER

See Also:
  - Constant Field Values

## Constructor Details

### BeanShellSampler

public BeanShellSampler()

## Method Details

### getSchema

public org.apache.jmeter.protocol.java.sampler.BeanShellSamplerSchema getSchema()

Specified by:
  `getSchema` in interface `org.apache.jmeter.testelement.TestElement`

### getProps

public org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends BeanShellSampler,? extends org.apache.jmeter.protocol.java.sampler.BeanShellSamplerSchema> getProps()

Specified by:
  `getProps` in interface `org.apache.jmeter.testelement.TestElement`

### getInitFileProperty

protected String getInitFileProperty()

Specified by:
  `getInitFileProperty` in class `BeanShellTestElement`

### getScript

public String getScript()
Description copied from class: `BeanShellTestElement`
Return the script (TestBean version). Must be overridden for subclasses that don't implement TestBean otherwise the clone() method won't work.

Overrides:
  `getScript` in class `BeanShellTestElement`
Returns:
  the script to execute

### getFilename

public String getFilename()

Overrides:
  `getFilename` in class `BeanShellTestElement`

### getParameters

public String getParameters()

Overrides:
  `getParameters` in class `BeanShellTestElement`

### isResetInterpreter

public boolean isResetInterpreter()

Overrides:
  `isResetInterpreter` in class `BeanShellTestElement`

### sample

public SampleResult sample(Entry e)
Description copied from interface: `Sampler`
Obtains statistics about the given Entry, and packages the information into a SampleResult.

Specified by:
  `sample` in interface `Sampler`
Parameters:
  `e` - the Entry (TODO seems to be unused)
Returns:
  information about the sample

### interrupt

public boolean interrupt()
Description copied from interface: `Interruptible`
Interrupt the current operation if possible.

Specified by:
  `interrupt` in interface `Interruptible`
Returns:
  `true` if there was an operation to interrupt.

### applies

public boolean applies(ConfigTestElement configElement)
Description copied from interface: `ConfigMergabilityIndicator`
Does configElement apply to Sampler

Specified by:
  `applies` in interface `ConfigMergabilityIndicator`
Parameters:
  `configElement` - `ConfigTestElement`
Returns:
  boolean
See Also:
  - `AbstractSampler.applies(org.apache.jmeter.config.ConfigTestElement)`