org.eclipse.update.core
Interface IInstallHandler
-
All Known Subinterfaces:
-
IInstallHandlerWithFilter
-
All Known Implementing Classes:
-
BaseInstallHandler
Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This
provisional API was never promoted to stable API, and may be removed from a future release of the platform.
-
public interface IInstallHandler
Custom install handler.
Custom install handlers can optionally be associated with a feature.
The actual install handler implementation can be physically delivered
as part of the feature package, or can already be installed on the client
machine and registered via the org.eclipse.update.core.installHandlers
extension point. The install handler methods are called at predetermined
point during update actions.
Clients may implement this interface. However, in most cases clients should
directly subclass the provided implementation of this interface.
Note: This class/interface is part of an interim API that is still under development and expected to
change significantly before reaching stability. It is being made available at this early stage to solicit feedback
from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
(repeatedly) as the API evolves.
-
Since:
- 2.0
-
See Also:
-
BaseInstallHandler
HANDLER_ACTION_INSTALL
static final int HANDLER_ACTION_INSTALL
-
Deprecated.
- Indicates the handler is being initialized for feature install.
-
Since:
- 2.0
-
See Also:
-
Constant Field Values
HANDLER_ACTION_CONFIGURE
static final int HANDLER_ACTION_CONFIGURE
-
Deprecated.
- Indicates the handler is being initialized for feature configure.
-
Since:
- 2.0
-
See Also:
-
Constant Field Values
HANDLER_ACTION_UNCONFIGURE
static final int HANDLER_ACTION_UNCONFIGURE
-
Deprecated.
- Indicates the handler is being initialized for feature unconfigure.
-
Since:
- 2.0
-
See Also:
-
Constant Field Values
HANDLER_ACTION_UNINSTALL
static final int HANDLER_ACTION_UNINSTALL
-
Deprecated.
- Indicates the handler is being initialized for feature uninstall.
-
Since:
- 2.0
-
See Also:
-
Constant Field Values
initialize
void initialize(int type,
IFeature feature,
IInstallHandlerEntry entry,
InstallMonitor monitor)
throws
CoreException
-
Deprecated.
- Initialize the install handler.
Install handlers are always constructed using the default constructor.
The are initialized immediately following construction.
-
-
Parameters:
-
type
- update action type -
feature
- the target of the action -
entry
- model entry that defines this handler -
monitor
- optional progress monitor, can be null
-
Throws:
-
CoreException
-
Since:
- 2.0
installInitiated
void installInitiated()
throws
CoreException
-
Deprecated.
- Called at the start of the install action. At this point, no install
processing has taken place.
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_INSTALL
pluginsDownloaded
void pluginsDownloaded(
IPluginEntry[] plugins)
throws
CoreException
-
Deprecated.
- Called after files corresponding to plug-in entries have been downloaded,
but before they are actully unpacked and installed.
-
-
Parameters:
-
plugins
- downloaded plug-in entries. Note this may be a subset
of the plug-ins actually references by the feature.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_INSTALL
nonPluginDataDownloaded
void nonPluginDataDownloaded(
INonPluginEntry[] nonPluginData,
IVerificationListener listener)
throws
CoreException
-
Deprecated.
- Called after files corresponding to non-plug-in entries have been
downloaded. The custom install handler can perform any custom
verification of the non-plug-in entries (these are not interpreted
in any way by the platform (beyond downloading)).
-
-
Parameters:
-
nonPluginData
- downloaded non-plug-in entries. -
listener
- verification listener, may be null
.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_INSTALL
completeInstall
void completeInstall(
IFeatureContentConsumer consumer)
throws
CoreException
-
Deprecated.
- Called after the feature files and any downloaded plug-ins have
been installed. Typically this is the point where the custom
install handler can install any non-plug-in entries (these are not
interpreted in any way by the platform (beyond downloading)).
-
-
Parameters:
-
consumer
- content consumer for the feature. The install handler
can choose to use this consumer to install the non-plug-in data,
or can handle the data in any other way. If using the consumer,
the install handler should only call
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_INSTALL
,
and @see IFeatureContentConsumer#open(INonPluginEntry) methods of the consumer.
installCompleted
void installCompleted(boolean success)
throws
CoreException
-
Deprecated.
- Called at the end of the install action.
-
-
Parameters:
-
success
- indicates action success.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_INSTALL
configureInitiated
void configureInitiated()
throws
CoreException
-
Deprecated.
- Called at the start of the configure action
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_CONFIGURE
completeConfigure
void completeConfigure()
throws
CoreException
-
Deprecated.
- Called after the feature has been configured. The install handler
should perform any completion tasks. No arguments are passed
to the method. If needed, the install handler can use arguments
passed on the initialization call.
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_CONFIGURE
configureCompleted
void configureCompleted(boolean success)
throws
CoreException
-
Deprecated.
- Called at the end of the configure action.
-
-
Parameters:
-
success
- indicates action success.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_CONFIGURE
unconfigureInitiated
void unconfigureInitiated()
throws
CoreException
-
Deprecated.
- Called at the start of the unconfigure action
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNCONFIGURE
completeUnconfigure
void completeUnconfigure()
throws
CoreException
-
Deprecated.
- Called after the feature has been unconfigured. The install handler
should perform any completion tasks. No arguments are passed
to the method. If needed, the install handler can use arguments
passed on the initialization call.
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNCONFIGURE
unconfigureCompleted
void unconfigureCompleted(boolean success)
throws
CoreException
-
Deprecated.
- Called at the end of the unconfigure action.
-
-
Parameters:
-
success
- indicates action success.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNCONFIGURE
uninstallInitiated
void uninstallInitiated()
throws
CoreException
-
Deprecated.
- Called at the start of the uninstall action
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNINSTALL
completeUninstall
void completeUninstall()
throws
CoreException
-
Deprecated.
- Called after the feature has been uninstalled. The install handler
should perform any completion tasks. No arguments are passed
to the method. If needed, the install handler can use arguments
passed on the initialization call. Note, that at this point
the feature files and any unreferenced plug-ins have been
removed.
-
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNINSTALL
uninstallCompleted
void uninstallCompleted(boolean success)
throws
CoreException
-
Deprecated.
- Called at the end of the uninstall action.
-
-
Parameters:
-
success
- indicates action success.
-
Throws:
-
CoreException
- terminates the action -
Since:
- 2.0
-
See Also:
-
HANDLER_ACTION_UNINSTALL
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.