Remote Systems
v6.4.1

com.ibm.etools.systems.model
Class SystemStartHere

java.lang.Object
  extended bycom.ibm.etools.systems.model.SystemStartHere

public class SystemStartHere
extends Object

It all begins RIGHT HERE!


Field Summary
static String copyright
           
 
Constructor Summary
SystemStartHere()
           
 
Method Summary
static SystemProfile[] getActiveSystemProfiles()
          Return all active profiles.
static SystemConnection[] getConnections()
          STEP 2a.
static SystemConnection[] getConnectionsBySubSystemFactory(String factoryId)
          STEP 2d.
static SystemConnection[] getConnectionsBySubSystemFactory(SubSystemFactory factory)
          STEP 2c.
static SystemConnection[] getConnectionsBySystemType(String systemType)
          STEP 2b.
static SubSystem getSubSystem(String factoryId, SystemConnection connection)
          STEP 3c.
static SubSystemFactory getSubSystemFactory(String factoryId)
          Miscallenous Helper.
static SubSystem[] getSubSystems(String factoryId)
          STEP 3a.
static SubSystem[] getSubSystems(String factoryId, SystemConnection connection)
          STEP 3b.
static SystemProfileManager getSystemProfileManager()
          Miscallenous Helper.
static SystemRegistry getSystemRegistry()
          STEP 1.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

SystemStartHere

public SystemStartHere()
Method Detail

getSystemRegistry

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

SAME AS: SystemPlugin.getTheSystemRegistry


getConnections

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

SAME AS: getSystemRegistry().getConnections()

See Also:
getConnectionsBySystemType(String)

getConnectionsBySystemType

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

SAME AS: getSystemRegistry().getConnectionsBySystemType(systemType)

Parameters:
systemType - One of the system types defined via system type extension point:
  • "iSeries"
  • "Windows"
  • "z/OS"
  • "Unix"
  • "Linux"
  • "Local"
See Also:
ISystemTypes, SystemRegistry.getConnectionsBySystemType(String)

getConnectionsBySubSystemFactory

public static SystemConnection[] getConnectionsBySubSystemFactory(SubSystemFactory factory)
STEP 2c. Get all connections for your subsystem factory

SAME AS: getSystemRegistry().getConnectionsBySubSystemFactory(factory)

Parameters:
factory - A subsystem factory object.
See Also:
SystemRegistry.getConnectionsBySubSystemFactory(SubSystemFactory), getConnectionsBySubSystemFactory(String)

getConnectionsBySubSystemFactory

public static SystemConnection[] getConnectionsBySubSystemFactory(String factoryId)
STEP 2d. Get all connections for your subsystem factory, identified by factory Id.

SAME AS: getSystemRegistry().getConnectionsBySubSystemFactory(getSubSystemFactory(factoryId))

Parameters:
factoryId - The id of the subsystem factory as given in its plugin.xml id attribute for the subsystemfactory extension point
See Also:
getSubSystemFactory(String), getConnectionsBySubSystemFactory(SubSystemFactory)

getSubSystems

public static SubSystem[] getSubSystems(String factoryId)
STEP 3a. Get all subsystems for all connections for your subsystem factory, identified by factory Id.

SAME AS: getSystemRegistry().getSubSystems(factoryId)

Parameters:
factoryId - The subsystem factory id as given in its plugin.xml id attribute for the subsystemfactory extension point
See Also:
SystemRegistry.getSubSystems(String), SubSystemFactory.getId()

getSubSystems

public static SubSystem[] getSubSystems(String factoryId,
                                        SystemConnection connection)
STEP 3b. Get all subsystems for the given connection for your subsystem factory, identified by factory Id.

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

Parameters:
factoryId - The subsystem factory id as given in its plugin.xml id attribute for the subsystemfactory extension point
connection - The connection object you wish to get the subsystems for. Typically there is only one subsystem per object.
See Also:
SystemRegistry.getSubSystems(String, SystemConnection), SubSystemFactory.getId()

getSubSystem

public static SubSystem getSubSystem(String factoryId,
                                     SystemConnection connection)
STEP 3c. Same as getSubSystems(String,SystemConnection) by used when you know the subsystem factory only supports a single subsystem per connection.

Parameters:
factoryId - The subsystem factory id as given in its plugin.xml id attribute for the subsystemfactory 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, SystemConnection), SubSystemFactory.getId()

getSubSystemFactory

public static SubSystemFactory getSubSystemFactory(String factoryId)
Miscallenous Helper. Return the subsystem factory object for the given subsystem factory Id

SAME AS: getSystemRegistry().getSubSystemFactory(factoryId)

Parameters:
factoryId - The id of the subsystem factory as given in its plugin.xml id attribute for the subsystemfactory extension point

getSystemProfileManager

public static SystemProfileManager getSystemProfileManager()
Miscallenous Helper. Return singleton profile manager SAME AS: getSystemRegistry().getSystemProfileManager()


getActiveSystemProfiles

public static SystemProfile[] 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()


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.