|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Tftp
public class Tftp
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()
Creates an instance of Tftp Bean. |
|
Tftp(java.lang.String runtimeLicense)
Creates an instance of Tftp Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addTftpEventListener(TftpEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration 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(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)
Sets the stream to be uploaded to the server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Tftp()
public Tftp(java.lang.String runtimeLicense)
Method Detail |
---|
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public java.lang.String getLocalFile()
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.
public void setLocalFile(java.lang.String localFile) throws IPWorksException
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
public java.lang.String getLocalHost()
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.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
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.
IPWorksException
public int getMaxRetransmits()
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.
public void setMaxRetransmits(int maxRetransmits) throws IPWorksException
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
public java.lang.String getRemoteFile()
When the GetFile
is called, this must be a valid file on
the TFTPServer
.
public void setRemoteFile(java.lang.String remoteFile) throws IPWorksException
When the GetFile
is called, this must be a valid file on
the TFTPServer
.
IPWorksException
public int getRetransmitTimeout()
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.
public void setRetransmitTimeout(int retransmitTimeout) throws IPWorksException
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
public int getTFTPPort()
The TFTPPort
is the UDP port on the TFTPServer
to
send TFTP requests to.
public void setTFTPPort(int TFTPPort) throws IPWorksException
The TFTPPort
is the UDP port on the TFTPServer
to
send TFTP requests to.
IPWorksException
public java.lang.String getTFTPServer()
To be able to transfer file via TFTP, the remote host must be
running TFTP services on port TFTPPort
(default 69).
Example (Get a File)
TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.GetFile()
public void setTFTPServer(java.lang.String TFTPServer) throws IPWorksException
To be able to transfer file via TFTP, the remote host must be
running TFTP services on port TFTPPort
(default 69).
Example (Get a File)
TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.GetFile()
IPWorksException
public int getTimeout()
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).
public void setTimeout(int timeout) throws IPWorksException
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).
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
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.
Note: This setting is only available in Windows.
CaptureIPPacketInfo
is set to true, then this will be populated with the packet's destination address when a packet is received.
This information will be accessible in the DataIn event.Note: This setting is only available in Windows.
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
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.
Active
property or it will have no effect.The default value for this setting is False.
UseConnection
specifies whether the bean
should use a connected socket or not. The connection is
defined as an association in between the local address/port
and the remote address/port. As such, this
is not a connection in the traditional TCP sense. What it
means is only that the bean will send and receive data
only to and from the specified destination.The default value for this setting is False.
UseConnection
must be True to use this setting. This option allows you to specify an arbitrary DSCP value
between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.
UseConnection
must be True to use this setting.
You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting Active
to true.
IPWorksException
public void doEvents() throws IPWorksException
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
public void getFile() throws IPWorksException
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
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void putFile() throws IPWorksException
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
public void setDownloadStream(java.io.OutputStream downloadStream) throws IPWorksException
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 if CloseStreamAfterTransfer
is 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
public void setUploadStream(java.io.InputStream uploadStream) throws IPWorksException
If an upload stream is set before the PutFile
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 set to true (default). If the stream is closed, you will need to call SetUploadStream
again before calling PutFile
again.
The content of the stream will be read from the current position all the way to the end.
Note: SetUploadStream
and LocalFile
will reset the other.
IPWorksException
public void addTftpEventListener(TftpEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeTftpEventListener(TftpEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |