IP*Works! V9

ipworks
Class Ftp

java.lang.Object
  extended by ipworks.Ftp

public class Ftp
extends java.lang.Object

The FTP Bean can be used to transfer files to and from FTP servers using the FTP Protocol.

The FTP Bean implements a standard FTP client as specified in RFC 959 and RFC 1579.

The first step in using the bean is specifying the RemoteHost , User and Password . The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile . The current path in the server is specified by the RemotePath property. The Passive property is especially useful if the client is behind a firewall which inhibits incoming connections to higher ports.

If LocalFile is set to something other than an empty string, then files are received in LocalFile , otherwise the data is received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

The PITrail event traces the interaction between the client and the server (the FTP Protocol Interface connection).

Directory listings are received through the DirList event.


Field Summary
static int tmASCII
           
static int tmBinary
           
static int tmDefault
           
 
Constructor Summary
Ftp()
          Creates an instance of Ftp Bean.
Ftp(java.lang.String runtimeLicense)
          Creates an instance of Ftp Bean with specified run-time license.
 
Method Summary
 void abort()
          Abort Current Upload/Download.
 void addFtpEventListener(FtpEventListener l)
           
 void append()
          Append data from LocalFile to a RemoteFile on an FTP server.
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a configuration setting.
 void deleteFile(java.lang.String fileName)
          Remove a file specified by FileName from an FTP server.
 void doEvents()
          Processes events from the internal message queue.
 void download()
          Download a RemoteFile from an FTP server.
 java.lang.String getAccount()
          The user account to login with.
 DirEntryList getDirList()
          Collection of entries resulting in the last directory listing.
 long getFileSize()
          The size of the file pointed to by RemoteFile .
 java.lang.String getFileTime()
          The last modification time of the file pointed to by RemoteFile .
 Firewall getFirewall()
          A set of properties related to firewall access.
 java.lang.String getLastReply()
          The last reply from the server.
 java.lang.String getLocalFile()
          The path to a local file for download/upload.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 java.lang.String getPassword()
          The password to log in.
 java.lang.String getRemoteFile()
          The name of the remote file for uploading, downloading, etc.
 java.lang.String getRemoteHost()
          The domain name or IP address of the FTP server.
 java.lang.String getRemotePath()
          The current path in the FTP server.
 int getRemotePort()
          The port for the FTP service (default is 21).
 java.lang.String getStartByte()
          The byte index in RemoteFile and LocalFile from which to start the transmission.
 int getTimeout()
          A timeout for the bean.
 int getTransferMode()
          The transfer mode (ASCII or Binary).
 java.lang.String getUser()
          The user identifier to use for login.
 void interrupt()
          Interrupt the current method.
 boolean isConnected()
          Shows whether the bean is connected.
 boolean isFileExists()
          Returns True if the file specified by RemoteFile exists on the remote server.
 boolean isIdle()
          The current status of the component.
 boolean isOverwrite()
          Indicates whether or not the bean should overwrite files during transfer.
 boolean isPassive()
          Controls whether to direct the server into passive mode.
 void listDirectory()
          List the current directory specified by RemotePath on an FTP server.
 void listDirectoryLong()
          List extended directory information for RemotePath .
 void logoff()
          Logoff from the FTP server by posting a QUIT command.
 void logon()
          Logon to the FTP RemoteHost using the current User and Password .
 void makeDirectory(java.lang.String newDir)
          Create a directory on an FTP server.
 void removeDirectory(java.lang.String dirName)
          Remove a directory specified by DirName from an FTP server.
 void removeFtpEventListener(FtpEventListener l)
           
 void renameFile(java.lang.String newName)
          Change the name of RemoteFile to NewName .
 void setAccount(java.lang.String account)
          The user account to login with.
 void setCommand(java.lang.String command)
          Used to send additional commands directly to the server.
 void setConnected(boolean connected)
          Shows whether the bean is connected.
 void setDownloadStream(java.io.OutputStream downloadStream)
          Sets the stream to which the downloaded data from the server will be written.
 void setFirewall(Firewall firewall)
          A set of properties related to firewall access.
 void setLocalFile(java.lang.String localFile)
          The path to a local file for download/upload.
 void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 void setOverwrite(boolean overwrite)
          Indicates whether or not the bean should overwrite files during transfer.
 void setPassive(boolean passive)
          Controls whether to direct the server into passive mode.
 void setPassword(java.lang.String password)
          The password to log in.
 void setRemoteFile(java.lang.String remoteFile)
          The name of the remote file for uploading, downloading, etc.
 void setRemoteHost(java.lang.String remoteHost)
          The domain name or IP address of the FTP server.
 void setRemotePath(java.lang.String remotePath)
          The current path in the FTP server.
 void setRemotePort(int remotePort)
          The port for the FTP service (default is 21).
 void setStartByte(java.lang.String startByte)
          The byte index in RemoteFile and LocalFile from which to start the transmission.
 void setTimeout(int timeout)
          A timeout for the bean.
 void setTransferMode(int transferMode)
          The transfer mode (ASCII or Binary).
 void setUploadStream(java.io.InputStream uploadStream)
          Sets the stream from which the bean will read data to upload to the server.
 void setUser(java.lang.String user)
          The user identifier to use for login.
 void storeUnique()
          Upload a file with a Unique Name to an FTP server.
 void upload()
          Upload a file specified by LocalFile to an FTP server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tmDefault

public static final int tmDefault
See Also:
Constant Field Values

tmASCII

public static final int tmASCII
See Also:
Constant Field Values

tmBinary

public static final int tmBinary
See Also:
Constant Field Values
Constructor Detail

Ftp

public Ftp()
Creates an instance of Ftp Bean.


Ftp

public Ftp(java.lang.String runtimeLicense)
Creates an instance of Ftp Bean with specified run-time license.

Method Detail

getAccount

public java.lang.String getAccount()
The user account to login with.

This property contains the user account to use when logging in. Some servers may require an Account in order to Logon or in order to access specific privileges, like uploading or deleting files.


setAccount

public void setAccount(java.lang.String account)
                throws IPWorksException
The user account to login with.

This property contains the user account to use when logging in. Some servers may require an Account in order to Logon or in order to access specific privileges, like uploading or deleting files.

Throws:
IPWorksException

setCommand

public void setCommand(java.lang.String command)
                throws IPWorksException
Used to send additional commands directly to the server.

This property can be used to send additional commands directly to the server. Check the LastReply property and/or trap the PITrail events coming from the server to get the response.

Throws:
IPWorksException

isConnected

public boolean isConnected()
Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.


setConnected

public void setConnected(boolean connected)
                  throws IPWorksException
Shows whether the bean is connected.

This property is used to determine whether or not the bean is connected to the remote host.

Throws:
IPWorksException

getDirList

public DirEntryList getDirList()
Collection of entries resulting in the last directory listing.

This property contains the collection of entries resulting in the last directory listing. A collection is returned after a response is received from the server after a call to either ListDirectory or ListDirectoryLong . The collection is made up of entries for each listing in the current directory, specified by the RemotePath property.

MaxDirEntries can be used to control the number of directory listings saved.

This collection is indexed from 0 to size - 1.


isFileExists

public boolean isFileExists()
Returns True if the file specified by RemoteFile exists on the remote server.

This property returns True if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile prior to calling this method.

If the bean is busy or is not connected, 0 is returned.

If there is no FTP session in place, one is automatically created by first calling the Logon method.


getFileSize

public long getFileSize()
The size of the file pointed to by RemoteFile .

When this property is read, the FTP server is queried for the file size, and the response is provided as the property value.

If the bean is busy or is not connected, 0 is returned.


getFileTime

public java.lang.String getFileTime()
The last modification time of the file pointed to by RemoteFile .

When this property is read, the FTP server is queried for the file modification time, and the response is provided as the property value.

If the bean is busy or is not connected, an empty string is returned.


getFirewall

public Firewall getFirewall()
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.


setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksException
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:
IPWorksException

isIdle

public boolean isIdle()
The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.


getLastReply

public java.lang.String getLastReply()
The last reply from the server.

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.


getLocalFile

public java.lang.String getLocalFile()
The path to a local file for download/upload. If the file exists, it is overwritten.

This property is used by the Upload and Download methods to specify the path to a local file to be downloaded/uploaded. See the method descriptions for more information.

Example (Setting LocalFile)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Download()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Download() 


setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksException
The path to a local file for download/upload. If the file exists, it is overwritten.

This property is used by the Upload and Download methods to specify the path to a local file to be downloaded/uploaded. See the method descriptions for more information.

Example (Setting LocalFile)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Download()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Download() 

Throws:
IPWorksException

getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Throws:
IPWorksException

isOverwrite

public boolean isOverwrite()
Indicates whether or not the bean should overwrite files during transfer.

This property is a value indicating whether or not the bean should overwrite downloaded files. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.


setOverwrite

public void setOverwrite(boolean overwrite)
                  throws IPWorksException
Indicates whether or not the bean should overwrite files during transfer.

This property is a value indicating whether or not the bean should overwrite downloaded files. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

Throws:
IPWorksException

isPassive

public boolean isPassive()
Controls whether to direct the server into passive mode. Recommended if behind a firewall.

This property controls whether to direct the server into passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client bean expects them. If Passive is set to TRUE , the bean will use the PASV instead of the PORT command and will thus direct the server into passive mode: connections are initiated only by the client.


setPassive

public void setPassive(boolean passive)
                throws IPWorksException
Controls whether to direct the server into passive mode. Recommended if behind a firewall.

This property controls whether to direct the server into passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client bean expects them. If Passive is set to TRUE , the bean will use the PASV instead of the PORT command and will thus direct the server into passive mode: connections are initiated only by the client.

Throws:
IPWorksException

getPassword

public java.lang.String getPassword()
The password to log in.

This property contains the password used to log in and must be set before the bean connects to the FTP server.


setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksException
The password to log in.

This property contains the password used to log in and must be set before the bean connects to the FTP server.

Throws:
IPWorksException

getRemoteFile

public java.lang.String getRemoteFile()
The name of the remote file for uploading, downloading, etc.

This property contains the name of the remote file to upload, download, etc. and is either an absolute file path, or a relative path based on RemotePath .

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Download()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Download() 

Note: This property will also act as a file mask when performing ListDirectory or ListDirectoryLong .

Example (Using RemoteFile as a file mask):

 FTPControl.RemoteFile = "*.txt"
 FTPControl.ListDirectory() 

The RemoteFile property supports several pattern matching characters. The following special characters are supported for pattern matching:

?
Any single character.
*
Any characters or no characters. I.E., C*t matches Cat, Cot, Coast, Ct, etc)
[,-]
A range of characters. E.g.: [a-z], [a], [0-9], [0-9,a-d,f,r-z], etc.
\\
The slash is ignored and exact matching is performed on the next character.

If the above characters need to be used as a literal in a FileMask then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:

Character
Escape Sequence
?
[?]
*
[*]
[
[[]
\\
[\\]

For example, if you wanted to download a file whose name was [Something].txt you could set the RemoteFile property to: [[]Something].txt


setRemoteFile

public void setRemoteFile(java.lang.String remoteFile)
                   throws IPWorksException
The name of the remote file for uploading, downloading, etc.

This property contains the name of the remote file to upload, download, etc. and is either an absolute file path, or a relative path based on RemotePath .

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Download()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Download() 

Note: This property will also act as a file mask when performing ListDirectory or ListDirectoryLong .

Example (Using RemoteFile as a file mask):

 FTPControl.RemoteFile = "*.txt"
 FTPControl.ListDirectory() 

The RemoteFile property supports several pattern matching characters. The following special characters are supported for pattern matching:

?
Any single character.
*
Any characters or no characters. I.E., C*t matches Cat, Cot, Coast, Ct, etc)
[,-]
A range of characters. E.g.: [a-z], [a], [0-9], [0-9,a-d,f,r-z], etc.
\\
The slash is ignored and exact matching is performed on the next character.

If the above characters need to be used as a literal in a FileMask then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:

Character
Escape Sequence
?
[?]
*
[*]
[
[[]
\\
[\\]

For example, if you wanted to download a file whose name was [Something].txt you could set the RemoteFile property to: [[]Something].txt

Throws:
IPWorksException

getRemoteHost

public java.lang.String getRemoteHost()
The domain name or IP address of the FTP server.

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.


setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)
                   throws IPWorksException
The domain name or IP address of the FTP server.

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Throws:
IPWorksException

getRemotePath

public java.lang.String getRemotePath()
The current path in the FTP server.

This property shows the current working directory on the FTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of this property.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

Setting this property causes the bean to send the appropriate command to the remote server only if connected.

Example (Changing Directory)

 FTPControl.Logon()
 FTPControl.RemotePath = "/home/user" 


setRemotePath

public void setRemotePath(java.lang.String remotePath)
                   throws IPWorksException
The current path in the FTP server.

This property shows the current working directory on the FTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of this property.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

Setting this property causes the bean to send the appropriate command to the remote server only if connected.

Example (Changing Directory)

 FTPControl.Logon()
 FTPControl.RemotePath = "/home/user" 

Throws:
IPWorksException

getRemotePort

public int getRemotePort()
The port for the FTP service (default is 21).

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.


setRemotePort

public void setRemotePort(int remotePort)
                   throws IPWorksException
The port for the FTP service (default is 21).

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Throws:
IPWorksException

getStartByte

public java.lang.String getStartByte()
The byte index in RemoteFile and LocalFile from which to start the transmission.

This property contains a zero-based index in both RemoteFile and LocalFile that determines the point where the transmission of data starts from. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the StartByte index is used for all future downloads/uploads. The property must be reset to "0" for normal downloads/uploads.

The type of the property is a string instead of numeric to allow for certain implementations that expect an alphanumeric marker of the start index.

In the Transfer event, the TransferredBytes parameter will include the bytes skipped (i.e. it will show StartByte more bytes than actually transferred).

NOTE: some FTP servers may not support the FTP 'REST' command. If that is the case with the server you are accessing, you will not be able to use the StartByte property.


setStartByte

public void setStartByte(java.lang.String startByte)
                  throws IPWorksException
The byte index in RemoteFile and LocalFile from which to start the transmission.

This property contains a zero-based index in both RemoteFile and LocalFile that determines the point where the transmission of data starts from. This is useful for resuming interrupted downloads and uploads of files from FTP servers.

Once set, the StartByte index is used for all future downloads/uploads. The property must be reset to "0" for normal downloads/uploads.

The type of the property is a string instead of numeric to allow for certain implementations that expect an alphanumeric marker of the start index.

In the Transfer event, the TransferredBytes parameter will include the bytes skipped (i.e. it will show StartByte more bytes than actually transferred).

NOTE: some FTP servers may not support the FTP 'REST' command. If that is the case with the server you are accessing, you will not be able to use the StartByte property.

Throws:
IPWorksException

getTimeout

public int getTimeout()
A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the bean.

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the bean will wait for the operation to complete before returning control.

The bean will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the bean throws an exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

Throws:
IPWorksException

getTransferMode

public int getTransferMode()
The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.

This property specifies the transfer mode, either ASCII or binary. The valid options for the TransferMode property are as follows:

tmDefault (0)
The initial mode of the FTP server is taken. No change.
tmASCII (1)
Files are transferred in ASCII mode (TYPE A).
tmBinary (2)
Files are transferred in Binary mode (TYPE I).


setTransferMode

public void setTransferMode(int transferMode)
                     throws IPWorksException
The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.

This property specifies the transfer mode, either ASCII or binary. The valid options for the TransferMode property are as follows:

tmDefault (0)
The initial mode of the FTP server is taken. No change.
tmASCII (1)
Files are transferred in ASCII mode (TYPE A).
tmBinary (2)
Files are transferred in Binary mode (TYPE I).

Throws:
IPWorksException

getUser

public java.lang.String getUser()
The user identifier to use for login.

This property contains the user identifier to be used when logging in and must be set before the bean connects to the FTP server.


setUser

public void setUser(java.lang.String user)
             throws IPWorksException
The user identifier to use for login.

This property contains the user identifier to be used when logging in and must be set before the bean connects to the FTP server.

Throws:
IPWorksException

abort

public void abort()
           throws IPWorksException
Abort Current Upload/Download.

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads/downloads.

Throws:
IPWorksException

append

public void append()
            throws IPWorksException
Append data from LocalFile to a RemoteFile on an FTP server.

This method causes the server-DTP to accept the data transferred via the data connection and to store the data in a file on the server site. If the file specified in the pathname exists on the server site, then the data shall be appended to that file; otherwise the file specified in the pathname shall be created on the server site. Similar to the Upload method but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as done by the Upload method. RemoteFile is either an absolute path on the server, or a path relative to RemotePath . The server will create a file with that name if it doesn't already exist (similar to Upload). If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException
Sets or retrieves a configuration setting.

Config is a generic method available in every bean. It is used to set and retrieve configuration settings for the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

FTP Configuration Settings

ActiveModePORTAddress
Allows the specification of the PORT address value for active mode connections
When using an active mode configuration ( Passive = False) with a firewall, it may sometimes be necessary to specify the actual PORT value to be sent to the server. ActiveModePORTAddress takes the protocol-level parameter in the form "a,b,c,d,e,f" where "a,b,c,d" is the external IP address separated by commas, and e and f represent, respectively, the high byte (divide by 256) and the low byte (mod 256) values of the external port where the FTP client is listening.This config must be used in conjunction with PortRange to ensure that the correct port is used by the client.

AppendToLocalFile
Append downloaded files to a local file
If set to true, the downloaded files will be appended to the file specified in LocalFile .
CalculatePercentDone
Enables or Disables calculating the percent complete for downloads
When set to True, the bean sends an FTP "SIZE" command to retrieve the file size before beginning a download. When downloading a large quantity of small files, performance may be increased by disabling this feature.
DirEntryPattern
Allows the use of regular expressions to parse non-standard directory entry formats
In some cases, the server may return a directory entry format that can not be automatically parsed by the adapter. In this case the full entry format can be seen in the DirEntry parameter of DirList . You can then use this property to define a regular expression to parse the entry. The value of this setting is specified in the following format:
 A,B,C,X=Y|RegEx 
A,B,C, and X represent integer values that correspond to the capturing groups of the regular expression in the following order:
  • FileName
  • FileSize
  • FileTime
  • IsDir

Since group X represents the IsDir value, the user must specify Y to indicate what value that group must have in order for IsDir to be true.

Take for instance a simple entry in this format:

 22 Test.txt 
In this example "22" is the FileSize and "Test.txt" is the FileName. In order to parse this entry we will define the DirEntryPattern as:
 2,1,-1,-1|([0-9]+)\\s(.*) 
The first value "2" indicates that the first field (FileName) corresponds to the second capturing group in the regular expression. The second value "1" indicates that the second field (FileSize) corresponds to the first capturing group in the regular expression. The capturing group is the regular expression in parenthesis. In the above example, the first capturing group is ([0-9]+) and the second capturing group is (.*).

As seen in the above example -1 can also be specified as the integer value. When this is specified that field is ignored.

DILinger
When set to True, DI connections are terminated gracefully
This property controls how the DI connection is closed. The default is True.In the case that DILinger is True (default), there are two scenarios for determining how long the connection will linger. The first, if DILingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, DILingerTime is a positive value, the system will attempt to send pending data until the specified DILingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

DILingerTime
Time in seconds to have the DI connection linger
LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.
FileTimeFormat
The format of file time reported by the server
The default value is "M/d/yyyy hh:mm:ss tt". When set, the bean will format the time returned by the server in the FileTime property. To disable all formatting set this to empty string.Note: This setting only applies to the FileTime property. It does not apply to the FileTime parameter of the DirList event.

MaxDirEntries
Instructs bean to save the amount of entries specified that are returned by the server after a ListDirectory call has been made
This config should be set when populating the DirList collection after a call to either ListDirectory or ListDirectoryLong . This value represents the number of entries that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

PortRange
Allows the specification of a port range where the bean listens for active mode connections
When set to use active mode ( Passive = False), the bean uses any available port to listen to incoming connections from the server. You can override this behavior by setting PortRange to a value containing the range of ports the bean will be listening to.The range is provided as start-end , for instance: "1024-" stands for anything higher than 1024, "1024-2048" stands for ports between 1024 and 2048 inclusive, "4000-4010, 50000-50010" stands for ports between 4000 and 4010 or between 50000 and 50010.

RealTimeUpload
Enables real time uploading
When this value is set to "True" the bean will upload the data in the file specified by LocalFile and continue monitoring LocalFile for additional data to upload until no new data is found for RealTimeUploadAgeLimit seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is "False".
RealTimeUploadAgeLimit
The age limit in seconds when using RealTimeUpload
This value is only applicable when RealTimeUpload is set to "True". This specifies the number of seconds for which the bean will monitor LocalFile for new data to upload. If this limit is reached and no new data is found in LocalFile the upload will complete. The default value is "1".
UseEPSV
Allows extended passive mode
When set, extended passive mode will be used.
UseMLSD
Uses listings for machine processing
When this is set to True the bean will list files in the directory using the MLSD command. This command is an extension to the protocol which defines a more standardized and reliable directory listing format. Not all servers support this command. The default value is False.When set to True, set RemoteFile to the filemask and call either ListDirectory or ListDirectoryLong . There is no difference between the two methods when this setting is enabled.

UseMLST
Uses single file listing for machine processing
This setting is similar to UseMLSD except that it is only valid for a single file. When this is set to True the bean will list the file or folder specified by RemoteFile . If RemoteFile is not set, a listing for the current directory itself will be returned. This command is an extension to the protocol which defines a more standardized and reliable directory listing format, but for a single file or folder only. Not all servers support this command. The default value is False.When set to True, set RemoteFile to the file or folder you wish to get information about and call either ListDirectory or ListDirectoryLong . There is no difference between the two methods when this setting is enabled. When both UseMLSD and UseMLST are set, UseMLSD takes precedence.

UseModeZ
Allows compression to be used when transferring data
The default value is false. When set to true the bean will issue the "MODE Z" command to the FTP server. This will enable deflate compression so all data transferred is first compressed either by the server (when downloading) or by the bean (when uploading). Note that not all servers support this feature.
ModeZCompressionLevel
Used to specify the level of compression used
The default value is 7. Valid values are from 0 to 9. A higher value indicates a higher compression level is used. This is only valid when UseModeZ is set to True.
UseRemoteHostAddressForPassive
Instructs bean to use the in passive mode
This config is only used when Passive is true. When this config is set to false, the bean parses the remote host to send replies to from the previous response from the server. If this config is true (default), the bean uses the value at RemoteHost instead.

IPPort Configuration Settings

FirewallAutoDetect
Tells the bean whether or not to automatically detect and use firewall system settings, if available
This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallHost
Name or IP address of firewall (optional)
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener
If true, the component binds to a SOCKS firewall as a server (IPPort only)
This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost , and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword
Password to be used if authentication is to be used when connecting through the firewall
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort
The TCP port for the FirewallHost;
Note that the FirewallPort is set automatically when FirewallType is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType
Determines the type of firewall to connect through
The appropriate values are as follows:
0
No firewall (default setting).
1
Connect through a tunneling proxy. FirewallPort is set to 80.
2
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser
A user name if authentication is to be used connecting through a firewall
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime
The inactivity time in milliseconds before a TCP keep-alive packet is sent
When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received
When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger
When set to True, connections are terminated gracefully
This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime
Time in seconds to have the connection linger
LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.
LocalHost
The name of the local host through which connections are initiated or accepted
The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort
The TCP port in the local host where the bean binds
This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength
The maximum amount of data to accumulate when no EOL is found
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate
The transfer rate limit in bytes per second
This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.
TCPKeepAlive
Determines whether or not the keep alive socket option is enabled
If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6
Whether or not to use IPv6
By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.
CloseStreamAfterTransfer
If true, the component will close the upload or download stream after the transfer
This entry is for bean and all the components that descend from it.This property is true by default. Therefore, by default, all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, you must set this config to false.

TcpNoDelay
Whether or not to delay when sending packets
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

Socket Configuration Settings

AbsoluteTimeout
Determines whether timeouts are inactivity timeouts or absolute timeouts
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
FirewallData
Used to send extra data to the firewall
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
InBufferSize
The size in bytes of the incoming queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize
The size in bytes of the outgoing queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable
Tells the bean whether or not a message loop is available for processing events
In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

Throws:
IPWorksException

deleteFile

public void deleteFile(java.lang.String fileName)
                throws IPWorksException
Remove a file specified by FileName from an FTP server.

This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

doEvents

public void doEvents()
              throws IPWorksException
Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:
IPWorksException

download

public void download()
              throws IPWorksException
Download a RemoteFile from an FTP server.

This method is used to download the remote file specified by RemoteFile to the local file specified by LocalFile , or it is retrieved through the Transfer event. If the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

Example (Download a File)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Download()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Download() 

Throws:
IPWorksException

interrupt

public void interrupt()
               throws IPWorksException
Interrupt the current method.

If there is no method in progress, Interrupt simply returns, doing nothing.

Throws:
IPWorksException

listDirectory

public void listDirectory()
                   throws IPWorksException
List the current directory specified by RemotePath on an FTP server.

This method is used to list the directory (or file mask) specified in RemoteFile . RemoteFile is either an absolute path on the server, or a path relative to RemotePath . The file listing is received through the DirList event.

Similar to ListDirectoryLong , except only file names are returned.

Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

listDirectoryLong

public void listDirectoryLong()
                       throws IPWorksException
List extended directory information for RemotePath .

This method is used to request a directory (or file mask) listing specified in RemoteFile . RemoteFile is either an absolute path on the server, or a path relative to RemotePath . The file listing is received through the DirList event. Extended file information is returned.

Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

logoff

public void logoff()
            throws IPWorksException
Logoff from the FTP server by posting a QUIT command.

This method is used to logoff from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

Throws:
IPWorksException

logon

public void logon()
           throws IPWorksException
Logon to the FTP RemoteHost using the current User and Password .

This method is used to logon to the FTP server using the current User and Password . If TransferMode is not 0 (Default), then the FTP transfer mode is set to the appropriate value.

Example (Logging On)

 FTPControl.RemoteHost = "ftpserver"
 FTPControl.User = "username"
 FTPControl.Password = "password"
 FTPControl.Logon() 

Throws:
IPWorksException

makeDirectory

public void makeDirectory(java.lang.String newDir)
                   throws IPWorksException
Create a directory on an FTP server.

This method is used to create a directory with path specified by NewDir on the FTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

removeDirectory

public void removeDirectory(java.lang.String dirName)
                     throws IPWorksException
Remove a directory specified by DirName from an FTP server.

This property is used to remove a directory with path specified by DirName from the FTP server. DirName is either an absolute path on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

renameFile

public void renameFile(java.lang.String newName)
                throws IPWorksException
Change the name of RemoteFile to NewName .

This property is used to change the name of a remote file, specified by RemoteFile to NewName . RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

Throws:
IPWorksException

setDownloadStream

public void setDownloadStream(java.io.OutputStream downloadStream)
                       throws IPWorksException
Sets the stream to which the downloaded data from the server will be written.

This method is used to set the stream to which the downloaded data from the server will be written. If a download stream is set before the Download method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The bean will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetDownloadStream again before calling Download again. The downloaded content will be written starting at the current position in the stream. If StartByte is non zero the server will be instructed to skip those bytes before starting to send the content of the file so it is up to you to build the stream appropriately in that case.

Note: SetDownloadStream and LocalFile will reset the other.

Throws:
IPWorksException

setUploadStream

public void setUploadStream(java.io.InputStream uploadStream)
                     throws IPWorksException
Sets the stream from which the bean will read data to upload to the server.

This method is used to set the stream from which the bean will read data to upload to the server. If an upload stream is set before the Upload method is called, the content of the stream will be read by the bean and uploaded to the server. The stream should be open and normally set to position 0. The bean will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetUploadStream again before calling Upload again. The content of the stream will be read from the current position all the way to the end and no bytes will be skipped even if StartByte is set to a non zero value (though the server will be instructed to skip those bytes in its file).

Note: SetUploadStream and LocalFile will reset the other.

Throws:
IPWorksException

storeUnique

public void storeUnique()
                 throws IPWorksException
Upload a file with a Unique Name to an FTP server.

This method is used to upload a file with a Unique Name to an FTP server. Similar to the Upload method but the server determines a unique name for the LocalFile to be saved on the current directory given by RemotePath . The server includes the new name of the file in its response. The user should check the PITrail event, or LastReply property to retrieve this generated filename.

Throws:
IPWorksException

upload

public void upload()
            throws IPWorksException
Upload a file specified by LocalFile to an FTP server.

This method uploads a local file specified by LocalFile to the remote file specified by RemoteFile . RemoteFile is either an absolute path on the server, or a path relative to RemotePath . If there is no FTP session in place, one is automatically created by first calling the Logon method.

If you want to append to a server file, please refer to the Append method.

Example (Upload a File)

 FTPControl.Localfile = "C:\\localfile.txt"
 FTPControl.RemoteFile = "remotefile.txt"
 FTPControl.Upload()
 
 FTPControl.Localfile = "C:\\localfile2.txt"
 FTPControl.RemoteFile = "folder/remotefile2.txt"
 FTPControl.Upload() 

Throws:
IPWorksException

addFtpEventListener

public void addFtpEventListener(FtpEventListener l)
                         throws java.util.TooManyListenersException
Throws:
java.util.TooManyListenersException

removeFtpEventListener

public void removeFtpEventListener(FtpEventListener l)

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.