Apache JMeter

org.apache.jmeter.protocol.ftp.sampler
Class FTPSampler

java.lang.Object
  extended by org.apache.jmeter.testelement.AbstractTestElement
      extended by org.apache.jmeter.samplers.AbstractSampler
          extended by org.apache.jmeter.protocol.ftp.sampler.FTPSampler
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Interruptible, Sampler, TestElement

public class FTPSampler
extends AbstractSampler
implements Interruptible

A sampler which understands FTP file requests.

See Also:
Serialized Form

Field Summary
static java.lang.String BINARY_MODE
           
static java.lang.String INPUT_DATA
           
static java.lang.String LOCAL_FILENAME
           
static java.lang.String PORT
           
static java.lang.String REMOTE_FILENAME
           
static java.lang.String SAVE_RESPONSE
           
static java.lang.String SERVER
           
static java.lang.String UPLOAD_FILE
           
 
Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS
 
Constructor Summary
FTPSampler()
           
 
Method Summary
 java.lang.String getLabel()
          Returns a formatted string label describing this sampler Example output: ftp://ftp.nowhere.com/pub/README.txt
 java.lang.String getLocalFilename()
           
 java.lang.String getPassword()
           
 java.lang.String getPort()
           
 int getPortAsInt()
           
 java.lang.String getRemoteFilename()
           
 java.lang.String getServer()
           
 java.lang.String getUsername()
           
 boolean interrupt()
          Interrupt the current operation if possible.
 boolean isBinaryMode()
           
 boolean isSaveResponse()
           
 boolean isUpload()
           
 SampleResult sample(Entry e)
          Obtains statistics about the given Entry, and packages the information into a SampleResult.
 void setPort(java.lang.String newPort)
           
 void setServer(java.lang.String newServer)
           
 
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, 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, clone, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse
 

Field Detail

SERVER

public static final java.lang.String SERVER
See Also:
Constant Field Values

PORT

public static final java.lang.String PORT
See Also:
Constant Field Values

REMOTE_FILENAME

public static final java.lang.String REMOTE_FILENAME
See Also:
Constant Field Values

LOCAL_FILENAME

public static final java.lang.String LOCAL_FILENAME
See Also:
Constant Field Values

INPUT_DATA

public static final java.lang.String INPUT_DATA
See Also:
Constant Field Values

BINARY_MODE

public static final java.lang.String BINARY_MODE
See Also:
Constant Field Values

UPLOAD_FILE

public static final java.lang.String UPLOAD_FILE
See Also:
Constant Field Values

SAVE_RESPONSE

public static final java.lang.String SAVE_RESPONSE
See Also:
Constant Field Values
Constructor Detail

FTPSampler

public FTPSampler()
Method Detail

getUsername

public java.lang.String getUsername()

getPassword

public java.lang.String getPassword()

setServer

public void setServer(java.lang.String newServer)

getServer

public java.lang.String getServer()

setPort

public void setPort(java.lang.String newPort)

getPort

public java.lang.String getPort()

getPortAsInt

public int getPortAsInt()

getRemoteFilename

public java.lang.String getRemoteFilename()

getLocalFilename

public java.lang.String getLocalFilename()

isBinaryMode

public boolean isBinaryMode()

isSaveResponse

public boolean isSaveResponse()

isUpload

public boolean isUpload()

getLabel

public java.lang.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 SampleResult sample(Entry e)
Description copied from interface: Sampler
Obtains statistics about the given Entry, and packages the information into a SampleResult.

Specified by:
sample in interface Sampler

interrupt

public boolean interrupt()
Interrupt the current operation if possible.

Specified by:
interrupt in interface Interruptible
Returns:
true if there was an operation to interrupt.

Apache JMeter

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.