blob: 521b3e8920cff3a5f2d7d9072c16ff9b7957a456 [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>Module Factories</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">Module Factories</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.server.core.moduleFactories<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 factory for modules that can be used by servers.<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.moduleFactory">moduleFactory</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.moduleFactory">moduleFactory</a> (<a href="#e.moduleType">moduleType</a>*)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST moduleFactory</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">projects&nbsp;(true | false) <p class="code SchemaDtdAttlist">order&nbsp;&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>class</b> - specifies the fully qualified name of the Java class that extends <samp>ModuleFactoryDelegate</samp>.
Module factory instances of this type will delegate to instances of this class</li>
<li><b>projects</b> - true if this factory may return projects within the workspace, and false otherwise</li>
<li><b>order</b> - an integer that specifies the order that the module factory is processed</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 module type ids</li>
<li><b>versions</b> - a comma separated list of module versions</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a module factory extension point:
<pre class="Example"><span class="code SchemaTag">
&lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.server.core.moduleFactories&quot;</span><span class="code SchemaTag">&gt;
&lt;moduleFactory
projects=</span><span class="code SchemaCstring">&quot;true&quot;</span><span class="code SchemaTag">
class=</span><span class="code SchemaCstring">&quot;org.eclipse.MyWebFactory&quot;</span><span class="code SchemaTag">
id=</span><span class="code SchemaCstring">&quot;org.eclipse.wst.static.web&quot;</span><span class="code SchemaTag">&gt;
&lt;moduleType
versions=</span><span class="code SchemaCstring">&quot;1.0&quot;</span><span class="code SchemaTag">
types=</span><span class="code SchemaCstring">&quot;wst.web&quot;</span><span class="code SchemaTag">&gt;
&lt;/moduleType&gt;
&lt;/moduleFactory&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 2.0 which accompanies
this distribution, and is available at
<a href="https://www.eclipse.org/legal/epl-2.0/">https://www.eclipse.org/legal/epl-2.0/</a>
</p>
</BODY>
</HTML>