RSE
Release 3.0

org.eclipse.rse.core.model
Class SystemStartHere

java.lang.Object
  extended by org.eclipse.rse.core.model.SystemStartHere

public class SystemStartHere
extends Object

A utility class, composed of static methods, that can be used to begin RSE processing.


Constructor Summary
SystemStartHere()
           
 
Method Summary
static ISystemProfile[] getActiveSystemProfiles()
          Return all active profiles.
static IHost[] getConnections()
          STEP 2a.
static IHost[] getConnectionsBySubSystemConfiguration(ISubSystemConfiguration subsystemConfiguration)
          STEP 2c.
static IHost[] getConnectionsBySubSystemConfiguration(String subsystemConfigurationId)
          STEP 2d.
static IHost[] getConnectionsBySystemType(String systemTypeId)
          STEP 2b.
static ISubSystem getSubSystem(String subsystemConfigurationId, IHost connection)
          STEP 3c.
static ISubSystemConfiguration getSubSystemConfiguration(String subsystemConfigurationId)
          Miscellaneous Helper - return the subsystem configuration object for the given subsystemConfigurationId.
static ISubSystem[] getSubSystems(String subsystemConfigurationId)
          STEP 3a.
static ISubSystem[] getSubSystems(String subsystemConfigurationId, IHost connection)
          STEP 3b.
static ISystemProfileManager getSystemProfileManager()
          Miscellaneous Helper - Return the singleton profile manager.
static ISystemRegistry getSystemRegistry()
          STEP 1.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SystemStartHere

public SystemStartHere()
Method Detail

getSystemRegistry

public static ISystemRegistry getSystemRegistry()
STEP 1. Get system registry singleton

SAME AS: RSECorePlugin.getSystemRegistry


getConnections

public static IHost[] getConnections()
STEP 2a. Get connections for all system types

SAME AS: getSystemRegistry().getConnections()

See Also:
getConnectionsBySystemType(String)

getConnectionsBySystemType

public static IHost[] getConnectionsBySystemType(String systemTypeId)
STEP 2b. Get all connections for the given system type.

SAME AS: getSystemRegistry().getHostsBySystemType(systemType)

Parameters:
systemTypeId - One of the system types IDs defined via system type extension point:
See Also:
IRSESystemType, IRSECoreRegistry.getSystemTypeById(String), ISystemRegistry.getHostsBySystemType(IRSESystemType)

getConnectionsBySubSystemConfiguration

public static IHost[] getConnectionsBySubSystemConfiguration(ISubSystemConfiguration subsystemConfiguration)
STEP 2c. Get all connections for your subsystem configuration

SAME AS: getSystemRegistry().getConnectionsBySubSystemConfiguration(subsystemConfiguration)

Parameters:
subsystemConfiguration - A subsystem configuration object.
See Also:
ISystemRegistry.getHostsBySubSystemConfiguration(ISubSystemConfiguration), getConnectionsBySubSystemConfiguration(String)

getConnectionsBySubSystemConfiguration

public static IHost[] getConnectionsBySubSystemConfiguration(String subsystemConfigurationId)
STEP 2d. Get all connections for your subsystem configuration, identified by subsystemConfigurationId.

SAME AS: getSystemRegistry().getConnectionsBySubSystemConfiguration(getSubSystemConfiguration(subsystemConfigurationId))

Parameters:
subsystemConfigurationId - The id of the subsystem configuration as given in its plugin.xml id attribute for the subsystemConfigurations extension point
See Also:
getSubSystemConfiguration(String), getConnectionsBySubSystemConfiguration(ISubSystemConfiguration)

getSubSystems

public static ISubSystem[] getSubSystems(String subsystemConfigurationId)
STEP 3a. Get all subsystems for all connections for your subsystem configuration, identified by subsystemConfigurationId.

SAME AS: getSystemRegistry().getSubSystems(subsystemConfigurationId)

Parameters:
subsystemConfigurationId - The subsystem configuration id as given in its plugin.xml id attribute for the subsystemConfigurations extension point
See Also:
ISystemRegistry.getSubSystemConfiguration(String), ISubSystemConfiguration.getSubSystems(boolean), ISubSystemConfiguration.getId()

getSubSystems

public static ISubSystem[] getSubSystems(String subsystemConfigurationId,
                                         IHost connection)
STEP 3b. Get all subsystems for the given connection for your subsystem configuration, identified by subsystemConfigurationId.

SAME AS: getSystemRegistry().getSubSystems(subsystemConfigurationId, connection)

Parameters:
subsystemConfigurationId - The subsystem configuration id as given in its plugin.xml id attribute for the subsystemConfigurations extension point
connection - The connection object you wish to get the subsystems for. Typically there is only one subsystem per object.
See Also:
ISystemRegistry.getSubSystemConfiguration(String), ISubSystemConfiguration.getSubSystems(IHost, boolean)

getSubSystem

public static ISubSystem getSubSystem(String subsystemConfigurationId,
                                      IHost connection)
STEP 3c. Same as getSubSystems(String,IHost) by used when you know the subsystem configuration only supports a single subsystem per connection.

Parameters:
subsystemConfigurationId - The subsystem configuration id as given in its plugin.xml id attribute for the subsystemConfigurations extension point
connection - The connection object you wish to get the subsystems for. Typically there is only one subsystem per object.
See Also:
getSubSystems(String, IHost), ISubSystemConfiguration.getId()

getSubSystemConfiguration

public static ISubSystemConfiguration getSubSystemConfiguration(String subsystemConfigurationId)
Miscellaneous Helper - return the subsystem configuration object for the given subsystemConfigurationId.

SAME AS: getSystemRegistry().getSubSystemConfiguration(subsystemConfigurationId)

Parameters:
subsystemConfigurationId - The id of the subsystem configuration as given in its plugin.xml id attribute for the subsystemConfigurations extension point

getSystemProfileManager

public static ISystemProfileManager getSystemProfileManager()
Miscellaneous Helper - Return the singleton profile manager. SAME AS: getSystemRegistry().getSystemProfileManager()


getActiveSystemProfiles

public static ISystemProfile[] getActiveSystemProfiles()
Return all active profiles.

A team might have many profiles, at least one per developer. However, typically only one or two are activated at a time, and we only return connections for those which are active.

SAME AS: getSystemRegistry().getActiveSystemProfiles()


RSE
Release 3.0

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