|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
Server Launch Type
Port
Rexec Port
Daemon Port
Server Path
Server Script
Ibm Attributes
Restricted Types
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 |
public static final String copyright
Method Detail |
public ServerLaunchType getServerLaunchType()
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
ServerLaunchType
,
isSetServerLaunchType()
,
unsetServerLaunchType()
,
setServerLaunchType(ServerLaunchType)
,
SubsystemsPackage.getIBMServerLauncher_ServerLaunchType()
public void setServerLaunchType(ServerLaunchType value)
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
value
- the new value of the 'Server Launch Type' attribute.ServerLaunchType
,
isSetServerLaunchType()
,
unsetServerLaunchType()
,
getServerLaunchType()
public void unsetServerLaunchType()
Server Launch Type
' attribute.
isSetServerLaunchType()
,
getServerLaunchType()
,
setServerLaunchType(ServerLaunchType)
public boolean isSetServerLaunchType()
Server Launch Type
' attribute is set.
unsetServerLaunchType()
,
getServerLaunchType()
,
setServerLaunchType(ServerLaunchType)
public Integer getRexecPort()
If the meaning of the 'Rexec Port' attribute isn't clear, there really should be more of a description here...
setRexecPort(Integer)
,
SubsystemsPackage.getIBMServerLauncher_RexecPort()
public int getRexecPortAsInt()
public void setRexecPort(Integer value)
Rexec Port
' attribute.
value
- the new value of the 'Rexec Port' attribute.getRexecPort()
public void setRexecPort(int newRexecPort)
public Integer getDaemonPort()
If the meaning of the 'Daemon Port' attribute isn't clear, there really should be more of a description here...
setDaemonPort(Integer)
,
SubsystemsPackage.getIBMServerLauncher_DaemonPort()
public int getDaemonPortAsInt()
public void setDaemonPort(Integer value)
Daemon Port
' attribute.
value
- the new value of the 'Daemon Port' attribute.getDaemonPort()
public void setDaemonPort(int newDaemonPort)
public int getPortAsInt()
public Integer getPort()
public void setPort(Integer value)
setRexecPort(Integer)
or setDaemonPort(Integer)
instead.
Port
' attribute.
value
- the new value of the 'Port' attribute.getPort()
public String getServerPath()
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.
setServerPath(String)
,
SubsystemsPackage.getIBMServerLauncher_ServerPath()
public void setServerPath(String value)
Server Path
' attribute.
Set the path where the server lives on the remote system. Used by at least the REXEC server launch type.
value
- the new value of the 'Server Path' attribute.getServerPath()
public String getServerScript()
The script to run on the remote system, to start the server code.
setServerScript(String)
,
SubsystemsPackage.getIBMServerLauncher_ServerScript()
public void setServerScript(String value)
Server Script
' attribute.
The script to run on the remote system, to start the server code.
value
- the new value of the 'Server Script' attribute.getServerScript()
public String getIbmAttributes()
Private. Do not call or use.
See instead com.ibm.etools.systems.subsystems.impl.IBMServerLauncherImpl.#getIBMAttribute(String)
isSetIbmAttributes()
,
unsetIbmAttributes()
,
setIbmAttributes(String)
,
SubsystemsPackage.getIBMServerLauncher_IbmAttributes()
public void setIbmAttributes(String value)
Ibm Attributes
' attribute.
Private. Do not call or use.com.ibm.etools.systems.subsystems.impl.IBMServerLauncherImpl.#setIBMAttribute(String,String)
value
- the new value of the 'Ibm Attributes' attribute.isSetIbmAttributes()
,
unsetIbmAttributes()
,
getIbmAttributes()
public void unsetIbmAttributes()
Ibm Attributes
' attribute.
Private. Do not call or use.
isSetIbmAttributes()
,
getIbmAttributes()
,
setIbmAttributes(String)
public boolean isSetIbmAttributes()
Ibm Attributes
' attribute is set.
Private. Do not call or use.
unsetIbmAttributes()
,
getIbmAttributes()
,
setIbmAttributes(String)
public String getRestrictedTypes()
If the meaning of the 'Restricted Types' attribute isn't clear, there really should be more of a description here...
isSetRestrictedTypes()
,
unsetRestrictedTypes()
,
setRestrictedTypes(String)
,
SubsystemsPackage.getIBMServerLauncher_RestrictedTypes()
public void setRestrictedTypes(String value)
Restricted Types
' attribute.
value
- the new value of the 'Restricted Types' attribute.isSetRestrictedTypes()
,
unsetRestrictedTypes()
,
getRestrictedTypes()
public void unsetRestrictedTypes()
Restricted Types
' attribute.
isSetRestrictedTypes()
,
getRestrictedTypes()
,
setRestrictedTypes(String)
public boolean isSetRestrictedTypes()
Restricted Types
' attribute is set.
unsetRestrictedTypes()
,
getRestrictedTypes()
,
setRestrictedTypes(String)
public void enableServerLaunchType(ServerLaunchType serverLaunchType, boolean enable)
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.
ServerLaunchType
public boolean isEnabledServerLaunchType(ServerLaunchType serverLaunchType)
enableServerLaunchType(ServerLaunchType,boolean)
has not been
called for this server launch type, then we defer to the subsystem factory's
method:
SubSystemFactoryImpl.supportsServerLaunchType(ServerLaunchType)
.
ServerLaunchType
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |