org.eclipse.core.internal.registry.osgi

Class EquinoxRegistryStrategy

java.lang.Object

org.eclipse.core.runtime.spi.RegistryStrategy

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

org.eclipse.core.internal.registry.osgi.EquinoxRegistryStrategy

public class EquinoxRegistryStrategy
extends RegistryStrategyOSGI

The registry strategy used by the Equinox extension registry. Adds to the OSGi registry:

• Use debug information supplied via .options files
• Use Eclipse logging - Use Eclipse platform state for cache validation
• Event scheduling is done using Eclipse job scheduling mechanism

Since:

org.eclipse.equinox.registry 3.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_DEBUG
static java.lang.String	OPTION_DEBUG_EVENTS
static java.lang.String	PLUGIN_NAME

Fields inherited from class org.eclipse.core.internal.registry.osgi.RegistryStrategyOSGI

DEBUG, DEBUG_REGISTRY_EVENTS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	debug() Override this method to specify debug requirements to the registry.
boolean	debugRegistryEvents() Override this method to specify debug requirements for the registry event processing.
long	getContainerTimestamp() This method is called as a part of the registry cache validation.
void	log(IStatus status) Override this method to provide customized logging functionality to the registry.
void	scheduleChangeEvent(java.lang.Object[] listeners, java.util.Map<java.lang.String,?> deltas, java.lang.Object registry) This method will attempt to use Eclipse Jobs mechanism to schedule registry events.

Methods inherited from class org.eclipse.core.internal.registry.osgi.RegistryStrategyOSGI

cacheLazyLoading, cacheUse, checkContributionsTimestamp, createExecutableExtension, getContributionsTimestamp, getExtendedTimestamp, getLocale, getXMLParser, onStart, onStop, translate, translate

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

getLocationsLength, getStorage, isCacheReadOnly, onStart, processChangeEvent

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

See Also:

Constant Field Values

OPTION_DEBUG

public static final java.lang.String OPTION_DEBUG

See Also:

Constant Field Values

OPTION_DEBUG_EVENTS

public static final java.lang.String OPTION_DEBUG_EVENTS

See Also:

Constant Field Values

Constructor Detail

EquinoxRegistryStrategy

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

Method Detail

debug

public boolean debug()

Description copied from class: RegistryStrategy

Override this method to specify debug requirements to the registry. In the default implementation this method returns false indicating that debug functionality is turned off.

Note that in a general case the extension registry plug-in doesn't depend on OSGI and therefore cannot use Eclipse .options files to discover debug options.

Overrides:

debug in class RegistryStrategy

Returns:

true if debug logging and validation should be performed and false otherwise

debugRegistryEvents

public boolean debugRegistryEvents()

Description copied from class: RegistryStrategy

Override this method to specify debug requirements for the registry event processing. In the default implementation this method returns false indicating that debug of the registry events is turned off.

Note that in a general case the extension registry plug-in doesn't depend on OSGI and therefore cannot use Eclipse .options files to discover debug options.

Overrides:

debugRegistryEvents in class RegistryStrategy

Returns:

true if debug logging and validation of the registry events should be performed and false otherwise

log

public final void log(IStatus status)

Description copied from class: RegistryStrategy

Override this method to provide customized logging functionality to the registry. The method adds a log entry based on the supplied status.

This method writes a message to System.out in the following format:

 [Error|Warning|Log]: Main error message
 [Error|Warning|Log]: Child error message 1
        ...
 [Error|Warning|Log]: Child error message N
 

Overrides:

log in class RegistryStrategy

Parameters:

status - the status to log

getContainerTimestamp

public long getContainerTimestamp()

Description copied from class: RegistryStrategy

This method is called as a part of the registry cache validation. The cache is valid on the registry startup if the pair {container time stamp, contributors time stamp} supplied by the registry strategy is the same as the {container time stamp, contributors time stamp} stored in the registry cache. The goal of the validation is to be able to catch modifications made to the original data contributed into the registry and not reflected in the registry cache.

The method produces a number that corresponds to the current state of the data stored by the container. Increment the stamp if the data stored in the container has been updated so that the data cached by the registry is no longer valid. For instance, in Eclipse addition or removal of a bundle results in the number returned by this method being incremented. As a result, if a bundle that contributed plugin.xml into the extension registry was modified, the state doesn't match the state stored in the registry cache. In this case the cache content becomes invalid and the registry needs to be re-created from the original data.

Generally, treat this number as a hash code for the data stored in the registry. It stays the same as long as the registry content is not changing. It becomes a different number as the registry content gets modified.

Return 0 to indicate that state verification is not required.

Overrides:

getContainerTimestamp in class RegistryStrategy

Returns:

number indicating state of the application data

scheduleChangeEvent

public final void scheduleChangeEvent(java.lang.Object[] listeners,
                                      java.util.Map<java.lang.String,?> deltas,
                                      java.lang.Object registry)

This method will attempt to use Eclipse Jobs mechanism to schedule registry events. If, at any time, Eclipse Jobs mechanism is missing, this method will fallback on the "internal" event scheduling provided by the registry strategy. Once the switch to the fallback mechanism occurred, no further attempt to use scheduling from the Jobs bundle will be made (until registry bundle is restarted). Avoiding repeated checks in this scenario will ensure that most users see no performance degradation and that order of registry events remains consistent.

Overrides:

scheduleChangeEvent in class RegistryStrategy

Parameters:

listeners - the list of active listeners (thread safe); may not be null

deltas - the registry deltas (thread safe); may not be null

registry - the extension registry (NOT thread safe); may not be null