|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.p2.engine.spi.Touchpoint
public abstract class Touchpoint
A touchpoint is responsible for executing the required provisioning steps
for each phase corresponding to a particular targeted system (eclipse, native).
The order of phases is defined in the IPhaseSet
.
Constructor Summary | |
---|---|
Touchpoint()
|
Method Summary | |
---|---|
IStatus |
commit(IProfile profile)
This method is called at the end of an engine operation after all phases have been executed. |
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 beginning of an engine operation before any phases have been executed. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Touchpoint()
Method Detail |
---|
public String qualifyAction(String actionId)
actionId
- the unqualified action id
public 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 touchpoint
public 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 touchpoint
public 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 touchpoint
public 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 touchpoint
public 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 modified
public 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 modified
public 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
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.