Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.core
Class RSECorePlugin

java.lang.Object
  extended by 

org.eclipse.core.runtime.Plugin
      extended by 
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.


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

PLUGIN_ID

public static final 
String PLUGIN_ID
The plugin id for this plugin. Value "org.eclipse.rse.core".

Since:
org.eclipse.rse.core 3.0
See Also:
Constant Field Values

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

INIT_ALL

public static final int INIT_ALL
Initialization phase constant, value 0. Used in 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.

Since:
org.eclipse.rse.core 3.0
See Also:
Constant Field Values

INIT_MODEL

public static final int INIT_MODEL
Initialization phase constant, value 1. Used in 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.

Since:
org.eclipse.rse.core 3.0
See Also:
Constant Field Values

INIT_INITIALIZER

public static final int INIT_INITIALIZER
Initialization phase constant, value 2. Used in 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.

Since:
org.eclipse.rse.core 3.0
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.

waitForInitCompletion

public static 
IStatus waitForInitCompletion()
                                     throws 
InterruptedException
Waits until the RSE model has been fully restored from its persistent form. Should be used before accessing pieces of the model.

Returns:
an IStatus indicating how the initialization ended.
Throws:
InterruptedException - if this wait was interrupted for some reason.
Since:
org.eclipse.rse.core 3.0

waitForInitCompletion

public static 
IStatus waitForInitCompletion(int phase)
                                     throws 
InterruptedException
Waits until the RSE has completed a specific phase of its initialization.

Parameters:
phase - the phase to wait for completion.
Returns:
an IStatus indicating how the initialization for that phase ended.
Throws:
InterruptedException - if this wait was interrupted for some reason.
IllegalArgumentException - if the phase is undefined.
Since:
org.eclipse.rse.core 3.0
See Also:
INIT_ALL, INIT_INITIALIZER, INIT_MODEL

isInitComplete

public static boolean isInitComplete(int phase)
Check whether the initialization of the RSE model is complete for a given phase.

Parameters:
phase - the phase identifier.
Returns:
true if the initialization for the given phase has completed regardless of its status of that completion.
Throws:
IllegalArgumentException - if the phase is undefined.
Since:
org.eclipse.rse.core 3.0
See Also:
INIT_ALL, INIT_INITIALIZER, INIT_MODEL

addInitListener

public static void addInitListener(
IRSEInitListener listener)
Adds a new listener to the set of listeners to be notified when initialization phases complete. If the listener is added after the phase has completed it will not be invoked. If the listener is already in the set it will not be added again. Listeners may be notified in any order.

Parameters:
listener - the listener to be added
Since:
org.eclipse.rse.core 3.0

removeInitListener

public static void removeInitListener(
IRSEInitListener listener)
Removes a listener to the set of listeners to be notified when phases complete. If the listener is not in the set this does nothing.

Parameters:
listener - the listener to be removed
Since:
org.eclipse.rse.core 3.0

getTheCoreRegistry

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

Returns:
the RSE Core Registry.

getThePersistenceManager

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

Returns:
the persistence manager currently in use for RSE

getTheSystemProfileManager

public static 
ISystemProfileManager getTheSystemProfileManager()
Return the master profile manager singleton.

Returns:
the RSE Profile Manager Singleton.
Since:
org.eclipse.rse.core 3.0

isTheSystemRegistryActive

public static boolean isTheSystemRegistryActive()
Check if the SystemRegistry has been instantiated already. Use this when you don't want to start the system registry as a side effect of retrieving it.

Returns:
true if the System Registry has been instantiated already.
Since:
org.eclipse.rse.core 3.0

getTheSystemRegistry

public static 
ISystemRegistry getTheSystemRegistry()
A static convenience method - fully equivalent to RSECorePlugin.getDefault().getSystemRegistry(). The SystemRegistry is used to gain access to the basic services and components used in RSE.

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

getSystemRegistry

public 
ISystemRegistry getSystemRegistry()
Return the SystemRegistry singleton. Clients should use static @{link getTheSystemRegistry()} instead.

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

setDefaultInteractionProvider

public void setDefaultInteractionProvider(
IRSEInteractionProvider p)
Set the default interaction provider. When RSE is run with UI, the UI plugins need to set an UI-based interaction provider for showing dialogs from Core operations. Non-UI headless operations can use an Interaction Provider that just logs its messages and works without other UI.

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.

Parameters:
p - the interaction provider to set.
Since:
org.eclipse.rse.core 3.0

getDefaultInteractionProvider

public 
IRSEInteractionProvider getDefaultInteractionProvider()
Get the default interface for interacting with the user or other outside world.

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.

Returns:
the default interaction provider.
Since:
org.eclipse.rse.core 3.0

getSubSystemConfigurationProxies

public 
ISubSystemConfigurationProxy[] getSubSystemConfigurationProxies()
Return an array of SubSystemConfigurationProxy objects. These represent all extensions to our subsystemConfigurations extension point.


RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire