blob: 4363e697b5b7f46ebb0a821b3a086365e99b39df [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<HTML>
<BODY>
<H1><CENTER>Site Type Factory</CENTER></H1>
<H2>Identifier</H2>
org.eclipse.update.core.siteTypes<H2>Description</H2>
<p>
The platform update mechanism supports pluggable site type
implementations. A new site type can be registered in order
to support
alternate site layout schemes.
</p>
<p>
The <code>siteTypes</code>
extension point allows alternate site implementations to be
registered using a symbolic type identifier. Whenever the
type is referenced using this identifier, the supplied factory
is used to create the correct concrete site implementation.
</p><H2>Markup</H2>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT extension (site-factory+)&gt;</samp>
<br><samp>&nbsp;&nbsp; &lt;!ATTLIST extension</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;point&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name&nbsp;&nbsp;CDATA #IMPLIED</samp>
<br><samp>&nbsp;&nbsp; &gt;</samp>
<ul>
<li><b>point</b> - must be specified as <b>org.eclipse.update.core.siteTypes</b></li><li><b>id</b> - must be specified. Identifies the new site type</li><li><b>name</b> - optional displayable label for the new site type</li></ul>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT site-factory EMPTY&gt;</samp>
<br><samp>&nbsp;&nbsp; &lt;!ATTLIST site-factory</samp>
<br><samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class&nbsp;CDATA #REQUIRED</samp>
<br><samp>&nbsp;&nbsp; &gt;</samp>
<ul>
<li><b>class</b> - fully qualified name of the factory class for the identified
site type</li></ul>
<H2>Example</H2>
The following is an example of new site type registration.
<br><br>
<code>
&lt;extension<br>
&nbsp;&nbsp;&nbsp;id="custom"<br>
&nbsp;&nbsp;&nbsp;point="org.eclipse.update.core.siteTypes"<br>
&nbsp;&nbsp;&nbsp;name="Custom site"&gt;<br>
<br>
&nbsp;&nbsp;&nbsp;&lt;site-factory<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class="com.xyz.update.CustomSiteFactory"&gt;<br>
&nbsp;&nbsp;&nbsp;&lt;/site-factory&gt;<br>
&lt;/extension&gt;<br>
</code><H2>API Information</H2>
Registered factory classes must implement
<code><b>org.eclipse.update.core.ISiteFactory</b></code><H2>Supplied Implementation</H2>
The platform supplies two standard implementations of site
types. One representing the default update server type, and
the other representing the local file system site.<br><br><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright
IBM Corp. and others 2000, 2002. All Rights Reserved." BORDER=0></a></BODY>
</HTML>