|
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.ProvisioningContext
public class ProvisioningContext
A provisioning context defines the scope in which a provisioning operation occurs. A context can be used to specify the set of repositories available to the planner and engine as they perform provisioning work.
Field Summary | |
---|---|
static String |
FOLLOW_REPOSITORY_REFERENCES
Instructs the provisioning context to follow metadata repository references when providing queryables for obtaining metadata and artifacts. |
Constructor Summary | |
---|---|
ProvisioningContext(IProvisioningAgent agent)
Creates a new provisioning context that includes all available metadata and artifact repositories available to the specified provisioning agent. |
Method Summary | |
---|---|
IQueryable<IArtifactDescriptor> |
getArtifactDescriptors(IProgressMonitor monitor)
Returns a queryable that can be used to obtain any artifact descriptors that are needed for the provisioning operation. |
IQueryable<IArtifactKey> |
getArtifactKeys(IProgressMonitor monitor)
Returns a queryable that can be used to obtain any artifact keys that are needed for the provisioning operation. |
URI[] |
getArtifactRepositories()
Deprecated. This method will be removed in the next release. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=305086 |
IQueryable<IArtifactRepository> |
getArtifactRepositories(IProgressMonitor monitor)
Returns a queryable that can be used to obtain any artifact repositories that are needed for the provisioning operation. |
List<IInstallableUnit> |
getExtraInstallableUnits()
Returns the list of additional installable units that should be considered as available for installation by the planner. |
IQueryable<IInstallableUnit> |
getMetadata(IProgressMonitor monitor)
Returns a queryable that can be used to obtain any metadata (installable units) that are needed for the provisioning operation. |
Map<String,String> |
getProperties()
Returns the properties that are defined in this context. |
String |
getProperty(String key)
Returns the value of the property with the given key, or null
if no such property is defined |
void |
setArtifactRepositories(URI[] artifactRepositories)
Sets the artifact repositories to consult when performing an operation. |
void |
setExtraInstallableUnits(List<IInstallableUnit> extraIUs)
Sets the list of additional installable units that should be considered as available for installation by the planner. |
void |
setMetadataRepositories(URI[] metadataRepositories)
Sets the metadata repositories to consult when performing an operation. |
void |
setProperty(String key,
String value)
Sets a property on this provisioning context. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String FOLLOW_REPOSITORY_REFERENCES
getMetadata(IProgressMonitor)
,
setMetadataRepositories(URI[])
,
Constant Field ValuesConstructor Detail |
---|
public ProvisioningContext(IProvisioningAgent agent)
agent
- the provisioning agent from which to obtain any necessary services.Method Detail |
---|
public IQueryable<IArtifactKey> getArtifactKeys(IProgressMonitor monitor)
monitor
- a progress monitor to be used when creating the queryable
setArtifactRepositories(URI[])
public IQueryable<IArtifactDescriptor> getArtifactDescriptors(IProgressMonitor monitor)
monitor
- a progress monitor to be used when creating the queryable
setArtifactRepositories(URI[])
public IQueryable<IArtifactRepository> getArtifactRepositories(IProgressMonitor monitor)
monitor
- a progress monitor to be used when creating the queryable
setArtifactRepositories(URI[])
public IQueryable<IInstallableUnit> getMetadata(IProgressMonitor monitor)
monitor
- a progress monitor to be used when creating the queryable
setMetadataRepositories(URI[])
,
FOLLOW_REPOSITORY_REFERENCES
public List<IInstallableUnit> getExtraInstallableUnits()
public Map<String,String> getProperties()
public String getProperty(String key)
null
if no such property is defined
key
- the property key
null
public void setArtifactRepositories(URI[] artifactRepositories)
The provisioning context has a distinct lifecycle, whereby the metadata and artifact repositories to be used are determined when the client retrieves the metadata queryable. Clients should not reset the list of artifact repository locations once the metadata queryable has been retrieved.
artifactRepositories
- the artifact repository locationspublic void setMetadataRepositories(URI[] metadataRepositories)
The provisioning context has a distinct lifecycle, whereby the metadata and artifact repositories to be used are determined when the client retrieves the metadata queryable. Clients should not reset the list of metadata repository locations once the metadata queryable has been retrieved.
metadataRepositories
- the metadata repository locationspublic void setExtraInstallableUnits(List<IInstallableUnit> extraIUs)
extraIUs
- the extra installable unitspublic void setProperty(String key, String value)
key
- the property keyvalue
- the property valuepublic String toString()
toString
in class Object
public URI[] getArtifactRepositories()
null
.getArtifactRepositories()
,
getArtifactDescriptors(IProgressMonitor)
,
getArtifactKeys(IProgressMonitor)
|
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.