Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems
Interface IBMServerLauncher

All Superinterfaces:
ServerLauncher
All Known Implementing Classes:
IBMServerLauncherImpl

public interface IBMServerLauncher
extends ServerLauncher

This is the IBM default implementation of ServerLauncher. It basically allows for numerous types of server connecting, as identified in ServerLaunchType. It also captures the attributes needed to support these.

A server launcher is responsible for starting the server-side code needed for this client subsystem to access remote resources on the remote system. It starts the server half of the client/server code needed for this subsystem. It is consulted in the default implementation of connect() in ISystem, and the manages the properties in the Remote Server Launcher property page.

The following features are supported:

See Also:
SubsystemsPackage.getIBMServerLauncher()

Field Summary
static String copyright
           
 
Method Summary
 void enableServerLaunchType(ServerLaunchType serverLaunchType, boolean enable)
          Call this method to identify specific server launch types that are not to be permitted.
 Integer getDaemonPort()
          Returns the value of the 'Daemon Port' attribute
 int getDaemonPortAsInt()
          Return the port used for the DAEMON option, as an int
 String getIbmAttributes()
          Returns the value of the 'Ibm Attributes' attribute
 Integer getPort()
          Return the port as an Integer.
 int getPortAsInt()
          Return the port as an int.
 String getRestrictedTypes()
          Returns the value of the 'Restricted Types' attribute
 Integer getRexecPort()
          Returns the value of the 'Rexec Port' attribute
 int getRexecPortAsInt()
          Return the port used for the REXEC option, as an int
 ServerLaunchType getServerLaunchType()
          Returns the value of the 'Server Launch Type' attribute.
 String getServerPath()
          Returns the value of the 'Server Path' attribute
 String getServerScript()
          Returns the value of the 'Server Script' attribute
 boolean isEnabledServerLaunchType(ServerLaunchType serverLaunchType)
          This methods returns the enablement state per server launch type.
 boolean isSetIbmAttributes()
          Returns whether the value of the 'Ibm Attributes' attribute is set
 boolean isSetRestrictedTypes()
          Returns whether the value of the 'Restricted Types' attribute is set
 boolean isSetServerLaunchType()
          Returns whether the value of the 'Server Launch Type' attribute is set
 void setDaemonPort(int newDaemonPort)
          Set the DAEMON port value, as an int
 void setDaemonPort(Integer value)
          Sets the value of the 'Daemon Port' attribute
 void setIbmAttributes(String value)
          Sets the value of the 'Ibm Attributes' attribute
 void setPort(Integer value)
          Deprecated. call setRexecPort(Integer) or setDaemonPort(Integer) instead.
 void setRestrictedTypes(String value)
          Sets the value of the 'Restricted Types' attribute
 void setRexecPort(int newRexecPort)
          Set the REXEC port value, as an int
 void setRexecPort(Integer value)
          Sets the value of the 'Rexec Port' attribute
 void setServerLaunchType(ServerLaunchType value)
          Sets the value of the 'Server Launch Type' attribute
 void setServerPath(String value)
          Sets the value of the 'Server Path' attribute
 void setServerScript(String value)
          Sets the value of the 'Server Script' attribute
 void unsetIbmAttributes()
          Unsets the value of the 'Ibm Attributes' attribute
 void unsetRestrictedTypes()
          Unsets the value of the 'Restricted Types' attribute
 void unsetServerLaunchType()
          Unsets the value of the 'Server Launch Type' attribute
 
Methods inherited from interface com.ibm.etools.systems.subsystems.ServerLauncher
cloneServerLauncher, getParentSubSystem, getVendorAttributes, isSetVendorAttributes, setParentSubSystem, setVendorAttributes, unsetVendorAttributes
 

Field Detail

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getServerLaunchType

public ServerLaunchType getServerLaunchType()
Returns the value of the 'Server Launch Type' attribute. The literals are from the enumeration ServerLaunchType.

This is the means by which to start the server-side code, as specified by the user, typically. It is one of the constants in the enumeration class ServerLaunchType

Returns:
the value of the 'Server Launch Type' attribute.
See Also:
ServerLaunchType, isSetServerLaunchType(), unsetServerLaunchType(), setServerLaunchType(ServerLaunchType), SubsystemsPackage.getIBMServerLauncher_ServerLaunchType()

setServerLaunchType

public void setServerLaunchType(ServerLaunchType value)
Sets the value of the 'Server Launch Type' attribute. This is the means by which to start the server-side code, as specified by the user, typically. It is one of the constants in the enumeration class ServerLaunchType

Parameters:
value - the new value of the 'Server Launch Type' attribute.
See Also:
ServerLaunchType, isSetServerLaunchType(), unsetServerLaunchType(), getServerLaunchType()

unsetServerLaunchType

public void unsetServerLaunchType()
Unsets the value of the 'Server Launch Type' attribute.

See Also:
isSetServerLaunchType(), getServerLaunchType(), setServerLaunchType(ServerLaunchType)

isSetServerLaunchType

public boolean isSetServerLaunchType()
Returns whether the value of the 'Server Launch Type' attribute is set.

Returns:
whether the value of the 'Server Launch Type' attribute is set.
See Also:
unsetServerLaunchType(), getServerLaunchType(), setServerLaunchType(ServerLaunchType)

getRexecPort

public Integer getRexecPort()
Returns the value of the 'Rexec Port' attribute.

If the meaning of the 'Rexec Port' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Rexec Port' attribute.
See Also:
setRexecPort(Integer), SubsystemsPackage.getIBMServerLauncher_RexecPort()

getRexecPortAsInt

public int getRexecPortAsInt()
Return the port used for the REXEC option, as an int


setRexecPort

public void setRexecPort(Integer value)
Sets the value of the 'Rexec Port' attribute.

Parameters:
value - the new value of the 'Rexec Port' attribute.
See Also:
getRexecPort()

setRexecPort

public void setRexecPort(int newRexecPort)
Set the REXEC port value, as an int


getDaemonPort

public Integer getDaemonPort()
Returns the value of the 'Daemon Port' attribute.

If the meaning of the 'Daemon Port' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Daemon Port' attribute.
See Also:
setDaemonPort(Integer), SubsystemsPackage.getIBMServerLauncher_DaemonPort()

getDaemonPortAsInt

public int getDaemonPortAsInt()
Return the port used for the DAEMON option, as an int


setDaemonPort

public void setDaemonPort(Integer value)
Sets the value of the 'Daemon Port' attribute.

Parameters:
value - the new value of the 'Daemon Port' attribute.
See Also:
getDaemonPort()

setDaemonPort

public void setDaemonPort(int newDaemonPort)
Set the DAEMON port value, as an int


getPortAsInt

public int getPortAsInt()
Return the port as an int. This just looks at the type, and determines based on it whether to call getRexecPortAsInt(), or getDaemonPortAsInt().


getPort

public Integer getPort()
Return the port as an Integer. This just looks at the type, and determines based on it whether to call getRexecPort(), or getDaemonPort().


setPort

public void setPort(Integer value)
Deprecated. call setRexecPort(Integer) or setDaemonPort(Integer) instead.

Sets the value of the 'Port' attribute.

Parameters:
value - the new value of the 'Port' attribute.
See Also:
getPort()

getServerPath

public String getServerPath()
Returns the value of the 'Server Path' attribute.

The path where the server lives on the remote system. Used by at least the REXEC server launch type. Will be null if not set.

Returns:
the value of the 'Server Path' attribute.
See Also:
setServerPath(String), SubsystemsPackage.getIBMServerLauncher_ServerPath()

setServerPath

public void setServerPath(String value)
Sets the value of the 'Server Path' attribute. Set the path where the server lives on the remote system. Used by at least the REXEC server launch type.

Parameters:
value - the new value of the 'Server Path' attribute.
See Also:
getServerPath()

getServerScript

public String getServerScript()
Returns the value of the 'Server Script' attribute.

The script to run on the remote system, to start the server code.

Returns:
the value of the 'Server Script' attribute.
See Also:
setServerScript(String), SubsystemsPackage.getIBMServerLauncher_ServerScript()

setServerScript

public void setServerScript(String value)
Sets the value of the 'Server Script' attribute. The script to run on the remote system, to start the server code.

Parameters:
value - the new value of the 'Server Script' attribute.
See Also:
getServerScript()

getIbmAttributes

public String getIbmAttributes()
Returns the value of the 'Ibm Attributes' attribute.

Private. Do not call or use.
See instead com.ibm.etools.systems.subsystems.impl.IBMServerLauncherImpl.#getIBMAttribute(String)

Returns:
the value of the 'Ibm Attributes' attribute.
See Also:
isSetIbmAttributes(), unsetIbmAttributes(), setIbmAttributes(String), SubsystemsPackage.getIBMServerLauncher_IbmAttributes()

setIbmAttributes

public void setIbmAttributes(String value)
Sets the value of the 'Ibm Attributes' attribute. Private. Do not call or use.
See instead com.ibm.etools.systems.subsystems.impl.IBMServerLauncherImpl.#setIBMAttribute(String,String)

Parameters:
value - the new value of the 'Ibm Attributes' attribute.
See Also:
isSetIbmAttributes(), unsetIbmAttributes(), getIbmAttributes()

unsetIbmAttributes

public void unsetIbmAttributes()
Unsets the value of the 'Ibm Attributes' attribute. Private. Do not call or use.

See Also:
isSetIbmAttributes(), getIbmAttributes(), setIbmAttributes(String)

isSetIbmAttributes

public boolean isSetIbmAttributes()
Returns whether the value of the 'Ibm Attributes' attribute is set. Private. Do not call or use.

Returns:
whether the value of the 'Ibm Attributes' attribute is set.
See Also:
unsetIbmAttributes(), getIbmAttributes(), setIbmAttributes(String)

getRestrictedTypes

public String getRestrictedTypes()
Returns the value of the 'Restricted Types' attribute.

If the meaning of the 'Restricted Types' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Restricted Types' attribute.
See Also:
isSetRestrictedTypes(), unsetRestrictedTypes(), setRestrictedTypes(String), SubsystemsPackage.getIBMServerLauncher_RestrictedTypes()

setRestrictedTypes

public void setRestrictedTypes(String value)
Sets the value of the 'Restricted Types' attribute.

Parameters:
value - the new value of the 'Restricted Types' attribute.
See Also:
isSetRestrictedTypes(), unsetRestrictedTypes(), getRestrictedTypes()

unsetRestrictedTypes

public void unsetRestrictedTypes()
Unsets the value of the 'Restricted Types' attribute.

See Also:
isSetRestrictedTypes(), getRestrictedTypes(), setRestrictedTypes(String)

isSetRestrictedTypes

public boolean isSetRestrictedTypes()
Returns whether the value of the 'Restricted Types' attribute is set.

Returns:
whether the value of the 'Restricted Types' attribute is set.
See Also:
unsetRestrictedTypes(), getRestrictedTypes(), setRestrictedTypes(String)

enableServerLaunchType

public void enableServerLaunchType(ServerLaunchType serverLaunchType,
                                   boolean enable)
Call this method to identify specific server launch types that are not to be permitted. This will disable these types in the property page, effectively preventing the user from specifying it. Note this is a transient property, so you should call it each time as part of restoring your subsystem.

You normally do not call this! Rather, your subsystem factory class will override SubSystemFactoryImpl.supportsServerLaunchType(ServerLaunchType). However, this method is needed by ISVs that re-use IBM-supplied subsystem factories, and merely supply their own ISystem object via the "systemClass" attribute of the subsystemfactory extension point. They don't call this method directly actually, but rather AbstractSystem#enableServerLaunchType(SubSystem, ServerLaunchType, boolean), which in turn calls this.

See Also:
ServerLaunchType

isEnabledServerLaunchType

public boolean isEnabledServerLaunchType(ServerLaunchType serverLaunchType)
This methods returns the enablement state per server launch type. If enableServerLaunchType(ServerLaunchType,boolean) has not been called for this server launch type, then we defer to the subsystem factory's method: SubSystemFactoryImpl.supportsServerLaunchType(ServerLaunchType).

See Also:
ServerLaunchType

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.