Package org.eclipse.equinox.p2.engine.spi

Class ProvisioningAction

java.lang.Object

org.eclipse.equinox.p2.engine.spi.ProvisioningAction

public abstract class ProvisioningAction
extends Object

An action that performs one step of a provisioning operation for a particular Touchpoint.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ProvisioningAction()

Method Summary

Modifier and Type	Method	Description
abstract IStatus	execute(Map<String,Object> parameters)	Performs the provisioning action.
protected Memento	getMemento()
Value<?>	getResult()	This method is meant for provisioning actions that need to communicate the result of their execution to subsequent actions.
Touchpoint	getTouchpoint()	Returns the touchpoint that this action is operating under.
void	setTouchpoint(Touchpoint touchpoint)
abstract IStatus	undo(Map<String,Object> parameters)	Performs the inverse of this provisioning action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProvisioningAction

public ProvisioningAction()

Method Details

getMemento

protected Memento getMemento()

execute

public abstract IStatus execute(Map<String,Object> parameters)

Performs the provisioning action.

Parameters:

parameters - The action parameters

Returns:

A status indicating whether the action was successful

undo

public abstract IStatus undo(Map<String,Object> parameters)

Performs the inverse of this provisioning action. This should reverse any effects from a previous invocation of the execute(Map) method.

Parameters:

parameters - The action parameters

Returns:

A status indicating whether the action was successful

getResult

public Value<?> getResult()

This method is meant for provisioning actions that need to communicate the result of their execution to subsequent actions. This method is only invoked by p2 once execute() has been executed.

Returns:

the result of the action execution.

Since:

2.3

setTouchpoint

public void setTouchpoint(Touchpoint touchpoint)

getTouchpoint

public Touchpoint getTouchpoint()

Returns the touchpoint that this action is operating under.

Returns:

the touchpoint