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
setSignonInformation
void setSignonInformation(
SystemSignonInformation info)
- Set the remote system signon information
-
getSignonInformation
SystemSignonInformation getSignonInformation()
- Get the remote system signon information, as set in
setSignonInformation(SystemSignonInformation)
-
setServerLauncherProperties
void setServerLauncherProperties(
IServerLauncherProperties propertyInfo)
- Set the object which contains the user-specified properties that
are used by this launcher
-
getServerLauncherProperties
IServerLauncherProperties getServerLauncherProperties()
- Get the object which contians the user-specified properties that are
used by this launcher. As set in
setServerLauncherProperties(IServerLauncherProperties)
.
-
isLaunched
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
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
boolean isConnected()
- Determine if we are connected to the remote server or not.
-
-
Returns:
- true if we are connected, false otherwise.
connect
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
void disconnect()
throws
Exception
- Disconnect from the remote server
-
-
Throws:
-
Exception
-
See Also:
-
getErrorMessage()
getErrorMessage
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.
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.