IP*Works!

ipworks
Class Rexec

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

public class Rexec
extends java.lang.Object

The Rexec control is used to execute commands on a remote UNIX machine using the rexec mechanism.

The Rexec control allows remote execution of commands on UNIX hosts, or any other system with the rexec interface. Using the control is very simple. The destination is specified by the RemoteHost property, the login information is given by the RemoteUser and RemotePassword properties. Then call the Execute method with the Command to execute as a parameter. You can also set the Command property to the command that you would like to execute for identical results. Further input can be supplied to the command by assigning data to the Text parameter of the Send method, or via the Stdin property.

The output of the command is returned through the Stdout event. If an error happens on the protocol level, the error message can be found in the ErrorMessage property. Errors during command execution (the stderr stream) are given by the Stderr event.

To be able to successfully use the control, the remote host must be set up to allow execution of commands via rexec from the machine the control runs on.


Field Summary
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
 
Constructor Summary
Rexec()
           
 
Method Summary
 void addRexecEventListener(RexecEventListener l)
           
 void disconnect()
          Disconnect from the RemoteHost .
 void execute(java.lang.String command)
          Execute a Command on the remote host.
 void fireConnected(int statusCode, java.lang.String description)
          Fired immediately after a connection completes (or fails).
 void fireDisconnected(int statusCode, java.lang.String description)
          Fired when a connection is closed.
 void fireError(int errorCode, java.lang.String description)
          Information about errors during data delivery.
 void fireStderr(byte[] text, boolean EOL)
          Fired when data (complete lines) come in through stderr.
 void fireStdout(byte[] text, boolean EOL)
          Fired when data (complete lines) come in through stdout.
 int getBytesSent()
          The number of bytes actually sent after an assignment to Stdin.
 java.lang.String getCommand()
          The command to be sent to the remote host.
 byte[] getEOL()
          Used to break the stdout data stream into chunks separated by its value.
 byte[] getErrEOL()
          Used to break the stderr data stream into chunks separated by its value.
 java.lang.String getErrorMessage()
          The error message returned when any of the steps prior to command execution fail.
 byte[] getFirewallData()
          Used to send other data to firewall.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used connecting through the firewall.
 int getFirewallPort()
          Port of the firewall to connect to.
 int getFirewallType()
          Determines the type of firewall to connect through.
 java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 int getLocalPort()
          The TCP port in the local host where the component binds.
 int getMaxLineLength()
          The maximum amount of data to accumulate when no EOL is found.
 java.lang.String getRemoteHost()
          The address of the remote host.
 java.lang.String getRemotePassword()
          The password of the user on the remote host.
 int getRemotePort()
          The remote exec service port (default is 512).
 java.lang.String getRemoteUser()
          The id of the user on the remote host.
 int getStderrPort()
          The local port where the remote systems sends the stderr stream.
 int getTimeout()
          A timeout for the component.
 boolean isConnected()
          Shows whether the component is connected.
 boolean isEnableStderr()
          Enables or disables secondary (stderr) stream.
 void removeRexecEventListener(RexecEventListener l)
           
 void send(byte[] text)
          Send standard input to the program executing on the remote host.
 void setCommand(java.lang.String command)
          The command to be sent to the remote host.
 void setEnableStderr(boolean enableStderr)
          Enables or disables secondary (stderr) stream.
 void setEOL(byte[] EOL)
          Used to break the stdout data stream into chunks separated by its value.
 void setErrEOL(byte[] errEOL)
          Used to break the stderr data stream into chunks separated by its value.
 void setFirewallData(byte[] firewallData)
          Used to send other data to firewall.
 void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).
 void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used connecting through the firewall.
 void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.
 void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.
 void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.
 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 setLocalPort(int localPort)
          The TCP port in the local host where the component binds.
 void setMaxLineLength(int maxLineLength)
          The maximum amount of data to accumulate when no EOL is found.
 void setRemoteHost(java.lang.String remoteHost)
          The address of the remote host.
 void setRemotePassword(java.lang.String remotePassword)
          The password of the user on the remote host.
 void setRemotePort(int remotePort)
          The remote exec service port (default is 512).
 void setRemoteUser(java.lang.String remoteUser)
          The id of the user on the remote host.
 void setStderrPort(int stderrPort)
          The local port where the remote systems sends the stderr stream.
 void setStdin(byte[] stdin)
          A string of data to be sent to the remote host while connected.
 void setTimeout(int timeout)
          A timeout for the component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fwNone

public static final int fwNone

fwTunnel

public static final int fwTunnel

fwSOCKS4

public static final int fwSOCKS4

fwSOCKS5

public static final int fwSOCKS5
Constructor Detail

Rexec

public Rexec()
Method Detail

getBytesSent

public int getBytesSent()
The number of bytes actually sent after an assignment to Stdin. The BytesSent property shows how many bytes were sent after the last assignment to Stdin . Please check the Stdin property for more information.


getCommand

public java.lang.String getCommand()
The command to be sent to the remote host. Assigning a UNIX command to this property makes the control attempt to connect to the RemoteHost and execute the command using the rexec protocol. There is no need to append an end-of-line character to the command.

If "" (empty string) is assigned to the Command property, the current connection is broken.


setCommand

public void setCommand(java.lang.String command)
                throws IPWorksException
The command to be sent to the remote host. Assigning a UNIX command to this property makes the control attempt to connect to the RemoteHost and execute the command using the rexec protocol. There is no need to append an end-of-line character to the command.

If "" (empty string) is assigned to the Command property, the current connection is broken.


isConnected

public boolean isConnected()
Shows whether the component is connected. Use this property to determine whether the control is connected to the remote host or not.


isEnableStderr

public boolean isEnableStderr()
Enables or disables secondary (stderr) stream. Some systems (most notably certain versions of Linux) do not support the secondary stderr stream of rexec/rshell. For these systems, you must turn EnableStderr off. Any stderr output will then be provided through stdout.


setEnableStderr

public void setEnableStderr(boolean enableStderr)
                     throws IPWorksException
Enables or disables secondary (stderr) stream. Some systems (most notably certain versions of Linux) do not support the secondary stderr stream of rexec/rshell. For these systems, you must turn EnableStderr off. Any stderr output will then be provided through stdout.


getEOL

public byte[] getEOL()
Used to break the stdout data stream into chunks separated by its value. The EOL property is used to define boundaries in the Stdout stream using the value of the property.


setEOL

public void setEOL(byte[] EOL)
            throws IPWorksException
Used to break the stdout data stream into chunks separated by its value. The EOL property is used to define boundaries in the Stdout stream using the value of the property.


getErrEOL

public byte[] getErrEOL()
Used to break the stderr data stream into chunks separated by its value. The ErrEOL property is used to define boundaries in the Stderr stream using the value of the property.


setErrEOL

public void setErrEOL(byte[] errEOL)
               throws IPWorksException
Used to break the stderr data stream into chunks separated by its value. The ErrEOL property is used to define boundaries in the Stderr stream using the value of the property.


getErrorMessage

public java.lang.String getErrorMessage()
The error message returned when any of the steps prior to command execution fail. This error message is returned on a separate connection associated with error messages.


getFirewallData

public byte[] getFirewallData()
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


setFirewallData

public void setFirewallData(byte[] firewallData)
                     throws IPWorksException
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


getFirewallHost

public java.lang.String getFirewallHost()
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 property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException
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 property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


getFirewallPassword

public java.lang.String getFirewallPassword()
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getFirewallPort

public int getFirewallPort()
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


getFirewallType

public int getFirewallType()
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


getFirewallUser

public java.lang.String getFirewallUser()
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


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() Winsock 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 control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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() Winsock 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 control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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.


getLocalPort

public int getLocalPort()
The TCP port in the local host where the component binds. The LocalPort property must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the control to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

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

USe this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned. Furthermore, the control always attempts to bind to a secure (sub 1000) port when the value of LocalPort is the default (0). If you supply your own value, make sure the remote system is configured to allow that particular value.


setLocalPort

public void setLocalPort(int localPort)
                  throws IPWorksException
The TCP port in the local host where the component binds. The LocalPort property must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the control to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

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

USe this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned. Furthermore, the control always attempts to bind to a secure (sub 1000) port when the value of LocalPort is the default (0). If you supply your own value, make sure the remote system is configured to allow that particular value.


getMaxLineLength

public int getMaxLineLength()
The maximum amount of data to accumulate when no EOL is found. The 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 characters 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 characters 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.


setMaxLineLength

public void setMaxLineLength(int maxLineLength)
                      throws IPWorksException
The maximum amount of data to accumulate when no EOL is found. The 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 characters 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 characters 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.


getRemoteHost

public java.lang.String getRemoteHost()
The address of the remote host. Domain names are resolved to IP addresses. The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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


setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)
                   throws IPWorksException
The address of the remote host. Domain names are resolved to IP addresses. The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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


getRemotePassword

public java.lang.String getRemotePassword()
The password of the user on the remote host. This must be the password of a user in the remote host for whom remote execution of commands is permitted.


setRemotePassword

public void setRemotePassword(java.lang.String remotePassword)
                       throws IPWorksException
The password of the user on the remote host. This must be the password of a user in the remote host for whom remote execution of commands is permitted.


getRemotePort

public int getRemotePort()
The remote exec service port (default is 512). The RemotePort property specifies the rexec service port on the remote host.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before command execution is attempted.


setRemotePort

public void setRemotePort(int remotePort)
                   throws IPWorksException
The remote exec service port (default is 512). The RemotePort property specifies the rexec service port on the remote host.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before command execution is attempted.


getRemoteUser

public java.lang.String getRemoteUser()
The id of the user on the remote host. This must be the id of a user in the remote host for whom remote execution of commands is permitted.


setRemoteUser

public void setRemoteUser(java.lang.String remoteUser)
                   throws IPWorksException
The id of the user on the remote host. This must be the id of a user in the remote host for whom remote execution of commands is permitted.


getStderrPort

public int getStderrPort()
The local port where the remote systems sends the stderr stream. The default value is 0, which instructs the control to use a random port. Use this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned.

Some systems do not support secondary stderr streams. Please refer to the EnableStderr property for more information.


setStderrPort

public void setStderrPort(int stderrPort)
                   throws IPWorksException
The local port where the remote systems sends the stderr stream. The default value is 0, which instructs the control to use a random port. Use this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned.

Some systems do not support secondary stderr streams. Please refer to the EnableStderr property for more information.


setStdin

public void setStdin(byte[] stdin)
              throws IPWorksException
A string of data to be sent to the remote host while connected. This property is used to provide input for the process in the remote host.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens, Stdin


getTimeout

public int getTimeout()
A timeout for the component. If the Timeout property is set to 0 (default value), all operations return immediately, potentially failing with an 'WOULDBLOCK' error if they can't be completed..

If Timeout is set to a positive value, the control will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The control 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 the Timeout expires, and the operation is not yet complete, a Timeout error is fired.


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the component. If the Timeout property is set to 0 (default value), all operations return immediately, potentially failing with an 'WOULDBLOCK' error if they can't be completed..

If Timeout is set to a positive value, the control will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The control 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 the Timeout expires, and the operation is not yet complete, a Timeout error is fired.


fireConnected

public void fireConnected(int statusCode,
                          java.lang.String description)
Fired immediately after a connection completes (or fails). (Called internally to dispatch the event.)
See Also:
RexecConnectedEvent

fireDisconnected

public void fireDisconnected(int statusCode,
                             java.lang.String description)
Fired when a connection is closed. (Called internally to dispatch the event.)
See Also:
RexecDisconnectedEvent

fireError

public void fireError(int errorCode,
                      java.lang.String description)
Information about errors during data delivery. (Called internally to dispatch the event.)
See Also:
RexecErrorEvent

fireStderr

public void fireStderr(byte[] text,
                       boolean EOL)
Fired when data (complete lines) come in through stderr. (Called internally to dispatch the event.)
See Also:
RexecStderrEvent

fireStdout

public void fireStdout(byte[] text,
                       boolean EOL)
Fired when data (complete lines) come in through stdout. (Called internally to dispatch the event.)
See Also:
RexecStdoutEvent

disconnect

public void disconnect()
                throws IPWorksException
Disconnect from the RemoteHost . Calling this method is normally unneccessary, unless you wish to interrupt the remote program, or the remote program is waiting for standard input to end before terminating.


execute

public void execute(java.lang.String command)
             throws IPWorksException
Execute a Command on the remote host. Calling this method is equivalent to setting the Command property to Command .


send

public void send(byte[] text)
          throws IPWorksException
Send standard input to the program executing on the remote host. Calling this method is equivalent to setting the Stdin property to Text .


addRexecEventListener

public void addRexecEventListener(RexecEventListener l)
                           throws java.util.TooManyListenersException

removeRexecEventListener

public void removeRexecEventListener(RexecEventListener l)

IP*Works!

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