Package org.apache.jmeter.protocol.ftp.sampler

Class FTPSampler

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.samplers.AbstractSampler
org.apache.jmeter.protocol.ftp.sampler.FTPSampler
All Implemented Interfaces:
Serializable, Cloneable, org.apache.jmeter.engine.util.ConfigMergabilityIndicator, org.apache.jmeter.gui.Searchable, org.apache.jmeter.samplers.Interruptible, org.apache.jmeter.samplers.Sampler, org.apache.jmeter.testelement.TestElement
public class FTPSampler extends org.apache.jmeter.samplers.AbstractSampler implements org.apache.jmeter.samplers.Interruptible
A sampler which understands FTP file requests.
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
    BINARY_MODE
     
    static final String
    INPUT_DATA
     
    static final String
    LOCAL_FILENAME
     
    static final String
    PORT
     
    static final String
    REMOTE_FILENAME
     
    static final String
    SAVE_RESPONSE
     
    static final String
    SERVER
     
    static final String
    UPLOAD_FILE
     

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

    COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS

  • Constructor Summary

    Constructors
    Constructor
    Description
    FTPSampler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    applies(org.apache.jmeter.config.ConfigTestElement configElement)
     
    String
    getLabel()
    Returns a formatted string label describing this sampler Example output: ftp://ftp.nowhere.com/pub/README.txt
    String
    getLocalFilename()
     
    String
    getPassword()
     
    String
    getPort()
     
    int
    getPortAsInt()
     
    String
    getRemoteFilename()
     
    String
    getServer()
     
    String
    getUsername()
     
    boolean
    interrupt()
    boolean
    isBinaryMode()
     
    boolean
    isSaveResponse()
     
    boolean
    isUpload()
     
    org.apache.jmeter.samplers.SampleResult
    sample(org.apache.jmeter.samplers.Entry e)
     
    void
    setPort(String newPort)
     
    void
    setServer(String newServer)
     

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

    addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, 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, 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, getProps, getSchema, 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

  • Constructor Details

    • FTPSampler

      public FTPSampler()

  • Method Details

    • getUsername

      public String getUsername()

    • getPassword

      public String getPassword()

    • setServer

      public void setServer(String newServer)

    • getServer

      public String getServer()

    • setPort

      public void setPort(String newPort)

    • getPort

      public String getPort()

    • getPortAsInt

      public int getPortAsInt()

    • getRemoteFilename

      public String getRemoteFilename()

    • getLocalFilename

      public String getLocalFilename()

    • isBinaryMode

      public boolean isBinaryMode()

    • isSaveResponse

      public boolean isSaveResponse()

    • isUpload

      public boolean isUpload()

    • getLabel

      public String getLabel()
      Returns a formatted string label describing this sampler Example output: ftp://ftp.nowhere.com/pub/README.txt
      Returns:
      a formatted string label describing this sampler

    • sample

      public org.apache.jmeter.samplers.SampleResult sample(org.apache.jmeter.samplers.Entry e)
      Specified by:
      sample in interface org.apache.jmeter.samplers.Sampler

    • interrupt

      public boolean interrupt()
      Specified by:
      interrupt in interface org.apache.jmeter.samplers.Interruptible

    • applies

      public boolean applies(org.apache.jmeter.config.ConfigTestElement configElement)
      Specified by:
      applies in interface org.apache.jmeter.engine.util.ConfigMergabilityIndicator
      Overrides:
      applies in class org.apache.jmeter.samplers.AbstractSampler
      See Also:
      • AbstractSampler.applies(org.apache.jmeter.config.ConfigTestElement)