|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.Plugin
org.eclipse.rse.core.RSECorePlugin
public class RSECorePlugin
RSECorePlugin provides the activation for the RSE core and acts as the primary registry for logging, persistence, and the main RSE service registries.
Field Summary | |
---|---|
static int |
CURRENT_RELEASE
Current release as a number (multiplied by 100). |
static String |
CURRENT_RELEASE_NAME
Current release as a string. |
static int |
INIT_ALL
Initialization phase constant, value 0. |
static int |
INIT_INITIALIZER
Initialization phase constant, value 2. |
static int |
INIT_MODEL
Initialization phase constant, value 1. |
static String |
PLUGIN_ID
The plugin id for this plugin. |
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 | |
---|---|
static void |
addInitListener(IRSEInitListener listener)
Adds a new listener to the set of listeners to be notified when initialization phases complete. |
IRSECoreRegistry |
getCoreRegistry()
Returns the RSE core registry. |
static RSECorePlugin |
getDefault()
Returns the singleton instance of RSECorePlugin. |
IRSEInteractionProvider |
getDefaultInteractionProvider()
Get the default interface for interacting with the user or other outside world. |
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()
Return the SystemRegistry singleton. |
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 ISystemProfileManager |
getTheSystemProfileManager()
Return the master profile manager singleton. |
static ISystemRegistry |
getTheSystemRegistry()
A static convenience method - fully equivalent to RSECorePlugin.getDefault().getSystemRegistry() . |
static boolean |
isInitComplete(int phase)
Check whether the initialization of the RSE model is complete for a given phase. |
static boolean |
isTheSystemRegistryActive()
Check if the SystemRegistry has been instantiated already. |
static void |
removeInitListener(IRSEInitListener listener)
Removes a listener to the set of listeners to be notified when phases complete. |
void |
setDefaultInteractionProvider(IRSEInteractionProvider p)
Set the default interaction provider. |
void |
start(BundleContext context)
|
void |
stop(BundleContext context)
|
static IStatus |
waitForInitCompletion()
Waits until the RSE model has been fully restored from its persistent form. |
static IStatus |
waitForInitCompletion(int phase)
Waits until the RSE has completed a specific phase of its initialization. |
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 |
---|
public static final String PLUGIN_ID
public static final int CURRENT_RELEASE
public static final String CURRENT_RELEASE_NAME
public static final int INIT_ALL
isInitComplete(int)
which will return true if all phases of
initialization are complete. Clients must not assume any particular
ordering among phases based on the value.
public static final int INIT_MODEL
isInitComplete(int)
which will return true if the model phase of
the initialization is complete. Clients must not assume any particular
ordering among phases based on the value.
public static final int INIT_INITIALIZER
isInitComplete(int)
which will return true if the initializer
phase of the initialization is complete. Clients must not assume any
particular ordering among phases based on the value.
Constructor Detail |
---|
public RSECorePlugin()
Method Detail |
---|
public static RSECorePlugin getDefault()
public static IStatus waitForInitCompletion() throws InterruptedException
InterruptedException
- if this wait was interrupted for some
reason.public static IStatus waitForInitCompletion(int phase) throws InterruptedException
phase
- the phase to wait for completion.
InterruptedException
- if this wait was interrupted for some
reason.
IllegalArgumentException
- if the phase is undefined.INIT_ALL
,
INIT_INITIALIZER
,
INIT_MODEL
public static boolean isInitComplete(int phase)
phase
- the phase identifier.
true
if the initialization for the given phase has
completed regardless of its status of that completion.
IllegalArgumentException
- if the phase is undefined.INIT_ALL
,
INIT_INITIALIZER
,
INIT_MODEL
public static void addInitListener(IRSEInitListener listener)
listener
- the listener to be addedpublic static void removeInitListener(IRSEInitListener listener)
listener
- the listener to be removedpublic static IRSECoreRegistry getTheCoreRegistry()
RSECorePlugin.getDefault().getRegistry()
.
public static IRSEPersistenceManager getThePersistenceManager()
RSECorePlugin.getDefault().getPersistenceManager()
.
public static ISystemProfileManager getTheSystemProfileManager()
public static boolean isTheSystemRegistryActive()
true
if the System Registry has been instantiated
already.public static ISystemRegistry getTheSystemRegistry()
RSECorePlugin.getDefault().getSystemRegistry()
.
The SystemRegistry is used to gain access to the basic services
and components used in RSE.
public static String getLocalMachineName()
public static String getLocalMachineIPAddress()
public static String getQualifiedHostName(String hostName)
public void start(BundleContext context) throws Exception
start
in interface BundleActivator
start
in class Plugin
Exception
public void stop(BundleContext context) throws Exception
stop
in interface BundleActivator
stop
in class Plugin
Exception
public IRSEPersistenceManager getPersistenceManager()
public ISystemRegistry getSystemRegistry()
public IRSECoreRegistry getCoreRegistry()
This may return null if the registry has not yet been set.
public Logger getLogger()
public void setDefaultInteractionProvider(IRSEInteractionProvider p)
EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Target Management team.
p
- the interaction provider to set.public IRSEInteractionProvider getDefaultInteractionProvider()
EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Target Management team.
public ISubSystemConfigurationProxy[] getSubSystemConfigurationProxies()
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |