public interface IPlatformConfiguration
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.
Modifier and Type | Interface and Description |
---|---|
static interface |
IPlatformConfiguration.IFeatureEntry
Deprecated.
Feature entry.
|
static interface |
IPlatformConfiguration.ISiteEntry
Deprecated.
Configuration entry representing an install site.
|
static interface |
IPlatformConfiguration.ISitePolicy
Deprecated.
Site policy.
|
Modifier and Type | Method and Description |
---|---|
void |
configureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
Deprecated.
Configures the feature entry.
|
void |
configureSite(IPlatformConfiguration.ISiteEntry entry)
Deprecated.
Configures the specified site entry.
|
void |
configureSite(IPlatformConfiguration.ISiteEntry entry,
boolean replace)
Deprecated.
Configures the specified site entry.
|
IPlatformConfiguration.IFeatureEntry |
createFeatureEntry(String id,
String version,
String pluginVersion,
boolean primary,
String application,
URL[] root)
Deprecated.
Create a feature entry
|
IPlatformConfiguration.IFeatureEntry |
createFeatureEntry(String id,
String version,
String pluginIdentifier,
String pluginVersion,
boolean primary,
String application,
URL[] root)
Deprecated.
Create a feature entry
|
IPlatformConfiguration.ISiteEntry |
createSiteEntry(URL url,
IPlatformConfiguration.ISitePolicy policy)
Deprecated.
Create a site entry
|
IPlatformConfiguration.ISitePolicy |
createSitePolicy(int type,
String[] list)
Deprecated.
Create a site policy.
|
IPlatformConfiguration.IFeatureEntry |
findConfiguredFeatureEntry(String id)
Deprecated.
Locates the specified feature entry.
|
IPlatformConfiguration.ISiteEntry |
findConfiguredSite(URL url)
Deprecated.
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()
Deprecated.
Returns a stamp reflecting the current state of the configuration.
|
URL |
getConfigurationLocation()
Deprecated.
Returns the URL location of the configuration information
|
IPlatformConfiguration.IFeatureEntry[] |
getConfiguredFeatureEntries()
Deprecated.
Returns a list of configured feature entries.
|
IPlatformConfiguration.ISiteEntry[] |
getConfiguredSites()
Deprecated.
Returns configured site entries
|
long |
getFeaturesChangeStamp()
Deprecated.
Do not use this method.
|
URL[] |
getPluginPath()
Deprecated.
Computes the plug-in path for this configuration.
|
long |
getPluginsChangeStamp()
Deprecated.
Do not use this method
|
String |
getPrimaryFeatureIdentifier()
Deprecated.
Returns the identifier of the configured primary feature.
|
boolean |
isTransient()
Deprecated.
Returns an indication whether the configuration is transient.
|
void |
isTransient(boolean value)
Deprecated.
Indicates whether the configuration is transient or not.
|
boolean |
isUpdateable()
Deprecated.
Returns an indication whether the configuration can be updated.
|
void |
refresh()
Deprecated.
Called to refresh the configuration information.
|
void |
save()
Deprecated.
Called to save the configuration information
|
void |
save(URL url)
Deprecated.
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)
Deprecated.
Unconfigures the specified feature entry if it exists.
|
void |
unconfigureSite(IPlatformConfiguration.ISiteEntry entry)
Deprecated.
Unconfigures the specified entry.
|
IPlatformConfiguration.ISiteEntry createSiteEntry(URL url, IPlatformConfiguration.ISitePolicy policy)
url
- site URLpolicy
- site policyIPlatformConfiguration.ISitePolicy createSitePolicy(int type, String[] list)
type
- policy typelist
- an array of site-relative paths representing the
inclusion/ exclusion listIPlatformConfiguration.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
.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
.void configureSite(IPlatformConfiguration.ISiteEntry entry)
entry
- site entryvoid 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
).void unconfigureSite(IPlatformConfiguration.ISiteEntry entry)
entry
- site entryIPlatformConfiguration.ISiteEntry[] getConfiguredSites()
IPlatformConfiguration.ISiteEntry findConfiguredSite(URL url)
url
- site urlnull
if no match foundvoid configureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
entry
- feature entryvoid unconfigureFeatureEntry(IPlatformConfiguration.IFeatureEntry entry)
entry
- feature entryIPlatformConfiguration.IFeatureEntry[] getConfiguredFeatureEntries()
IPlatformConfiguration.IFeatureEntry findConfiguredFeatureEntry(String id)
id
- feature identifiernull
.URL getConfigurationLocation()
null
if the
configuration location could not be determined.long getChangeStamp()
long getFeaturesChangeStamp()
long getPluginsChangeStamp()
String getPrimaryFeatureIdentifier()
null
if none configuredURL[] getPluginPath()
String[] getBootstrapPluginIdentifiers()
void setBootstrapPluginLocation(String id, URL location)
id
- plugin identifier. Must match one of the entries returned
by getBootstrapPluginIdentifiers()location
- getBootstrapPluginIdentifiers()
boolean isUpdateable()
true
if configuration can be updated, false
otherwiseboolean isTransient()
true
if configuration is transient, false
otherwisevoid isTransient(boolean value)
value
- true
if configuration is transient, false
otherwisevoid refresh()
void save() throws IOException
IOException
void save(URL url) throws IOException
url
- save location.IOException
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.