|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
BaseInstallHandler
Field Summary | |
---|---|
static int |
HANDLER_ACTION_CONFIGURE
Indicates the handler is being initialized for feature configure. |
static int |
HANDLER_ACTION_INSTALL
Indicates the handler is being initialized for feature install. |
static int |
HANDLER_ACTION_UNCONFIGURE
Indicates the handler is being initialized for feature unconfigure. |
static int |
HANDLER_ACTION_UNINSTALL
Indicates the handler is being initialized for feature uninstall. |
Method Summary | |
---|---|
void |
completeConfigure()
Called after the feature has been configured. |
void |
completeInstall(IFeatureContentConsumer consumer)
Called after the feature files and any downloaded plug-ins have been installed. |
void |
completeUnconfigure()
Called after the feature has been unconfigured. |
void |
completeUninstall()
Called after the feature has been uninstalled. |
void |
configureCompleted(boolean success)
Called at the end of the configure action. |
void |
configureInitiated()
Called at the start of the configure action |
void |
initialize(int type,
IFeature feature,
IInstallHandlerEntry entry,
InstallMonitor monitor)
Initialize the install handler. |
void |
installCompleted(boolean success)
Called at the end of the install action. |
void |
installInitiated()
Called at the start of the install action. |
void |
nonPluginDataDownloaded(INonPluginEntry[] nonPluginData,
IVerificationListener listener)
Called after files corresponding to non-plug-in entries have been downloaded. |
void |
pluginsDownloaded(IPluginEntry[] plugins)
Called after files corresponding to plug-in entries have been downloaded, but before they are actully unpacked and installed. |
void |
unconfigureCompleted(boolean success)
Called at the end of the unconfigure action. |
void |
unconfigureInitiated()
Called at the start of the unconfigure action |
void |
uninstallCompleted(boolean success)
Called at the end of the uninstall action. |
void |
uninstallInitiated()
Called at the start of the uninstall action |
Field Detail |
---|
static final int HANDLER_ACTION_INSTALL
static final int HANDLER_ACTION_CONFIGURE
static final int HANDLER_ACTION_UNCONFIGURE
static final int HANDLER_ACTION_UNINSTALL
Method Detail |
---|
void initialize(int type, IFeature feature, IInstallHandlerEntry entry, InstallMonitor monitor) throws CoreException
type
- update action typefeature
- the target of the actionentry
- model entry that defines this handlermonitor
- optional progress monitor, can be null
CoreException
void installInitiated() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_INSTALL
void pluginsDownloaded(IPluginEntry[] plugins) throws CoreException
plugins
- downloaded plug-in entries. Note this may be a subset
of the plug-ins actually references by the feature.
CoreException
- terminates the actionHANDLER_ACTION_INSTALL
void nonPluginDataDownloaded(INonPluginEntry[] nonPluginData, IVerificationListener listener) throws CoreException
nonPluginData
- downloaded non-plug-in entries.listener
- verification listener, may be null
.
CoreException
- terminates the actionHANDLER_ACTION_INSTALL
void completeInstall(IFeatureContentConsumer consumer) throws CoreException
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
CoreException
- terminates the actionHANDLER_ACTION_INSTALL
,
and @see IFeatureContentConsumer#open(INonPluginEntry)
methods of the consumer.
void installCompleted(boolean success) throws CoreException
success
- indicates action success.
CoreException
- terminates the actionHANDLER_ACTION_INSTALL
void configureInitiated() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_CONFIGURE
void completeConfigure() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_CONFIGURE
void configureCompleted(boolean success) throws CoreException
success
- indicates action success.
CoreException
- terminates the actionHANDLER_ACTION_CONFIGURE
void unconfigureInitiated() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_UNCONFIGURE
void completeUnconfigure() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_UNCONFIGURE
void unconfigureCompleted(boolean success) throws CoreException
success
- indicates action success.
CoreException
- terminates the actionHANDLER_ACTION_UNCONFIGURE
void uninstallInitiated() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_UNINSTALL
void completeUninstall() throws CoreException
CoreException
- terminates the actionHANDLER_ACTION_UNINSTALL
void uninstallCompleted(boolean success) throws CoreException
success
- indicates action success.
CoreException
- terminates the actionHANDLER_ACTION_UNINSTALL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |