org.eclipse.rse.core.subsystems
Interface IServerLauncher

public interface IServerLauncher

This interface captures the abstract lifecyle for launching the remote server, and subsequently connecting to it.

See Also:

IServerLauncherProperties

Method Summary

Object	connect(int connectPort, IProgressMonitor monitor) Connect to the remote server.
void	disconnect() Disconnect from the remote server
SystemMessage	getErrorMessage() Returns the host error message if there was a problem connecting to the host.
IServerLauncherProperties	getServerLauncherProperties() Get the object which contians the user-specified properties that are used by this launcher.
SystemSignonInformation	getSignonInformation() Get the remote system signon information, as set in setSignonInformation(SystemSignonInformation)
boolean	isConnected() Determine if we are connected to the remote server or not.
boolean	isLaunched() Determine if the remote server needs to be launched or not.
Object	launch(IProgressMonitor monitor) Launch the remote server.
void	setServerLauncherProperties(IServerLauncherProperties propertyInfo) Set the object which contains the user-specified properties that are used by this launcher
void	setSignonInformation(SystemSignonInformation info) Set the remote system signon information

Method Detail

setSignonInformation

public void setSignonInformation(SystemSignonInformation info)

Set the remote system signon information

getSignonInformation

public SystemSignonInformation getSignonInformation()

Get the remote system signon information, as set in setSignonInformation(SystemSignonInformation)

setServerLauncherProperties

public void setServerLauncherProperties(IServerLauncherProperties propertyInfo)

Set the object which contains the user-specified properties that are used by this launcher

getServerLauncherProperties

public IServerLauncherProperties getServerLauncherProperties()

Get the object which contians the user-specified properties that are used by this launcher. As set in setServerLauncherProperties(IServerLauncherProperties).

isLaunched

public boolean isLaunched()

Determine if the remote server needs to be launched or not. Generally is always false.

Returns:

true if the remote server is already launched, false if it needs to be.

launch

public Object launch(IProgressMonitor monitor)
              throws Exception

Launch the remote server. Some subclasses may not need this step, if the server is already running.

Parameters:

monitor - - a monitor for showing progress

Returns:

an object. Up to each implementor how to interpret.

Throws:

Exception

See Also:

getErrorMessage()

isConnected

public boolean isConnected()

Determine if we are connected to the remote server or not.

Returns:

true if we are connected, false otherwise.

connect

public Object connect(int connectPort,
                      IProgressMonitor monitor)
               throws Exception

Connect to the remote server.

Parameters:

connectPort - the port to use for launching the server

monitor - a monitor for showing progress

Returns:

Anything you want.

Throws:

Exception

See Also:

getErrorMessage()

disconnect

public void disconnect()
                throws Exception

Disconnect from the remote server

Throws:

Exception

See Also:

getErrorMessage()

getErrorMessage

public SystemMessage getErrorMessage()

Returns the host error message if there was a problem connecting to the host. If there was no problem, this returns null

Returns:

the error message.