blob: ad57210097e7d66907c0548020743dc2a5165a84 [file] [log] [blame]
<!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>Runtime 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">Runtime Types</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.server.core.runtimeTypes<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 a new runtime type.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.runtimeType">runtimeType</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</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">&lt;!ELEMENT <a name="e.runtimeType">runtimeType</a> (<a href="#e.moduleType">moduleType</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST runtimeType</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">vendor&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">version&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">vendorId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">facetRuntimeComponent&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">facetRuntimeVersion&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - specifies a unique identifier for this extension point</li>
<li><b>name</b> - a translatable name used to identify the runtime type</li>
<li><b>description</b> - a translatable description of the runtime type</li>
<li><b>vendor</b> - a translatable vendor name</li>
<li><b>version</b> - a translatable version number</li>
<li><b>vendorId</b> - an id used to identify the vendor</li>
<li><b>class</b> - specifies the fully qualified name of the Java class that extends <samp>RuntimeDelegate</samp>.
Runtime instances of this type will delegate to instances of this class. Delegates must also have a public 0-arg constructor.</li>
<li><b>facetRuntimeComponent</b> - </li>
<li><b>facetRuntimeVersion</b> - </li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.moduleType">moduleType</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST moduleType</p>
<p class="code SchemaDtdAttlist">types&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">versions&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>types</b> - a comma separated list of the module types that this runtime supports</li>
<li><b>versions</b> - a comma separated list of the module versions that this runtime supports</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a runtime type extension point:
<pre class="Example"><span class="code SchemaTag">
&lt;extension
point=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.server.core.runtimeTypes&quot;</span><span class="code SchemaTag">&gt;
&lt;runtimeType
id=</span><span class="code SchemaCstring">&quot;com.example.runtime&quot;</span><span class="code SchemaTag">
name=</span><span class="code SchemaCstring">&quot;%runtimeTypeName&quot;</span><span class="code SchemaTag">
description=</span><span class="code SchemaCstring">&quot;%runtimeTypeDescription&quot;</span><span class="code SchemaTag">
vendor=</span><span class="code SchemaCstring">&quot;%runtimeTypeVendor&quot;</span><span class="code SchemaTag">
version=</span><span class="code SchemaCstring">&quot;1.0&quot;</span><span class="code SchemaTag">
class=</span><span class="code SchemaCstring">&quot;com.example.ExampleRuntimeDelegate&quot;</span><span class="code SchemaTag">&gt;
&lt;moduleType
types=</span><span class="code SchemaCstring">&quot;j2ee.web&quot;</span><span class="code SchemaTag">
versions=</span><span class="code SchemaCstring">&quot;1.2, 1.3, 1.4&quot;</span><span class="code SchemaTag">/&gt;
&lt;/runtimeType&gt;
&lt;/extension&gt;
</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>