| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to you under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.jmeter.testelement |
| |
| import org.apache.jmeter.testelement.property.BooleanProperty |
| import org.apache.jmeter.testelement.property.CollectionProperty |
| import org.apache.jmeter.testelement.property.DoubleProperty |
| import org.apache.jmeter.testelement.property.FloatProperty |
| import org.apache.jmeter.testelement.property.JMeterProperty |
| import org.apache.jmeter.testelement.property.NullProperty |
| import org.apache.jmeter.testelement.property.PropertyIterator |
| import org.apache.jmeter.testelement.property.StringProperty |
| import org.apache.jmeter.testelement.property.TestElementProperty |
| import org.apache.jmeter.testelement.schema.BooleanPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.ClassPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.CollectionPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.DoublePropertyDescriptor |
| import org.apache.jmeter.testelement.schema.FloatPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.IntegerPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.LongPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.PropertiesAccessor |
| import org.apache.jmeter.testelement.schema.PropertyDescriptor |
| import org.apache.jmeter.testelement.schema.StringPropertyDescriptor |
| import org.apache.jmeter.testelement.schema.TestElementPropertyDescriptor |
| import org.apache.jmeter.threads.JMeterContext |
| import org.apiguardian.api.API |
| |
| public interface TestElement : Cloneable { |
| public companion object { |
| public const val NAME: String = "TestElement.name" // $NON-NLS-1$ |
| public const val GUI_CLASS: String = "TestElement.gui_class" // $NON-NLS-1$ |
| public const val ENABLED: String = "TestElement.enabled" // $NON-NLS-1$ |
| public const val TEST_CLASS: String = "TestElement.test_class" // $NON-NLS-1$ |
| |
| // Needed by AbstractTestElement. |
| // Also TestElementConverter and TestElementPropertyConverter for handling empty comments |
| public const val COMMENTS: String = "TestPlan.comments" // $NON-NLS-1$ |
| } |
| |
| public val schema: TestElementSchema |
| get() = TestElementSchema |
| |
| /** |
| * Allows type-safe accessors to the properties of the current element. |
| * Note: when overriding the method, ensure you emit wildcards. |
| * For instance: [JMeterElementInstance<? extends TestPlanClass> getProps() { return ... }] |
| */ |
| public val props: PropertiesAccessor<@JvmWildcard TestElement, @JvmWildcard TestElementSchema> |
| get() = PropertiesAccessor(this, schema) |
| |
| public fun addTestElement(child: TestElement) |
| |
| /** |
| * This method should clear any test element properties that are merged |
| * by [.addTestElement]. |
| */ |
| public fun clearTestElementChildren() |
| public fun setProperty(key: String, value: String?) |
| public fun setProperty(key: String, value: String?, dflt: String) |
| public fun setProperty(key: String, value: Boolean) |
| public fun setProperty(key: String, value: Boolean, dflt: Boolean) |
| public fun setProperty(key: String, value: Int) |
| public fun setProperty(key: String, value: Int, dflt: Int) |
| public fun setProperty(name: String, value: Long) |
| public fun setProperty(name: String, value: Long, dflt: Long) |
| |
| /** |
| * Configures if the current test element should be enabled or not. |
| */ |
| public var isEnabled: Boolean |
| |
| /** |
| * Make the test element the running version, or make it no longer the |
| * running version. This tells the test element that it's current state must |
| * be retrievable by a call to recoverRunningVersion(). It is kind of like |
| * making the TestElement Read-Only, but not as strict. Changes can be made |
| * and the element can be modified, but the state of the element at the time |
| * of the call to setRunningVersion() must be recoverable. |
| * |
| * flag whether this element should be the running version |
| */ |
| public var isRunningVersion: Boolean |
| |
| /** |
| * Test whether a given property is only a temporary resident of the |
| * TestElement |
| * |
| * @param property the property to be tested |
| * @return `true` if property is temporary |
| */ |
| public fun isTemporary(property: JMeterProperty): Boolean |
| |
| /** |
| * Indicate that the given property should be only a temporary property in |
| * the TestElement. |
| * |
| * @param property property to set as temporary one |
| */ |
| public fun setTemporary(property: JMeterProperty) |
| |
| /** |
| * Return a property as a boolean value. |
| * |
| * @param key the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsBoolean(key: String): Boolean |
| |
| /** |
| * Return a property as a boolean value or a default value if no property |
| * could be found. |
| * |
| * @param key the name of the property to get |
| * @param defaultValue the default value to use |
| * @return the value of the property, or `defaultValue` if no property could be found |
| */ |
| public fun getPropertyAsBoolean(key: String, defaultValue: Boolean): Boolean |
| |
| /** |
| * Return a property as a long value. |
| * |
| * @param key the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsLong(key: String): Long |
| |
| /** |
| * Return a property as a long value or a default value if no property |
| * could be found. |
| * |
| * @param key the name of the property to get |
| * @param defaultValue the default value to use |
| * @return the value of the property, or `defaultValue` if no property could be found |
| */ |
| public fun getPropertyAsLong(key: String, defaultValue: Long): Long |
| |
| /** |
| * Return a property as an int value. |
| * |
| * @param key |
| * the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsInt(key: String): Int |
| |
| /** |
| * Return a property as an int value or a default value if no property |
| * could be found. |
| * |
| * @param key the name of the property to get |
| * @param defaultValue the default value to use |
| * @return the value of the property, or `defaultValue` if no property could be found |
| */ |
| public fun getPropertyAsInt(key: String, defaultValue: Int): Int |
| |
| /** |
| * Return a property as a float value. |
| * |
| * @param key |
| * the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsFloat(key: String): Float |
| |
| /** |
| * Return a property as a double value. |
| * |
| * @param key |
| * the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsDouble(key: String): Double |
| |
| /** |
| * Tells the test element to return to the state it was in when |
| * setRunningVersion(true) was called. |
| */ |
| public fun recoverRunningVersion() |
| |
| /** |
| * Clear the TestElement of all data. |
| */ |
| public fun clear() |
| |
| /** |
| * Return a property as a string value. |
| * |
| * @param key the name of the property to get |
| * @return the value of the property |
| */ |
| public fun getPropertyAsString(key: String): String |
| |
| /** |
| * Return a property as an string value or a default value if no property |
| * could be found. |
| * |
| * @param key |
| * the name of the property to get |
| * @param defaultValue |
| * the default value to use |
| * @return the value of the property, or `defaultValue` if no |
| * property could be found |
| */ |
| public fun getPropertyAsString(key: String, defaultValue: String): String |
| |
| /** |
| * Sets and overwrites a property in the TestElement. This call will be |
| * ignored if the TestElement is currently a "running version". |
| * |
| * @param property the property to be set |
| */ |
| public fun setProperty(property: JMeterProperty) |
| |
| /** |
| * Given the name of the property, returns the appropriate property from |
| * JMeter. If it is null, a [NullProperty] object will be returned. |
| * |
| * @param propName the name of the property to get |
| * @return [JMeterProperty] stored under the name, or [NullProperty] if no property can be found |
| */ |
| public fun getProperty(propName: String): JMeterProperty |
| |
| /** |
| * Retrieve property or return `null` if the property is unset. |
| * |
| * Note: the result of the method does not account the default value, |
| * so consider using `get(PropertyDescriptor)` methods if you need |
| * to account for default values. |
| * |
| * @param propName the name of the property to get |
| * @return [JMeterProperty] or `null` if the property is unset |
| * @since 5.6 |
| */ |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun getPropertyOrNull(propName: String): JMeterProperty? = |
| getProperty(propName).takeIf { it !is NullProperty } |
| |
| /** |
| * Retrieve property or return `null` if the property is unset. |
| * |
| * Note: the result of the method does not account the default value, |
| * so consider using `get(PropertyDescriptor)` methods if you need |
| * to account for default values. |
| * |
| * @param property descriptor of the property to retrieve |
| * @return [JMeterProperty] or `null` if the property is unset |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun getPropertyOrNull(property: PropertyDescriptor<*, *>): JMeterProperty? = |
| getPropertyOrNull(property.name) |
| |
| /** |
| * Retrieve property as string, or default value, or empty string if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: StringPropertyDescriptor<*>): String = |
| getPropertyOrNull(property)?.stringValue ?: property.defaultValue ?: "" |
| |
| /** |
| * Read property value as string, or default value, or empty string if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun getString(property: PropertyDescriptor<*, *>): String = |
| getPropertyOrNull(property)?.stringValue ?: property.defaultValueAsString ?: "" |
| |
| /** |
| * Set property as string, or remove it if the given value is `null`. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: PropertyDescriptor<*, *>, value: String?) { |
| removeOrSet(value == null, property.name) { |
| StringProperty(it, value) |
| } |
| } |
| |
| /** |
| * Retrieve boolean property value, or default value, or `false` if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: BooleanPropertyDescriptor<*>): Boolean = |
| getPropertyOrNull(property)?.booleanValue ?: property.defaultValue ?: false |
| |
| /** |
| * Set property as boolean, or remove it if the given value is null. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: BooleanPropertyDescriptor<*>, value: Boolean?) { |
| removeOrSet(value == null, property.name) { |
| BooleanProperty(it, value!!) |
| } |
| } |
| |
| /** |
| * Retrieve integer property value. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: IntegerPropertyDescriptor<*>): Int = |
| getPropertyOrNull(property)?.intValue ?: property.defaultValue ?: 0 |
| |
| /** |
| * Set property as integer. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: IntegerPropertyDescriptor<*>, value: Int) { |
| setProperty(property.name, value) |
| } |
| |
| /** |
| * Retrieve long property value, or default value, or `0` if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: LongPropertyDescriptor<*>): Long = |
| getPropertyOrNull(property)?.longValue ?: property.defaultValue ?: 0 |
| |
| /** |
| * Set property as long. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: LongPropertyDescriptor<*>, value: Long) { |
| setProperty(property.name, value) |
| } |
| |
| /** |
| * Retrieve float property value, or default value, or `0.0f` if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: FloatPropertyDescriptor<*>): Float = |
| getPropertyOrNull(property)?.floatValue ?: property.defaultValue ?: 0.0f |
| |
| /** |
| * Set property as float. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: FloatPropertyDescriptor<*>, value: Float) { |
| setProperty(FloatProperty(property.name, value)) |
| } |
| |
| /** |
| * Retrieve double property value, or default value, or `0.0` if the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: DoublePropertyDescriptor<*>): Double = |
| getPropertyOrNull(property)?.doubleValue ?: property.defaultValue ?: 0.0 |
| |
| /** |
| * Set property as double. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: DoublePropertyDescriptor<*>, value: Double) { |
| setProperty(DoubleProperty(property.name, value)) |
| } |
| |
| /** |
| * Retrieve [Class] property value, or default value, or throw [NoSuchElementException] in case the property is unset. |
| * @throws NoSuchElementException if the property is unset |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun <ValueClass : Any> get(property: ClassPropertyDescriptor<*, ValueClass>): Class<out ValueClass> = |
| getOrNull(property) ?: throw NoSuchElementException("Property ${property.name} is unset for element $this") |
| |
| /** |
| * Retrieve [Class] property value, or default value, or `null` in case the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun <ValueClass : Any> getOrNull(property: ClassPropertyDescriptor<*, ValueClass>): Class<out ValueClass>? = |
| getPropertyOrNull(property)?.objectValue?.let { |
| Class.forName(getString(property), false, Thread.currentThread().contextClassLoader) |
| .asSubclass(property.klass) |
| } ?: property.defaultValue |
| |
| /** |
| * Set property as [Class], or remove it if the given value is `null`. |
| * The value is set as [StringProperty] with the name of the given class. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun <ValueClass : Any> set(property: ClassPropertyDescriptor<*, ValueClass>, value: Class<out ValueClass>?) { |
| removeOrSet(value == null, property.name) { |
| StringProperty(it, value!!.name) |
| } |
| } |
| |
| /** |
| * Retrieve [TestElement] property value, or return null in case the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun <TestElementClass : TestElement> getOrNull( |
| property: TestElementPropertyDescriptor<*, TestElementClass> |
| ): TestElementClass? = |
| getPropertyOrNull(property)?.objectValue?.let { property.klass.cast(it) } |
| |
| /** |
| * Retrieve [TestElement] property value, or throw [NoSuchElementException] in case the property is unset. |
| * @throws NoSuchElementException if the property is unset |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun <TestElementClass : TestElement> get( |
| property: TestElementPropertyDescriptor<*, TestElementClass> |
| ): TestElementClass = |
| getOrNull(property) ?: throw NoSuchElementException("Property ${property.name} is unset for element $this") |
| |
| /** |
| * Retrieve [TestElement] property value, or create one and set it the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun <TestElementClass : TestElement> getOrCreate( |
| property: TestElementPropertyDescriptor<*, TestElementClass>, |
| ifMissing: () -> TestElementClass |
| ): TestElementClass = |
| getPropertyOrNull(property)?.objectValue?.let { property.klass.cast(it) } |
| ?: ifMissing().also { set(property, it) } |
| |
| /** |
| * Set property as [TestElement], or remove it if the given [TestElement] is `null`. |
| * The values of collection will be converted to [JMeterProperty] as in [CollectionProperty.addItem]. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun <TestElementClass : TestElement> set(property: TestElementPropertyDescriptor<*, TestElementClass>, value: TestElementClass?) { |
| removeOrSet(value == null, property.name) { |
| TestElementProperty(it, value) |
| } |
| } |
| |
| /** |
| * Retrieve [CollectionProperty] property value, or throw [NoSuchElementException] in case the property is unset. |
| * @throws NoSuchElementException if the property is unset |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun get(property: CollectionPropertyDescriptor<*>): CollectionProperty = |
| getOrNull(property) ?: throw NoSuchElementException("Property ${property.name} is unset for element $this") |
| |
| /** |
| * Retrieve [CollectionProperty] property value, or return `null` in case the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun getOrNull(property: CollectionPropertyDescriptor<*>): CollectionProperty? = |
| getPropertyOrNull(property)?.let { |
| it as CollectionProperty |
| } |
| |
| /** |
| * Retrieve [CollectionProperty] property value, or create one and set it the property is unset. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun getOrCreate( |
| property: CollectionPropertyDescriptor<*>, |
| ifMissing: () -> Collection<JMeterProperty> |
| ): CollectionProperty = |
| getOrNull(property) ?: CollectionProperty(property.name, ifMissing()).also { setProperty(it) } |
| |
| /** |
| * Set property as [Collection], or remove it if the given [Collection] is `null`. |
| * @since 5.6 |
| */ |
| @JMeterPropertySchemaUnchecked |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public operator fun set(property: CollectionPropertyDescriptor<*>, value: Collection<*>?) { |
| removeOrSet(value == null, property.name) { |
| CollectionProperty(it, value) |
| } |
| } |
| |
| /** |
| * Get a Property Iterator for the TestElements properties. |
| * |
| * @return PropertyIterator |
| */ |
| public fun propertyIterator(): PropertyIterator |
| |
| /** |
| * Remove property stored under the `key` |
| * |
| * @param key name of the property to be removed |
| */ |
| public fun removeProperty(key: String) |
| |
| /** |
| * Remove property stored under the `key` |
| * |
| * @param key name of the property to be removed |
| * @since 5.6 |
| */ |
| @API(status = API.Status.EXPERIMENTAL, since = "5.6") |
| public fun removeProperty(property: PropertyDescriptor<*, *>) { |
| removeProperty(property.name) |
| } |
| |
| // lifecycle methods |
| public override fun clone(): Any |
| |
| /** |
| * Convenient way to traverse a test element. |
| * |
| * @param traverser The traverser that is notified of the contained elements |
| */ |
| public fun traverse(traverser: TestElementTraverser) |
| |
| /** |
| * Associates a thread context with this element. |
| */ |
| public var threadContext: JMeterContext |
| |
| /** |
| * Associates a thread name with this element. |
| * @deprecated Use `JMeterContextService.getContext().thread.threadName` instead |
| */ |
| @Deprecated( |
| message = "Use JMeterContextService.getContext().thread.threadName instead", |
| replaceWith = ReplaceWith( |
| "JMeterContextService.getContext().thread.threadName", |
| imports = ["org.apache.jmeter.threads.JMeterContextService"] |
| ) |
| ) |
| @set:API(status = API.Status.DEPRECATED, since = "5.6") |
| public var threadName: String |
| |
| /** |
| * Called by Remove to determine if it is safe to remove the element. The |
| * element can either clean itself up, and return true, or the element can |
| * return false. |
| * |
| * @return true if safe to remove the element |
| */ |
| public fun canRemove(): Boolean |
| |
| /** |
| * Associates a name with this element. |
| */ |
| public var name: String? |
| |
| /** |
| * Associates a comment with this element. |
| */ |
| public var comment: String? |
| |
| /** |
| * Called when the test element is removed from the test plan. |
| * Must not throw any exception |
| */ |
| public fun removed() { |
| // NOOP |
| } |
| } |
