blob: bbd2a650cada7ed1d7d0fdd18155dd91ed96e375 [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>Global Install Handlers</CENTER></H1>
<H2>Identifier</H2>
org.eclipse.update.core.installHandlers<H2>Description</H2>
Extension point for registering global install handlers. Global
install handlers can be referenced by features
(using the <code>&lt;feature&gt; &lt;install-handler&gt;</code>
tags) without having to include a copy of the handler code as
part of the downloadable feature.<H2>Markup</H2>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT extension (install-handler+)&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.installHandlers</b></li><li><b>id</b> - must be specified. Identifies the new install handler</li><li><b>name</b> - optional displayable label for the new install handler</li></ul>
<p><samp>&nbsp;&nbsp; &lt;!ELEMENT install-handler EMPTY&gt;</samp>
<br><samp>&nbsp;&nbsp; &lt;!ATTLIST install-handler</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 handler implementation class for the identified
install handler</li></ul>
<H2>Example</H2>
The following is an example of new global install handler registration.
<br><br>
<code>
&lt;extension<br>
&nbsp;&nbsp;&nbsp;id="custom"<br>
&nbsp;&nbsp;&nbsp;point="org.eclipse.update.core.installHandlers"<br>
&nbsp;&nbsp;&nbsp;name="Custom install handler"&gt;<br>
<br>
&nbsp;&nbsp;&nbsp;&lt;install-handler<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class="com.xyz.update.CustomInstallHandler"&gt;<br>
&nbsp;&nbsp;&nbsp;&lt;/install-handler&gt;<br>
&lt;/extension&gt;<br>
</code><H2>API Information</H2>
Registered install handler classes must implement
<code><b>org.eclipse.update.core.IInstallHandler</b></code> interface.
Implementers should extend base class <code><b>org.eclipse.update.core.BaseInstallHandler</b></code>.<H2>Supplied Implementation</H2>
The platform supplies a simple install handler that is registered as <code><b>org.eclipse.update.core.DefaultInstallHandler</b></code>. If used, it will copy any non-plug-in data entries provided with the feature into the feature installation directory.<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>