|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Platform configuration interface. Represents the runtime configuration used by the Eclipse platform. Any configuration changes do not take effect until next startup of the Eclipse platform.
Do not provide implementations of this interface or its nested interfaces. Use the factory methods on IPlatformConfigurationFactory to create a IPlatformConfiguration, then use the factory methods on the IPlatformConfiguration to create instances of ISiteEntry,IFeatureEntry and ISitePolicy.
Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Nested Class Summary | |
static interface |
IPlatformConfiguration.IFeatureEntry
Feature entry. |
static interface |
IPlatformConfiguration.ISiteEntry
Configuration entry representing an install site. |
static interface |
IPlatformConfiguration.ISitePolicy
Site policy. |
Method Summary | |
void |
configureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
Configures the feature entry. |
void |
configureSite(IPlatformConfiguration.ISiteEntry entry)
Configures the specified site entry. |
void |
configureSite(IPlatformConfiguration.ISiteEntry entry,
boolean replace)
Configures the specified site entry. |
IPlatformConfiguration.IFeatureEntry |
createFeatureEntry(String id,
String version,
String pluginVersion,
boolean primary,
String application,
URL[] root)
Create a feature entry |
IPlatformConfiguration.IFeatureEntry |
createFeatureEntry(String id,
String version,
String pluginIdentifier,
String pluginVersion,
boolean primary,
String application,
URL[] root)
Create a feature entry |
IPlatformConfiguration.ISiteEntry |
createSiteEntry(URL url,
IPlatformConfiguration.ISitePolicy policy)
Create a site entry |
IPlatformConfiguration.ISitePolicy |
createSitePolicy(int type,
String[] list)
Create a site policy. |
IPlatformConfiguration.IFeatureEntry |
findConfiguredFeatureEntry(String id)
Locates the specified feature entry. |
IPlatformConfiguration.ISiteEntry |
findConfiguredSite(URL url)
Returns a site entry matching the specified URL |
String[] |
getBootstrapPluginIdentifiers()
Deprecated. Do not use this method. Check the osgi.bundles system property for the urls of the automatically started bundles |
long |
getChangeStamp()
Returns a stamp reflecting the current state of the configuration. |
URL |
getConfigurationLocation()
Returns the URL location of the configuration information |
IPlatformConfiguration.IFeatureEntry[] |
getConfiguredFeatureEntries()
Returns a list of configured feature entries. |
IPlatformConfiguration.ISiteEntry[] |
getConfiguredSites()
Returns configured site entries |
long |
getFeaturesChangeStamp()
Deprecated. Do not use this method. |
URL[] |
getPluginPath()
Computes the plug-in path for this configuration. |
long |
getPluginsChangeStamp()
Deprecated. Do not use this method |
String |
getPrimaryFeatureIdentifier()
Returns the identifier of the configured primary feature. |
boolean |
isTransient()
Returns an indication whether the configuration is transient. |
void |
isTransient(boolean value)
Indicates whether the configuration is transient or not. |
boolean |
isUpdateable()
Returns an indication whether the configuration can be updated. |
void |
refresh()
Called to refresh the configuration information. |
void |
save()
Called to save the configuration information |
void |
save(URL url)
Called to save the configuration information in the specified location |
void |
setBootstrapPluginLocation(String id,
URL location)
Deprecated. Do not use this method. Use the osig.bundles system property contains the urls of the automatically started bundles. |
void |
unconfigureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
Unconfigures the specified feature entry if it exists. |
void |
unconfigureSite(IPlatformConfiguration.ISiteEntry entry)
Unconfigures the specified entry. |
Method Detail |
public IPlatformConfiguration.ISiteEntry createSiteEntry(URL url, IPlatformConfiguration.ISitePolicy policy)
url
- site URLpolicy
- site policy
public IPlatformConfiguration.ISitePolicy createSitePolicy(int type, String[] list)
type
- policy typelist
- an array of site-relative paths representing the
inclusion/ exclusion list
public IPlatformConfiguration.IFeatureEntry createFeatureEntry(String id, String version, String pluginVersion, boolean primary, String application, URL[] root)
id
- feature identifier. Must not be null
.version
- feature version (as String). Can be null
.pluginVersion
- version of the feature plugin (as String). Can be
null
.primary
- true
if the feature is defined as a primary
feature, otherwise false
.application
- identifier of the application to run when
this feature is the primary feature. Can be null
.
If specified, the identifier must represent a valid extension
registered in the org.eclipse.core.runtime.applications
extension point.root
- an array of URLs to feature root directories.
These are URLs to install locations for the feature plugin
and its fragments. Can be null
.
public IPlatformConfiguration.IFeatureEntry createFeatureEntry(String id, String version, String pluginIdentifier, String pluginVersion, boolean primary, String application, URL[] root)
id
- feature identifier. Must not be null
.version
- feature version (as String). Can be null
.pluginIdentifier
- identifier of the feature plugin (as String). Can
be null
.pluginVersion
- version of the feature plugin (as String). Can be
null
.primary
- true
if the feature is defined as a primary
feature, otherwise false
.application
- identifier of the application to run when
this feature is the primary feature. Can be null
.
If specified, the identifier must represent a valid extension
registered in the org.eclipse.core.runtime.applications
extension point.root
- an array of URLs to feature root directories.
These are URLs to install locations for the feature plugin
and its fragments. Can be null
.
public void configureSite(IPlatformConfiguration.ISiteEntry entry)
entry
- site entrypublic void configureSite(IPlatformConfiguration.ISiteEntry entry, boolean replace)
entry
- site entryreplace
- indicating whether an existing configured entry with
the same URL should be replaced (true
) or not (false
).public void unconfigureSite(IPlatformConfiguration.ISiteEntry entry)
entry
- site entrypublic IPlatformConfiguration.ISiteEntry[] getConfiguredSites()
public IPlatformConfiguration.ISiteEntry findConfiguredSite(URL url)
url
- site url
null
if no match foundpublic void configureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
entry
- feature entrypublic void unconfigureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
entry
- feature entrypublic IPlatformConfiguration.IFeatureEntry[] getConfiguredFeatureEntries()
public IPlatformConfiguration.IFeatureEntry findConfiguredFeatureEntry(String id)
id
- feature identifier
null
.public URL getConfigurationLocation()
null
if the
configuration location could not be determined.public long getChangeStamp()
public long getFeaturesChangeStamp()
public long getPluginsChangeStamp()
public String getPrimaryFeatureIdentifier()
null
if none configuredpublic URL[] getPluginPath()
public String[] getBootstrapPluginIdentifiers()
public void setBootstrapPluginLocation(String id, URL location)
id
- plugin identifier. Must match one of the entries returned
by getBootstrapPluginIdentifiers()location
- getBootstrapPluginIdentifiers()
public boolean isUpdateable()
true
if configuration can be updated, false
otherwisepublic boolean isTransient()
true
if configuration is transient, false
otherwisepublic void isTransient(boolean value)
value
- true
if configuration is transient, false
otherwisepublic void refresh()
public void save() throws IOException
IOException
public void save(URL url) throws IOException
url
- save location.
IOException
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.