Constructor and Description |
---|
Touchpoint() |
Modifier and Type | Method and Description |
---|---|
IStatus |
commit(IProfile profile)
This method is called at the end of an engine operation after all phases have
been executed and after the touchpoint has had prepare called.
|
IStatus |
completeOperand(IProfile profile,
Map<String,Object> parameters)
This method is called at the end of processing of a single engine operand
(for example a given installable unit being installed or uninstalled).
|
IStatus |
completePhase(IProgressMonitor monitor,
IProfile profile,
String phaseId,
Map<String,Object> parameters)
This method is called at the end of execution of an engine phase.
|
IStatus |
initializeOperand(IProfile profile,
Map<String,Object> parameters)
This method is called at the beginning of processing of a single engine operand
(for example a given installable unit being installed or uninstalled).
|
IStatus |
initializePhase(IProgressMonitor monitor,
IProfile profile,
String phaseId,
Map<String,Object> parameters)
This method is called at the beginning of execution of an engine phase.
|
IStatus |
prepare(IProfile profile)
This method is called at the end of an engine operation after all phases have
been executed but prior to the operation being formally committed/persisted.
|
String |
qualifyAction(String actionId)
This method is for backwards compatibility only, to be used by touchpoints
that existed prior to action ids being fully qualified by the engine.
|
IStatus |
rollback(IProfile profile)
This method is called at the end of an engine operation after all phases have
been executed.
|
public String qualifyAction(String actionId)
actionId
- the unqualified action idpublic IStatus initializePhase(IProgressMonitor monitor, IProfile profile, String phaseId, Map<String,Object> parameters)
The result of this method can be used to abort execution of the entire engine
operation, by using a severity of IStatus.ERROR
or IStatus.CANCEL
.
The result can also contain warnings or informational status that will be aggregated
and returned to the caller of IEngine.perform(org.eclipse.equinox.p2.engine.IProvisioningPlan, IProgressMonitor)
.
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desiredprofile
- the profile that is being operated onphaseId
- the id of the phaseparameters
- data provided by the engine to the touchpointpublic IStatus completePhase(IProgressMonitor monitor, IProfile profile, String phaseId, Map<String,Object> parameters)
The result of this method can be used to abort execution of the entire engine
operation, by using a severity of IStatus.ERROR
or IStatus.CANCEL
.
The result can also contain warnings or informational status that will be aggregated
and returned to the caller of IEngine.perform(org.eclipse.equinox.p2.engine.IProvisioningPlan, IProgressMonitor)
.
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desiredprofile
- the profile that is being operated onphaseId
- the id of the phaseparameters
- data provided by the engine to the touchpointpublic IStatus initializeOperand(IProfile profile, Map<String,Object> parameters)
The result of this method can be used to abort execution of the entire engine
operation, by using a severity of IStatus.ERROR
or IStatus.CANCEL
.
The result can also contain warnings or informational status that will be aggregated
and returned to the caller of IEngine.perform(org.eclipse.equinox.p2.engine.IProvisioningPlan, IProgressMonitor)
.
profile
- the profile that is being operated onparameters
- data provided by the engine to the touchpointpublic IStatus completeOperand(IProfile profile, Map<String,Object> parameters)
The result of this method can be used to abort execution of the entire engine
operation, by using a severity of IStatus.ERROR
or IStatus.CANCEL
.
The result can also contain warnings or informational status that will be aggregated
and returned to the caller of IEngine.perform(org.eclipse.equinox.p2.engine.IProvisioningPlan, IProgressMonitor)
.
profile
- the profile that is being operated onparameters
- data provided by the engine to the touchpointpublic IStatus prepare(IProfile profile)
The result of this method can be used to abort execution of the entire engine
operation, by using a severity of IStatus.ERROR
or IStatus.CANCEL
.
The result can also contain warnings or informational status that will be aggregated
and returned to the caller of IEngine.perform(org.eclipse.equinox.p2.engine.IProvisioningPlan, IProgressMonitor)
.
profile
- the profile about to be modifiedpublic IStatus commit(IProfile profile)
The result of this method can be used to report on the success or failure of the commit. However, at this point it is too late for the engine operation to fail, and the result returned from this method will not prevent the engine from completing its work.
profile
- the profile that was modifiedpublic IStatus rollback(IProfile profile)
The result of this method can be used to report on the success or failure of the rollback. However, at this point it is too late for the engine operation to be stopped, and the result returned from this method will not prevent the engine from completing its rollback work.
profile
- the profile that was modified
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.