Package org.apache.jmeter.protocol.http.control.gui

Class HttpTestSampleGui

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.samplers.gui.AbstractSamplerGui
org.apache.jmeter.protocol.http.control.gui.HttpTestSampleGui
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, ClearGui, JMeterGUIComponent, Printable
Direct Known Subclasses:
AjpSamplerGui, GraphQLHTTPSamplerGui
public class HttpTestSampleGui extends AbstractSamplerGui
HTTP Sampler GUI
See Also:

  • Constructor Details

    • HttpTestSampleGui

      public HttpTestSampleGui()

    • HttpTestSampleGui

      protected HttpTestSampleGui(boolean ajp)

  • Method Details

    • 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
      Overrides:
      configure in class AbstractJMeterGuiComponent
      Parameters:
      element - the TestElement to configure

    • makeTestElement

      public org.apache.jmeter.testelement.TestElement makeTestElement()
      Creates the test element represented by the GUI component.
      Returns:
      a new TestElement

    • assignDefaultValues

      public void assignDefaultValues(org.apache.jmeter.testelement.TestElement element)
      Description copied from interface: JMeterGUIComponent
      Configures default values for element after its creation. Plugin authors should call this once in their JMeterGUIComponent.createTestElement() implementation.
      Parameters:
      element - test element to configure

    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.TestElement sampler)
      Modifies a given TestElement to mirror the data in the gui components.

      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: 

       @Override
 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
      Overrides:
      modifyTestElement in class AbstractJMeterGuiComponent
      Parameters:
      sampler - the TestElement to modify

    • 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.

      Returns:
      the resource name

    • createTabbedConfigPane

      protected JTabbedPane createTabbedConfigPane()
      Create the parameters configuration tabstrip which includes the Basic tab (UrlConfigGui) and the Advanced tab by default.
      Returns:
      the parameters configuration tabstrip which includes the Basic tab (UrlConfigGui) and the Advanced tab by default

    • createUrlConfigGui

      protected UrlConfigGui createUrlConfigGui()
      Create a UrlConfigGui which is used as the Basic tab in the parameters configuration tabstrip.
      Returns:
      a UrlConfigGui which is used as the Basic tab

    • createEmbeddedRsrcPanel

      protected JPanel createEmbeddedRsrcPanel()

    • getImplementationPanel

      protected final JPanel getImplementationPanel()
      Create a panel containing the implementation details
      Returns:
      the panel

    • createOptionalTasksPanel

      protected JPanel createOptionalTasksPanel()

    • createSourceAddrPanel

      protected JPanel createSourceAddrPanel()

    • getPreferredSize

      public Dimension getPreferredSize()
      Overrides:
      getPreferredSize in class JComponent

    • clearGui

      public void clearGui()
      Description copied from class: AbstractJMeterGuiComponent
      Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. Your GUI may need more things cleared, in which case you should override, clear the extra fields, and still call super.clearGui().
      Specified by:
      clearGui in interface ClearGui
      Overrides:
      clearGui in class AbstractJMeterGuiComponent

    • getProxyServerPanel

      protected final JPanel getProxyServerPanel()
      Create a panel containing the proxy server details
      Returns:
      the panel