Class ProxyControlGui

All Implemented Interfaces:
ActionListener, ItemListener, KeyListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ClearGui, JMeterGUIComponent, UnsharedComponent, Printable

GUI of HTTP(s) Test Script Recorder
See Also:
  • Constructor Details

    • ProxyControlGui

      public ProxyControlGui()
  • Method Details

    • createTestElement

      public org.apache.jmeter.testelement.TestElement createTestElement()
      JMeter test components are separated into a model and a GUI representation. The model holds the data and the GUI displays it. The GUI class is responsible for knowing how to create and initialize with data the model class that it knows how to display, and this method is called when new test elements are created.

      Since 5.6.3, the default implementation is as follows, and subclasses should override JMeterGUIComponent.makeTestElement()

       public TestElement createTestElement() {
           TestElement element = makeTestElement();
           return el;

      Before 5.6.3 the canonical implementation was as follows, however, it is recommended to avoid overriding JMeterGUIComponent.createTestElement() and override JMeterGUIComponent.makeTestElement() instead.

       public TestElement createTestElement() {
           TestElementXYZ el = new TestElementXYZ();
           return el;
      Specified by:
      createTestElement in interface JMeterGUIComponent
      createTestElement in class LogicControllerGui
      the Test Element object that the GUI component represents.
    • makeProxyControl

      protected ProxyControl makeProxyControl()
    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.TestElement el)
      GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. This method should overwrite whatever data is currently in the TestElement as it is called after a user has filled out the form elements in the gui with new information.

      If you override AbstractJMeterGuiComponent, you might want using AbstractJMeterGuiComponent.bindingGroup instead of overriding modifyTestElement.

      The canonical implementation looks like this:

       public void modifyTestElement(TestElement element) {
           super.modifyTestElement(element); // clear the element and assign basic fields like name, gui class, test class
           // Using the element setters (preferred):
           // If the field is empty, you probably want to remove the property instead of storing an empty string
           // See Streamline binding of UI elements to TestElement properties
           // for more details
           TestElementXYZ xyz = (TestElementXYZ) element;
           xyz.setState(StringUtils.defaultIfEmpty(guiState.getText(), null));
           xyz.setCode(StringUtils.defaultIfEmpty(guiCode.getText(), null));
           ... other GUI fields ...
           // or directly (do not use unless there is no setter for the field):
           element.setProperty(TestElementXYZ.STATE, StringUtils.defaultIfEmpty(guiState.getText(), null))
           element.setProperty(TestElementXYZ.CODE, StringUtils.defaultIfEmpty(guiCode.getText(), null))
           ... other GUI fields ...
      Specified by:
      modifyTestElement in interface JMeterGUIComponent
      modifyTestElement in class LogicControllerGui
      el - the TestElement to modify
    • setIncludeListInProxyControl

      protected void setIncludeListInProxyControl(ProxyControl element)
    • setExcludeListInProxyControl

      protected void setExcludeListInProxyControl(ProxyControl element)
    • getLabelResource

      public String getLabelResource()
      Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language. The resource name is fixed, and does not vary with the selected language.

      Normally this method should be overridden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.

      Specified by:
      getLabelResource in interface JMeterGUIComponent
      getLabelResource in class LogicControllerGui
      the resource name
    • getMenuCategories

      public Collection<String> getMenuCategories()
      This is the list of menu categories this gui component will be available under. This implementation returns MenuFactory.CONTROLLERS, which is appropriate for most controller components.
      Specified by:
      getMenuCategories in interface JMeterGUIComponent
      getMenuCategories in class AbstractControllerGui
      a Collection of Strings, where each element is one of the constants defined in MenuFactory
      See Also:
    • configure

      public void configure(org.apache.jmeter.testelement.TestElement element)
      A newly created gui component can be initialized with the contents of a Test Element object by calling this method. The component is responsible for querying the Test Element object for the relevant information to display in its GUI.

      AbstractJMeterGuiComponent provides a partial implementation of this method, setting the name of the component and its enabled status. Subclasses should override this method, performing their own configuration as needed, but also calling this super-implementation.

      Specified by:
      configure in interface JMeterGUIComponent
      configure in class AbstractJMeterGuiComponent
      element - the TestElement to configure
    • itemStateChanged

      public void itemStateChanged(ItemEvent e)
      Specified by:
      itemStateChanged in interface ItemListener
    • actionPerformed

      public void actionPerformed(ActionEvent action)
      Specified by:
      actionPerformed in interface ActionListener
    • addSuggestedExcludes

      protected void addSuggestedExcludes(JTable table)
      Add suggested excludes to exclude table
      table - JTable
    • addFromClipboard

      protected void addFromClipboard(JTable table)
      Add values from the clipboard to table
      table - JTable
    • keyPressed

      public void keyPressed(KeyEvent e)
      Specified by:
      keyPressed in interface KeyListener
    • keyTyped

      public void keyTyped(KeyEvent e)
      Specified by:
      keyTyped in interface KeyListener
    • keyReleased

      public void keyReleased(KeyEvent e)
      Specified by:
      keyReleased in interface KeyListener
    • createPopupMenu

      public JPopupMenu createPopupMenu()
      Redefined to remove change parent and insert parent menu
      Specified by:
      createPopupMenu in interface JMeterGUIComponent
      createPopupMenu in class AbstractControllerGui
      a JPopupMenu appropriate for the component.
      See Also:
    • getPrefixHTTPSampleName

      public String getPrefixHTTPSampleName()