Eclipse RSE Development Guide (Galileo) - IServerLauncher (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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.