ipworks
Class Tftp

java.lang.Object
  |
  +--ipworks.Tftp

public class Tftp

extends java.lang.Object

The TFTPClient bean is used to exchange files with TFTP servers via the TFTP protocol defined in RFC 783.

To use the bean, first specify the TFTPServer , then a LocalFile and a RemoteFile , and then call GetFile or PutFile . The Transfer event shows the progress of the transfer.

Potential transmission errors and packet loss are managed by the Timeout property which controls the maximum time to wait for a response from the server, and the MaxRetransmits property which specifies how many times to resend a failed packet before giving up.

Constructor Summary

Tftp()

Method Summary

void	addTftpEventListener(ipworks.TftpEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a beanconfiguration setting.
void	doEvents() Processes events from the internal message queue.
void	getFile() Download a RemoteFile from the TFTP server.
java.lang.String	getLocalFile() The file on the local host to transfer the data to/from.
java.lang.String	getLocalHost() The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
int	getMaxRetransmits() The number of times to retry sending a failed packet before disconnecting.
java.lang.String	getRemoteFile() The file on the remote host.
int	getRetransmitTimeout() Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
int	getTFTPPort() The UDP port where the remote TFTP server is listening.
java.lang.String	getTFTPServer() The address of the TFTP server to exchange files with.
int	getTimeout() A timeout for the bean.
void	interrupt() Interrupt the current method.
boolean	isIdle() The current status of the component.
void	putFile() Upload a file specified by LocalFile to the TFTP server.
void	removeTftpEventListener(ipworks.TftpEventListener l)
void	setDownloadStream(java.io.OutputStream downloadStream) Sets the stream to which the downloaded data from the server will be written.
void	setLocalFile(java.lang.String localFile) The file on the local host to transfer the data to/from.
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	setMaxRetransmits(int maxRetransmits) The number of times to retry sending a failed packet before disconnecting.
void	setRemoteFile(java.lang.String remoteFile) The file on the remote host.
void	setRetransmitTimeout(int retransmitTimeout) Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
void	setTFTPPort(int TFTPPort) The UDP port where the remote TFTP server is listening.
void	setTFTPServer(java.lang.String TFTPServer) The address of the TFTP server to exchange files with.
void	setTimeout(int timeout) A timeout for the bean.
void	setUploadStream(java.io.InputStream uploadStream) Upload a file specified by LocalFile to the TFTP server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tftp

public Tftp()

Method Detail

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.

getLocalFile

public java.lang.String getLocalFile()

The file on the local host to transfer the data to/from.

If GetFile is called, and LocalFile already exists, it is overwritten. If PutFile is called, LocalFile must point to a valid file, or an error will be returned.

setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksException

The file on the local host to transfer the data to/from.

If GetFile is called, and LocalFile already exists, it is overwritten. If PutFile is called, LocalFile must point to a valid file, or an error will be returned.

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

IPWorksException

getMaxRetransmits

public int getMaxRetransmits()

The number of times to retry sending a failed packet before disconnecting.

This property allows you to specify the number of times that you would like to try re-sending the last data packet if the original packet fails.

The RetransmitTimeout determines the wait time (in seconds) between successive retransmissions.

The default value for the MaxRetransmits property is 3.

setMaxRetransmits

public void setMaxRetransmits(int maxRetransmits)
                       throws IPWorksException

The number of times to retry sending a failed packet before disconnecting.

This property allows you to specify the number of times that you would like to try re-sending the last data packet if the original packet fails.

The RetransmitTimeout determines the wait time (in seconds) between successive retransmissions.

The default value for the MaxRetransmits property is 3.

IPWorksException

getRemoteFile

public java.lang.String getRemoteFile()

The file on the remote host.

When the GetFile is called, this must be a valid file on the TFTPServer .

setRemoteFile

public void setRemoteFile(java.lang.String remoteFile)
                   throws IPWorksException

The file on the remote host.

When the GetFile is called, this must be a valid file on the TFTPServer .

IPWorksException

getRetransmitTimeout

public int getRetransmitTimeout()

Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.

Please refer to the MaxRetransmits property for the number of retransmit efforts before an error is returned.

The default value for the RetransmitTimeout is 5 seconds.

setRetransmitTimeout

public void setRetransmitTimeout(int retransmitTimeout)
                          throws IPWorksException

Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.

Please refer to the MaxRetransmits property for the number of retransmit efforts before an error is returned.

The default value for the RetransmitTimeout is 5 seconds.

IPWorksException

getTFTPPort

public int getTFTPPort()

The UDP port where the remote TFTP server is listening.

The TFTPPort is the UDP port on the TFTPServer to send TFTP requests to.

setTFTPPort

public void setTFTPPort(int TFTPPort)
                 throws IPWorksException

The UDP port where the remote TFTP server is listening.

The TFTPPort is the UDP port on the TFTPServer to send TFTP requests to.

IPWorksException

getTFTPServer

public java.lang.String getTFTPServer()

The address of the TFTP server to exchange files with.

To be able to transfer file via TFTP, the remote host must be running TFTP services on port TFTPPort (default 69).

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

Example (Get a File)

 TFTPControl.TFTPServer = "MyServer"
 TFTPControl.LocalFile = "C:\\filename.txt"
 TFTPControl.RemoteFile = "/remotefile.txt"
 TFTPControl.GetFile() 

setTFTPServer

public void setTFTPServer(java.lang.String TFTPServer)
                   throws IPWorksException

The address of the TFTP server to exchange files with.

To be able to transfer file via TFTP, the remote host must be running TFTP services on port TFTPPort (default 69).

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

Example (Get a File)

 TFTPControl.TFTPServer = "MyServer"
 TFTPControl.LocalFile = "C:\\filename.txt"
 TFTPControl.RemoteFile = "/remotefile.txt"
 TFTPControl.GetFile() 

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 IPWorksException raises an IPWorksException exception .

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

Optionally, the behaviour 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 theAbsoluteTimeoutconfiguration 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 IPWorksException raises an IPWorksException exception .

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

Optionally, the behaviour 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 theAbsoluteTimeoutconfiguration setting.

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

IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException

Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor 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.

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.

IPWorksException

getFile

public void getFile()
             throws IPWorksException

Download a RemoteFile from the TFTP server.

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile , or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string).

Example (Get a File)

 TFTPControl.TFTPServer = "MyServer"
 TFTPControl.LocalFile = "C:\\filename.txt"
 TFTPControl.RemoteFile = "/remotefile.txt"
 TFTPControl.GetFile() 

IPWorksException

interrupt

public void interrupt()
               throws IPWorksException

Interrupt the current method.

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

IPWorksException

putFile

public void putFile()
             throws IPWorksException

Upload a file specified by LocalFile to the TFTP server.

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile .

Example (Put a File)

 TFTPControl.TFTPServer = "MyServer"
 TFTPControl.LocalFile = "C:\\filename.txt"
 TFTPControl.RemoteFile = "/remotefile.txt"
 TFTPControl.PutFile() 

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.

If a download stream is set before the GetFile 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 ifCloseStreamAfterTransferis set to true (default). If the stream is closed, you will need to call SetDownloadStream again before calling GetFile again. The downloaded content will be written starting at the current position in the stream.

Note: SetDownloadStream and LocalFile will reset the other.

IPWorksException

setUploadStream

public void setUploadStream(java.io.InputStream uploadStream)
                     throws IPWorksException

Upload a file specified by LocalFile to the TFTP server.

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile .

IPWorksException

addTftpEventListener

public void addTftpEventListener(ipworks.TftpEventListener l)
                          throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeTftpEventListener

public void removeTftpEventListener(ipworks.TftpEventListener l)