| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Server Types</title> |
| <style type="text/css">@import url("../../book.css");</style> |
| <style type="text/css">@import url("../../schema.css");</style> |
| </HEAD> |
| <BODY> |
| <H1 style="text-align:center">Server Types</H1> |
| <p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.server.core.serverTypes<p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0 |
| <p></p> |
| |
| <h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used to provide support for a new server type.<p></p> |
| <h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6> |
| <p></p> |
| <p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.serverType">serverType</a>+)></p> |
| <p class="code SchemaDtd"><!ATTLIST extension</p> |
| <p class="code SchemaDtdAttlist">point CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>point</b> - a fully qualified identifier of the target extension point</li> |
| <li><b>id</b> - an optional identifier of the extension instance</li> |
| <li><b>name</b> - an optional name of the extension instance</li> |
| </ul> |
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.serverType">serverType</a> EMPTY></p> |
| <p class="code SchemaDtd"><!ATTLIST serverType</p> |
| <p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">description CDATA #REQUIRED<p class="code SchemaDtdAttlist">class CDATA #REQUIRED<p class="code SchemaDtdAttlist">behaviourClass CDATA #IMPLIED<p class="code SchemaDtdAttlist">hasConfiguration (true | false) <p class="code SchemaDtdAttlist">runtimeTypeId CDATA #REQUIRED<p class="code SchemaDtdAttlist">launchConfigId CDATA #IMPLIED<p class="code SchemaDtdAttlist">supportsRemoteHosts (true | false) <p class="code SchemaDtdAttlist">runtime (true | false) <p class="code SchemaDtdAttlist">launchModes CDATA #IMPLIED<p class="code SchemaDtdAttlist">initialState CDATA #IMPLIED<p class="code SchemaDtdAttlist">startTimeout CDATA #IMPLIED<p class="code SchemaDtdAttlist">stopTimeout CDATA #IMPLIED<p class="code SchemaDtdAttlist">startBeforePublish (true | false) ></p> |
| <p></p> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li><b>id</b> - unique identifier for the server type</li> |
| <li><b>name</b> - a translatable name used to identify this server type</li> |
| <li><b>description</b> - a translatable description of this server type</li> |
| <li><b>class</b> - specifies the fully qualified name of the Java class that extends <samp>org.eclipse.wst.server.core.model.ServerDelegate</samp>. |
| Server instances of this type will delegate to instances of this class. Delegates must also have a public 0-arg constructor</li> |
| <li><b>behaviourClass</b> - specifies the fully qualified name of the Java class that implements <samp>org.eclipse.wst.server.core.model.ServerBehaviourDelegate</samp>. |
| Server instances of this type will delegate to instances of this class. Delegates must also have a public 0-arg constructor</li> |
| <li><b>hasConfiguration</b> - true if this server has server configuration files</li> |
| <li><b>runtimeTypeId</b> - the runtime type id that this server type corresponds to</li> |
| <li><b>launchConfigId</b> - the launch configuration id for the launch configuration that is able to start this server</li> |
| <li><b>supportsRemoteHosts</b> - true if this server type can work with remote host names, false if this server type can only work on localhost. if unspecified, false is assumed</li> |
| <li><b>runtime</b> - true if this server requires a runtime, and false otherwise</li> |
| <li><b>launchModes</b> - a comma separated list of the launch modes that this server supports</li> |
| <li><b>initialState</b> - the intial state of the server, either "started", or "stopped". if this attribute is not specified, the server state will be "unknown"</li> |
| <li><b>startTimeout</b> - the timeout value (in ms) that the tool will wait for the server to be started. The default is 2 minutes</li> |
| <li><b>stopTimeout</b> - the timeout value (in ms) that the tool will wait for the server to be stopped. The default is 2 minutes</li> |
| <li><b>startBeforePublish</b> - boolean value "true" or "false" to specify whether the server needs to be started for publishing to occur. If "true", the server will be started on every call to publish() before executing the publish code</li> |
| </ul> |
| <br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a server type extension point: |
| |
| <pre class="Example"><span class="code SchemaTag"> |
| <extension |
| point=</span><span class="code SchemaCstring">"org.eclipse.wst.server.core.serverTypes"</span><span class="code SchemaTag">> |
| <serverType |
| id=</span><span class="code SchemaCstring">"com.example.serverType"</span><span class="code SchemaTag"> |
| name=</span><span class="code SchemaCstring">"%serverTypeName"</span><span class="code SchemaTag"> |
| description=</span><span class="code SchemaCstring">"%serverTypeDescription"</span><span class="code SchemaTag"> |
| supportsRemoteHosts=</span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag"> |
| runtime=</span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag"> |
| initialState=</span><span class="code SchemaCstring">"stopped"</span><span class="code SchemaTag"> |
| hasConfiguration=</span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag"> |
| launchConfigId=</span><span class="code SchemaCstring">"com.example.launchConfigurationType"</span><span class="code SchemaTag"> |
| runtimeTypeId=</span><span class="code SchemaCstring">"com.example.runtime"</span><span class="code SchemaTag"> |
| class=</span><span class="code SchemaCstring">"com.example.ExampleServerDelegate"</span><span class="code SchemaTag"> |
| behaviourClass=</span><span class="code SchemaCstring">"com.example.ExampleServerBehaviourDelegate"</span><span class="code SchemaTag">/> |
| </extension> |
| </span></pre> |
| <p></p> |
| |
| <br> |
| <p class="note SchemaCopyright"> |
| Copyright (c) 2000, 2005 IBM Corporation and others.<br> |
| All rights reserved. This program and the accompanying materials are made |
| available under the terms of the Eclipse Public License v1.0 which accompanies |
| this distribution, and is available at |
| <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| |
| </p> |
| </BODY> |
| </HTML> |
