org.eclipse.core.internal.registry.osgi

Class RegistryStrategyOSGI

java.lang.Object

org.eclipse.core.runtime.spi.RegistryStrategy

org.eclipse.core.internal.registry.osgi.RegistryStrategyOSGI

Direct Known Subclasses:

EquinoxRegistryStrategy

public class RegistryStrategyOSGI
extends RegistryStrategy

The registry strategy that can be used in OSGi world. It provides the following functionality:

• Translation is done with ResourceTranslator
• Registry is filled with information stored in plugin.xml / fragment.xml of OSGi bundles
• Uses bunlde-based class loading to create executable extensions
• Performs registry validation based on the time stamps of the plugin.xml / fragment.xml files
• XML parser is obtained via an OSGi service

Since:

org.eclipse.equinox.registry 3.2

See Also:

RegistryFactory.setDefaultRegistryProvider(IRegistryProvider)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	DEBUG Debug extension registry
protected boolean	DEBUG_REGISTRY_EVENTS Debug extension registry events

Constructor Summary

Constructors

Constructor and Description
RegistryStrategyOSGI(java.io.File[] theStorageDir, boolean[] cacheReadOnly, java.lang.Object key)

Method Summary

Modifier and Type	Method and Description
boolean	cacheLazyLoading() Specifies if lazy cache loading is used.
boolean	cacheUse() Specifies if the extension registry should use cache to store registry data between invocations.
boolean	checkContributionsTimestamp()
java.lang.Object	createExecutableExtension(RegistryContributor contributor, java.lang.String className, java.lang.String overridenContributorName) Creates an executable extension.
long	getContributionsTimestamp() This method is called as a part of the registry cache validation.
long	getExtendedTimestamp(Bundle bundle, java.net.URL pluginManifest)
java.lang.String	getLocale() Returns the current locale for the extension registry with enabled multi-language support.
javax.xml.parsers.SAXParserFactory	getXMLParser() Returns the parser used by the registry to parse descriptions of extension points and extensions.
void	onStart(IExtensionRegistry registry, boolean loadedFromCache) Override this method to provide additional processing performed when the registry is created and started.
void	onStop(IExtensionRegistry registry) Override this method to provide additional processing to be performed just before the registry is stopped.
java.lang.String[]	translate(java.lang.String[] nonTranslated, IContributor contributor, java.lang.String locale) Translates array of keys supplied by the contributor to the requested locale.
java.lang.String	translate(java.lang.String key, java.util.ResourceBundle resources) Translates key using the supplied resource bundle.

Methods inherited from class org.eclipse.core.runtime.spi.RegistryStrategy

debug, debugRegistryEvents, getContainerTimestamp, getLocationsLength, getStorage, isCacheReadOnly, log, onStart, processChangeEvent, scheduleChangeEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

protected boolean DEBUG

Debug extension registry

DEBUG_REGISTRY_EVENTS

protected boolean DEBUG_REGISTRY_EVENTS

Debug extension registry events

Constructor Detail

RegistryStrategyOSGI

public RegistryStrategyOSGI(java.io.File[] theStorageDir,
                            boolean[] cacheReadOnly,
                            java.lang.Object key)

Parameters:

theStorageDir - - array of file system directories to store cache files; might be null

cacheReadOnly - - array of read only attributes. True: cache at this location is read only; false: cache is read/write

key - - control key for the registry (should be the same key as used in the RegistryManager#createExtensionRegistry() of this registry

Method Detail

translate

public final java.lang.String translate(java.lang.String key,
                                        java.util.ResourceBundle resources)

Description copied from class: RegistryStrategy

Translates key using the supplied resource bundle. The resource bundle is optional and might be null.

The default translation routine assumes that keys are prefixed with '%'. If no resource bundle is present, the key itself (without leading '%') is returned. There is no decoding for the leading '%%'.

Overrides:

translate in class RegistryStrategy

Parameters:

key - message key to be translated

resources - resource bundle, or null

Returns:

the translated string, must not be null

translate

public java.lang.String[] translate(java.lang.String[] nonTranslated,
                                    IContributor contributor,
                                    java.lang.String locale)

Description copied from class: RegistryStrategy

Translates array of keys supplied by the contributor to the requested locale.

This method is intended to be overridden by specialized registry strategies that know translation conventions for the contributors, for instance, the agreed upon locations of the translated keys for bundle contributors. The base implementation simply returns the array of non-translated keys.

This method is only used if multi-language support is enabled.

Overrides:

translate in class RegistryStrategy

Parameters:

nonTranslated - message keys to be translated

contributor - the contributor of the keys to be translated

locale - the requested locale for the keys

Returns:

the arrays of translated strings

See Also:

IExtensionRegistry.isMultiLanguage()

createExecutableExtension

public java.lang.Object createExecutableExtension(RegistryContributor contributor,
                                                  java.lang.String className,
                                                  java.lang.String overridenContributorName)
                                           throws CoreException

Description copied from class: RegistryStrategy

Creates an executable extension. Override this method to supply an alternative processing for the creation of executable extensions.

This method receives the contributor of the executable extension and, possibly, an optional contributor name if specified by the executable extension. The overridden contributor name might be null.

In this implementation registry attempts to instantiate the class specified via the class name (must not be null) using standard Java reflection mechanism. This method assumes that such class has a default constructor with no arguments.

Overrides:

createExecutableExtension in class RegistryStrategy

Parameters:

contributor - the contributor of this executable extension

className - the name of the class to be instantiated

overridenContributorName - the contributor to be used, or null if not specified

Returns:

the object created, or null

Throws:

CoreException - if there was a problem creating the executable extension

See Also:

IConfigurationElement.createExecutableExtension(String), IExecutableExtension

onStart

public void onStart(IExtensionRegistry registry,
                    boolean loadedFromCache)

Description copied from class: RegistryStrategy

Override this method to provide additional processing performed when the registry is created and started. Overrides should call super.onStart() at the beginning of the processing.

Overrides:

onStart in class RegistryStrategy

Parameters:

registry - the extension registry being started

loadedFromCache - true is registry contents was loaded from cache when the registry was created

onStop

public void onStop(IExtensionRegistry registry)

Description copied from class: RegistryStrategy

Override this method to provide additional processing to be performed just before the registry is stopped. Overrides should call super.onStop() at the end of the processing.

Overrides:

onStop in class RegistryStrategy

Parameters:

registry - the extension registry being stopped

cacheUse

public boolean cacheUse()

Description copied from class: RegistryStrategy

Specifies if the extension registry should use cache to store registry data between invocations.

The default implementation enables caching returning true.

Overrides:

cacheUse in class RegistryStrategy

Returns:

true if the cache should be used and false otherwise

cacheLazyLoading

public boolean cacheLazyLoading()

Description copied from class: RegistryStrategy

Specifies if lazy cache loading is used.

The default implementation specifies that lazy cache loading is going to be used and therefore returns true.

Overrides:

cacheLazyLoading in class RegistryStrategy

Returns:

true if lazy cache loading is used and false otherwise

getContributionsTimestamp

public long getContributionsTimestamp()

Description copied from class: RegistryStrategy

This method is called as a part of the registry cache validation. The method calculates a number describing the time when the originating contributions (i.e., plugin.xml files in case of the Eclipse registry) were last modified.

The value returned by the method is compared with the timestamp tracked by the registry. If contributions changed since they have been added to the registry (i.e., plugin.xml file was modified since the last run), the value of the RegistryStrategy.getContributionsTimestamp() will change and no longer will be the same as the value tracked by the registry. In this case the cache is considered to be invalid and the registry is going to be re-populated form scratch.

(The word "timestamp" is used very loosely here. In this context, "timestamp" is more likely to be a hash value aggregating a number of actual timestamps from the contributions.)

This method may return 0 to indicate that no time stamp verification is required.

Overrides:

getContributionsTimestamp in class RegistryStrategy

Returns:

a value corresponding to the last modification time of contributions contained in the registry

checkContributionsTimestamp

public boolean checkContributionsTimestamp()

getExtendedTimestamp

public long getExtendedTimestamp(Bundle bundle,
                                 java.net.URL pluginManifest)

getXMLParser

public javax.xml.parsers.SAXParserFactory getXMLParser()

Description copied from class: RegistryStrategy

Returns the parser used by the registry to parse descriptions of extension points and extensions. This method must not return null.

Overrides:

getXMLParser in class RegistryStrategy

Returns:

this strategy's parser

See Also:

IExtensionRegistry.addContribution(java.io.InputStream, IContributor, boolean, String, ResourceBundle, Object)

getLocale

public java.lang.String getLocale()

Description copied from class: RegistryStrategy

Returns the current locale for the extension registry with enabled multi-language support.

The default implementation assumes that there is a single system wide locale, equivalent to Locale.getDefault().

The result of this method should not be retained or passed to other threads. The current locale can change any time and may be different for each thread.

This method can be overridden by subclasses that wish to provide a way to change the default locale.

This method is only used if multi-language support is enabled.

Overrides:

getLocale in class RegistryStrategy

Returns:

the default locale

See Also:

IExtensionRegistry.isMultiLanguage()