org.globus.ftp.app
Class TransferParams

java.lang.Object
  extended by org.globus.ftp.Session
      extended by org.globus.ftp.GridFTPSession
          extended by org.globus.ftp.app.TransferParams

public class TransferParams
extends GridFTPSession

Represents parameters of a transfer. This class should be used in conjunction with class Transfer. You first configure a TransferParams object by setting values directly (parameters are public, there's no getter/setter methods). Then pass this object to a Transfer constructor that will perform the transfer as required.

In general, the meaning of a parameter values is as follows. A value of SERVER_DEFAULT (in case of integer values) or null (in case of objects) indicate that this parameter should not be explicitly set to the server, and the server will use its defaults. Any other value will be explicitly requested from the server on the control channel.

For example, if transferMode is set to SERVER_DEFAULT, client will not directly request any transfer mode, and the server should use its default which is stream mode. If transferMode is set to MODE_STREAM, stream mode will be explicitly requested from the server, so it will also use stream mode. To request extended block mode, set transferMode to MODE_EBLOCK.

Below is a list of parameters that can be set to TransferParams and can affect the transfer:

See Also:
Transfer

Field Summary
 boolean doStriping
           
 MarkerListener markerListener
           
 
Fields inherited from class org.globus.ftp.GridFTPSession
credential, dataChannelAuthentication, dataChannelProtection, MODE_EBLOCK, parallel, PROTECTION_CLEAR, PROTECTION_CONFIDENTIAL, PROTECTION_PRIVATE, PROTECTION_SAFE, SERVER_EACT, SERVER_EPAS, serverAddressList, TCPBufferSize
 
Fields inherited from class org.globus.ftp.Session
authorized, DEFAULT_MAX_WAIT, DEFAULT_WAIT_DELAY, featureList, maxWait, MODE_BLOCK, MODE_STREAM, protectionBufferSize, SERVER_ACTIVE, SERVER_DEFAULT, SERVER_PASSIVE, serverAddress, serverMode, transferMode, transferType, TYPE_ASCII, TYPE_EBCDIC, TYPE_IMAGE, TYPE_LOCAL, waitDelay
 
Constructor Summary
TransferParams()
          This constructor sets parameters to the GridFTP defaults.
 
Method Summary
 
Methods inherited from class org.globus.ftp.GridFTPSession
compareServerMode, matches, needsGridFTP
 
Methods inherited from class org.globus.ftp.Session
compareTransferParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

doStriping

public boolean doStriping

markerListener

public MarkerListener markerListener
Constructor Detail

TransferParams

public TransferParams()
This constructor sets parameters to the GridFTP defaults. If possible, a parameter is not explicitly set, but server defaults are assumed.