org.eclipse.rse.core
Class RSECorePlugin

java.lang.Object
  org.eclipse.core.runtime.Plugin
      org.eclipse.rse.core.RSECorePlugin

All Implemented Interfaces:

BundleActivator

public class RSECorePlugin
extends Plugin

RSECorePlugin provides the activation for the RSE core and acts as the primary registry for logging, persistence, and the main RSE service registries. It should not be extended by other classes.

Field Summary

static int	CURRENT_RELEASE Current release as a number (multiplied by 100).
static String	CURRENT_RELEASE_NAME Current release as a string.

Fields inherited from class org.eclipse.core.runtime.Plugin

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

RSECorePlugin()
The constructor.

Method Summary

IRSECoreRegistry	getCoreRegistry() Returns the RSE core registry.
static RSECorePlugin	getDefault() Returns the singleton instance of RSECorePlugin.
static String	getLocalMachineIPAddress()
static String	getLocalMachineName()
Logger	getLogger() Returns an instance of the logger being used by the core.
IRSEPersistenceManager	getPersistenceManager()
static String	getQualifiedHostName(String hostName) Returns a qualified host name given a potentially unqualified host name
ISubSystemConfigurationProxy[]	getSubSystemConfigurationProxies() Return an array of SubSystemConfigurationProxy objects.
ISystemRegistry	getSystemRegistry() Gets the system registry set by setSystemRegistry(ISystemRegistry).
static IRSECoreRegistry	getTheCoreRegistry() A static convenience method - fully equivalent to RSECorePlugin.getDefault().getRegistry().
static IRSEPersistenceManager	getThePersistenceManager() A static convenience method - fully equivalent to RSECorePlugin.getDefault().getPersistenceManager().
static ISystemRegistry	getTheSystemRegistry() A static convenience method - fully equivalent to RSECorePlugin.getDefault().getSystemRegistry().
void	setSystemRegistry(ISystemRegistry registry) Sets the system registry.
void	start(BundleContext context)
void	stop(BundleContext context)

Methods inherited from class org.eclipse.core.runtime.Plugin

find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, shutdown, startup, toString

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_RELEASE

public static final int CURRENT_RELEASE

Current release as a number (multiplied by 100). E.g. 300 is for release 3.0.0

See Also:

Constant Field Values

CURRENT_RELEASE_NAME

public static final String CURRENT_RELEASE_NAME

Current release as a string.

See Also:

Constant Field Values

Constructor Detail

RSECorePlugin

public RSECorePlugin()

The constructor. This may be called only by plugin activation.

Method Detail

getDefault

public static RSECorePlugin getDefault()

Returns the singleton instance of RSECorePlugin.

Returns:

the singleton instance.

getThePersistenceManager

public static IRSEPersistenceManager getThePersistenceManager()

A static convenience method - fully equivalent to RSECorePlugin.getDefault().getPersistenceManager().

Returns:

the persistence manager currently in use for RSE

getTheCoreRegistry

public static IRSECoreRegistry getTheCoreRegistry()

A static convenience method - fully equivalent to RSECorePlugin.getDefault().getRegistry().

Returns:

the RSE Core Registry.

getTheSystemRegistry

public static ISystemRegistry getTheSystemRegistry()

A static convenience method - fully equivalent to RSECorePlugin.getDefault().getSystemRegistry().

Returns:

the RSE System Registry.

getLocalMachineName

public static String getLocalMachineName()

Returns:

the IP host name of this machine

getLocalMachineIPAddress

public static String getLocalMachineIPAddress()

Returns:

the local IP address of this machine

getQualifiedHostName

public static String getQualifiedHostName(String hostName)

Returns a qualified host name given a potentially unqualified host name

start

public void start(BundleContext context)
           throws Exception

Specified by:

start in interface BundleActivator

Overrides:

start in class Plugin

Throws:

Exception

stop

public void stop(BundleContext context)
          throws Exception

Specified by:

stop in interface BundleActivator

Overrides:

stop in class Plugin

Throws:

Exception

getPersistenceManager

public IRSEPersistenceManager getPersistenceManager()

Returns:

the persistence manager used for persisting RSE profiles

setSystemRegistry

public void setSystemRegistry(ISystemRegistry registry)

Sets the system registry. This is the main registry that can be used by RSE components that require a user interface. This should be set only by RSE startup components and not by any external client.

Parameters:

registry - the implementation of ISystemRegistry that the core should remember.

getSystemRegistry

public ISystemRegistry getSystemRegistry()

Gets the system registry set by setSystemRegistry(ISystemRegistry). This registry is used to gain access to the basic services and components used in the RSE user interface.

Returns:

the RSE system registry

getCoreRegistry

public IRSECoreRegistry getCoreRegistry()

Returns the RSE core registry. Clients should use this method to get the registry which is the starting point for working with the RSE framework. It contains methods to access core services and components. It is distinct from, and more basic than, an implementation of ISystemRegistry.

This may return null if the registry has not yet been set.

Returns:

the RSE core registry.

getLogger

public Logger getLogger()

Returns an instance of the logger being used by the core. All core services, or extensions to core services, should use this logger to log any messages. The RSE logger provides run-time filtering according to user preference and uses the platform's logging capabilities. RSE services should use this logger rather than a platform logger. The logger is defined at plugin start and should always be available.

Returns:

the instance of System#Logger used by the core RSE

getSubSystemConfigurationProxies

public ISubSystemConfigurationProxy[] getSubSystemConfigurationProxies()

Return an array of SubSystemConfigurationProxy objects. These represent all extensions to our subsystemConfigurations extension point.