|
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.operations.ProvisioningSession
public class ProvisioningSession
ProvisioningSession provides the context for a provisioning session, including the provisioning services that should be used. It also provides utility methods for commonly performed provisioning tasks.
Field Summary | |
---|---|
static long |
SIZE_NOTAPPLICABLE
A constant indicating that there was nothing to size (there was no valid plan that could be used to compute size). |
static long |
SIZE_UNAVAILABLE
Indicates that the size is unavailable (an attempt was made to compute size but it failed) |
static long |
SIZE_UNKNOWN
Indicates that the size is currently unknown |
static int |
STATUS_INVALID_REPOSITORY_LOCATION
A status code used to indicate that a repository location was not valid. |
static int |
STATUS_NOTHING_TO_UPDATE
A status code used to indicate that there were no updates found when looking for updates. |
Constructor Summary | |
---|---|
ProvisioningSession(IProvisioningAgent agent)
Create a provisioning session using the services of the supplied agent. |
Method Summary | |
---|---|
IAgentLocation |
getAgentLocation()
Return the agent location for this session |
IArtifactRepositoryManager |
getArtifactRepositoryManager()
Return the artifact repository manager for this session |
IEngine |
getEngine()
Return the provisioning engine for this session |
Collection<IInstallableUnit> |
getInstalledIUs(String profileId,
boolean all)
Get the IInstallable units for the specified profile |
IMetadataRepositoryManager |
getMetadataRepositoryManager()
Return the metadata repository manager for this session |
org.eclipse.equinox.p2.planner.IPlanner |
getPlanner()
Return the planner used for this session |
IProfileRegistry |
getProfileRegistry()
Return the profile registry for this session |
IProvisioningAgent |
getProvisioningAgent()
Return the provisioning agent used to retrieve provisioning services. |
org.eclipse.equinox.internal.provisional.p2.core.eventbus.IProvisioningEventBus |
getProvisioningEventBus()
Return the provisioning event bus used for dispatching events. |
long |
getSize(IProvisioningPlan plan,
ProvisioningContext context,
IProgressMonitor monitor)
Get sizing information about the specified plan. |
boolean |
hasScheduledOperationsFor(String profileId)
Return a boolean indicating whether any other provisioning operations are scheduled for the specified profile. |
IStatus |
performProvisioningPlan(IProvisioningPlan plan,
IPhaseSet phaseSet,
ProvisioningContext context,
IProgressMonitor monitor)
Perform the specified provisioning plan. |
void |
rememberJob(Job job)
Remember the specified job. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long SIZE_NOTAPPLICABLE
public static final long SIZE_UNAVAILABLE
public static final long SIZE_UNKNOWN
public static final int STATUS_NOTHING_TO_UPDATE
public static final int STATUS_INVALID_REPOSITORY_LOCATION
Constructor Detail |
---|
public ProvisioningSession(IProvisioningAgent agent)
agent
- the provisioning agent that supplies services. Must not be null
.Method Detail |
---|
public IProvisioningAgent getProvisioningAgent()
public IAgentLocation getAgentLocation()
public IArtifactRepositoryManager getArtifactRepositoryManager()
public IMetadataRepositoryManager getMetadataRepositoryManager()
public IProfileRegistry getProfileRegistry()
public IEngine getEngine()
public org.eclipse.equinox.internal.provisional.p2.core.eventbus.IProvisioningEventBus getProvisioningEventBus()
public org.eclipse.equinox.p2.planner.IPlanner getPlanner()
public long getSize(IProvisioningPlan plan, ProvisioningContext context, IProgressMonitor monitor)
plan
- the provisioning plancontext
- the provisioning context to be used for the sizingmonitor
- the progress monitor
SIZE_UNKNOWN
,
SIZE_UNAVAILABLE
,
SIZE_NOTAPPLICABLE
public IStatus performProvisioningPlan(IProvisioningPlan plan, IPhaseSet phaseSet, ProvisioningContext context, IProgressMonitor monitor)
plan
- the provisioning plan to be performedphaseSet
- the phase set to be used for the plancontext
- the provisioning context to be used during provisioningmonitor
- the progress monitor to use while performing the plan
public boolean hasScheduledOperationsFor(String profileId)
profileId
- the id of the profile in question
true
if there are pending provisioning operations for
this profile, false
if there are not.rememberJob(Job)
public void rememberJob(Job job)
job
- the job to be rememberedhasScheduledOperationsFor(String)
public Collection<IInstallableUnit> getInstalledIUs(String profileId, boolean all)
profileId
- the profile in questionall
- true
if all IInstallableUnits in the profile should
be returned, false
only those IInstallableUnits marked as (user visible) roots
should be returned.
|
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.