Class LDAPArguments

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.config.ConfigTestElement
org.apache.jmeter.protocol.ldap.config.gui.LDAPArguments
All Implemented Interfaces:
Serializable, Cloneable, org.apache.jmeter.config.ConfigElement, org.apache.jmeter.gui.Searchable, org.apache.jmeter.testelement.TestElement

public class LDAPArguments extends org.apache.jmeter.config.ConfigTestElement implements Serializable
A set of LDAPArgument objects. author Dolf Smits([email protected]) created Aug 09 2003 11:00 AM company Siemens Netherlands N.V.. Based on the work of: author Michael Stover author Mark Walsh
See Also:
  • 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
    The name of the property used to store the arguments.

    Fields inherited from class org.apache.jmeter.config.ConfigTestElement

    PASSWORD, USERNAME

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

    COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS
  • Constructor Summary

    Constructors
    Constructor
    Description
    Create a new Arguments object with no arguments.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addArgument(String name, String value, String opcode)
    Add a new argument with the given name and value.
    void
    addArgument(String name, String value, String opcode, String metadata)
    Add a new argument with the given name, value, and metadata.
    void
    Add a new argument.
    void
    Add a new empty argument to the list.
    void
    Clear the arguments.
    getArgument(int row)
    Get a single argument.
    int
    Get the number of arguments in the list.
    org.apache.jmeter.testelement.property.CollectionProperty
    Get the arguments.
    Get the arguments as a Map.
    org.apache.jmeter.testelement.property.PropertyIterator
    Get a PropertyIterator of the arguments.
    void
    Remove all arguments from the list.
    void
    removeArgument(int row)
    Remove the specified argument from the list.
    void
    Remove the argument with the specified name.
    void
    Remove the specified argument from the list.
    void
    setArguments(List<Object> arguments)
    Set the list of arguments.
    Create a string representation of the arguments.

    Methods inherited from class org.apache.jmeter.config.ConfigTestElement

    addConfigElement, addTestElement, expectsModification, getProps, getSchema

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

    addPropertiesValues, addProperty, addProperty, canRemove, clearTemporary, clearTestElementChildren, clone, 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, wait, wait, wait

    Methods inherited from interface org.apache.jmeter.config.ConfigElement

    clone

    Methods inherited from interface org.apache.jmeter.testelement.TestElement

    get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getPropertyOrNull, getString, removed, removeProperty, set, set, set, set, set, set, set, set, set
  • Field Details

    • ARGUMENTS

      public static final String ARGUMENTS
      The name of the property used to store the arguments.
      See Also:
  • Constructor Details

    • LDAPArguments

      public LDAPArguments()
      Create a new Arguments object with no arguments.
  • Method Details

    • getArguments

      public org.apache.jmeter.testelement.property.CollectionProperty getArguments()
      Get the arguments.
      Returns:
      the arguments
    • clear

      public void clear()
      Clear the arguments.
      Specified by:
      clear in interface org.apache.jmeter.testelement.TestElement
      Overrides:
      clear in class org.apache.jmeter.testelement.AbstractTestElement
    • setArguments

      public void setArguments(List<Object> arguments)
      Set the list of arguments. Any existing arguments will be lost.
      Parameters:
      arguments - the new arguments
    • getArgumentsAsMap

      public Map<String,String> getArgumentsAsMap()
      Get the arguments as a Map. Each argument name is used as the key, and its value as the value.
      Returns:
      a new Map with String keys and values containing the arguments
    • addArgument

      public void addArgument(String name, String value, String opcode)
      Add a new argument with the given name and value.
      Parameters:
      name - the name of the argument
      value - the value of the argument
      opcode - the operation to perform, may be one of add, delete, remove or modify.
    • addArgument

      public void addArgument(LDAPArgument arg)
      Add a new argument.
      Parameters:
      arg - the new argument
    • addArgument

      public void addArgument(String name, String value, String opcode, String metadata)
      Add a new argument with the given name, value, and metadata.
      Parameters:
      name - the name of the argument
      value - the value of the argument
      opcode - the operation to perform, may be one of add, delete, remove or modify.
      metadata - the metadata for the argument
    • iterator

      public org.apache.jmeter.testelement.property.PropertyIterator iterator()
      Get a PropertyIterator of the arguments.
      Returns:
      an iteration of the arguments
    • toString

      public String toString()
      Create a string representation of the arguments.
      Overrides:
      toString in class Object
      Returns:
      the string representation of the arguments
    • removeArgument

      public void removeArgument(int row)
      Remove the specified argument from the list.
      Parameters:
      row - the index of the argument to remove
    • removeArgument

      public void removeArgument(LDAPArgument arg)
      Remove the specified argument from the list.
      Parameters:
      arg - the argument to remove
    • removeArgument

      public void removeArgument(String argName)
      Remove the argument with the specified name.
      Parameters:
      argName - the name of the argument to remove
    • removeAllArguments

      public void removeAllArguments()
      Remove all arguments from the list.
    • addEmptyArgument

      public void addEmptyArgument()
      Add a new empty argument to the list. The new argument will have the empty string as its name and value, and null metadata.
    • getArgumentCount

      public int getArgumentCount()
      Get the number of arguments in the list.
      Returns:
      the number of arguments
    • getArgument

      public LDAPArgument getArgument(int row)
      Get a single argument.
      Parameters:
      row - the index of the argument to return.
      Returns:
      the argument at the specified index, or null if no argument exists at that index.