blob: 5b0cd88f7c4d15c77ebe169910555f6228cbf259 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*******************************************************************************
* Copyright (c) 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.p2.engine;
import java.util.Map;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.equinox.internal.provisional.p2.metadata.query.IQueryable;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
/**
* A provisioning plan describes a proposed set of changes to a profile. The
* proposed changes may represent a valid and consistent set of changes, or it
* may represent a set of changes that would cause errors if executed. In this
* case the plan contains information about the severity and explanation for the
* problems.
*
* @since 2.0
*/
public interface IProvisioningPlan {
/**
* Returns the proposed set of installable units to be added to the profile.
*
* @return The proposed profile additions
*/
public abstract IQueryable<IInstallableUnit> getAdditions();
/**
* Returns the provisioning context in which this plan was created.
*
* @return The plan's provisioning context
*/
public ProvisioningContext getContext();
/**
* Returns a plan describing the proposed set of changes to the provisioning infrastructure
* required by this plan. The installer changes must be performed before this plan
* can be successfully executed.
*
* @return The installer plan.
*/
public abstract IProvisioningPlan getInstallerPlan();
/**
* The operands to pass to the engine.
* @return the operands to be executed. This may be an empty array if the
* plan has errors or if there is nothing to do.
*/
public abstract Operand[] getOperands();
/**
* Returns the profile that this plan will operate on.
*
* @return The target profile for this plan
*/
public abstract IProfile getProfile();
/**
* Returns the proposed set of installable units to be removed from this profile.
*
* @return The proposed profile removals.
*/
public abstract IQueryable<IInstallableUnit> getRemovals();
/**
* Returns the problems associated with changes to the given installable unit
* in this plan. A status with severity {@link IStatus#OK} is returned if the unit
* can be provisioned successfully, or if this plan does not include changes to the
* given unit.
*
* @param iu The installable unit to return status for
* @return The status for the given unit in this plan
*/
public abstract IStatus getRequestStatus(IInstallableUnit iu);
/**
* Returns a map of side-effects that will occur as a result of the plan being executed.
* Side-effects of an install may include:
* <ul>
* <li>Optional software being installed that will become satisfied once the plan
* is executed.</li>
* <li>Optional software currently in the profile that will be uninstalled as a result
* of the plan being executed. This occurs when the optional software has dependencies
* that are incompatible with the software being installed.
* This includes additional software that will be installed as a result of the change,
* or optional
* @return A map of {@link IInstallableUnit} to {@link IStatus} of the additional
* changes and their corresponding explanation.
*/
public abstract Map<IInstallableUnit, IStatus> getSideEffectChanges();
/**
* Returns the overall plan status. The severity of this status indicates
* whether the plan can be successfully executed or not:
* <ul>
* <li>A status of {@link IStatus#OK} indicates that the plan can be executed successfully.</li>
* <li>A status of {@link IStatus#INFO} or {@link IStatus#WARNING} indicates
* that the plan can be executed but may cause problems.</li>
* <li>A status of {@link IStatus#ERROR} indicates that the plan cannot be executed
* successfully.</li>
* <li>A status of {@link IStatus#CANCEL} indicates that the plan computation was
* canceled and is incomplete. A canceled plan cannot be executed.</li>
* </ul>
*
* @return The overall plan status.
*/
public abstract IStatus getStatus();
}
|
