Remote Server
Identifier:
org.eclipse.ptp.remote.core.remoteServer
Since:
[Enter the first release in which this extension point appears.]
Description:
[Enter description of this extension point.]
Configuration Markup:
<!ELEMENT extension (remoteServer)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
<!ELEMENT remoteServer EMPTY>
<!ATTLIST remoteServer
name CDATA #REQUIRED
id CDATA #REQUIRED
continuous (true | false)
class CDATA #REQUIRED
payload CDATA #REQUIRED
launchCommand CDATA #REQUIRED
unpackCommand CDATA #IMPLIED
verifyLaunchCommand CDATA #IMPLIED
verifyLaunchFailMessage CDATA #IMPLIED
verifyLaunchPattern CDATA #IMPLIED
verifyUnpackCommand CDATA #IMPLIED
verifyUnpackFailMessage CDATA #IMPLIED
verifyUnpackPattern CDATA #IMPLIED
>
- name - A human readable name for this remote server.
- id - A unique identifier for this remote server.
- continuous - Flag indicating if the server will be running continously until terminated or runs once to completion. Continuously running servers require a "success string" to indicate that they have successfully started operating.
- class - The fully qualified name of the Java class extending org.eclipse.ptp.remote.launch.core.AbstractRemoteServerRunner.
- payload - Server payload. This will be copied from the plugin to the working directory on the remote machine prior to launch. The payload is cached on the remote machine and only copied if it is necessary.
- launchCommand - The command used to launch the payload on the remote machine. The variable "${payload}" can be used to include the name of the payload (as specified in the "payload" attribute) in the launch command.
- unpackCommand - Optional command to unpack the payload prior to execution. The unpack command is only run when the payload is first copied to the server (and if re-copied subsequently). If the unpack fails, payload launch is aborted.
- verifyLaunchCommand - This will be used to specify a command to check the desired launch command is available on remote server
- verifyLaunchFailMessage - This attribute is used to specify a message which will be shown to the user if the launch command verification fails.
- verifyLaunchPattern - This will be used to specify the search pattern in the form of regular expression which will be used to verify the output of the command specified in the verifyLaunchCommand attribute.
- verifyUnpackCommand - This will be used to specify a command to check the unpack command is available on remote server
- verifyUnpackFailMessage - This attribute is used to specify message which will be shown to the user if the unpack command verification fails.
- verifyUnpackPattern - This will be used to specify the search pattern in the form of regular expression which will be used to verify the output of the command specified in the verifyUnpackCommand attribute.
Examples:
[Enter extension point usage example here.]
API Information:
[Enter API information here.]
Supplied Implementation:
[Enter information about supplied implementation of this extension point.]