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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*******************************************************************************
* Copyright (c) 2009, 2010 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 org.eclipse.core.runtime.IStatus;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.query.IQueryable;
/**
* 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.
*
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
* @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 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 IProvisioningPlan getInstallerPlan();
/**
* Returns the profile that this plan will operate on.
*
* @return The target profile for this plan
*/
public IProfile getProfile();
/**
* Returns the set of IUs that will constitute the profile if the plan is executed successfully.
*
* @return The set of the IUs that will constitute the profile after the plan is executed successfully, or @null if the
* plan is in error or the value has not been set.
* @since 2.2
*/
public IQueryable<IInstallableUnit> getFutureState();
/**
* Returns the proposed set of installable units to be removed from this profile.
*
* @return The proposed profile removals.
*/
public IQueryable<IInstallableUnit> getRemovals();
/**
* 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 IStatus getStatus();
/**
* Returns <code>true</code> if the plan contains no operations, <code>false</code> otherwise.
*
* @return <code>true</code> if the plan contains no operations, <code>false</code> otherwise.
*/
public boolean isEmpty();
/**
* Adds an installable unit to the plan. This will cause the given installable unit
* to be installed into the profile when this plan is executed by the engine.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param iu the installable unit to add
*/
public void addInstallableUnit(IInstallableUnit iu);
/**
* Removes an installable unit from the plan. This will cause the given installable unit
* to be remove from the profile when this plan is executed by the engine.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param iu the installable unit to add
*/
public void removeInstallableUnit(IInstallableUnit iu);
/**
* Adds a profile property corresponding to the given installable unit to the plan.
* This will cause the given installable unit property to be installed into the profile
* when this plan is executed by the engine.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param iu the installable unit to set a property for
* @param name the property name
* @param value the property value
*/
public void setInstallableUnitProfileProperty(IInstallableUnit iu, String name, String value);
/**
* Sets the installer plan for this plan. The installer plan describes the set of changes
* that must be made to the provisioning agent in order for this plan to execute
* successfully.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param installerPlan the plan describing changes to the provisioning agent
*/
public void setInstallerPlan(IProvisioningPlan installerPlan);
/**
* Sets a profile property in the plan. This will cause the given property
* to be added to the profile when this plan is executed by the engine.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param name the profile property name
* @param value the profile property value
*/
public void setProfileProperty(String name, String value);
/**
* Sets the overall plan status, describing whether the planner constructing
* this plan believes it will install successfully, or whether it contains errors
* or the plan computation has been canceled.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param status the plan status
*/
public void setStatus(IStatus status);
/**
* Adds an instruction to replace one installable unit in the profile with another.
* This will cause the 'from' installable unit property to be uninstalled from the profile
* and the 'to' installable unit to be added to the profile when this plan is executed
* by the engine.
* <p>
* This is an advanced operation that should only be performed by clients crafting
* their own custom plan. Most clients should instead use a planner service
* to construct a valid plan based on a profile change request.
* </p>
* @param from the installable unit to remove
* @param to the installable unit to add
*/
public void updateInstallableUnit(IInstallableUnit from, IInstallableUnit to);
/**
* Sets the value that is returned by the method getFutureState.
* Note that this method is a simple setter and will not cause any update to the other fields of this object.
* This field can be set to @null.
* @param futureState A set of IU representing the future plan if the plan is executed successfully.
* @since 2.2
*/
public void setFuturePlan(IQueryable<IInstallableUnit> futureState);
}
|
