Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems.impl
Class SubSystemFactoryProxy

java.lang.Object
  extended bycom.ibm.etools.systems.subsystems.impl.SubSystemFactoryProxy
All Implemented Interfaces:
ISubSystemFactoryProxy

public class SubSystemFactoryProxy
extends Object
implements ISubSystemFactoryProxy

Represents a registered subsystem factory extension.


Field Summary
static String copyright
           
 
Constructor Summary
SubSystemFactoryProxy(IConfigurationElement element)
          Constructor
 
Method Summary
 boolean appliesToSystemType(String type)
          Return true if this extension's systemtypes attribute matches the given system type
 boolean equals(Object o)
           
protected  org.osgi.framework.Bundle getBundle()
           
 String getCategory()
          Return the value of the "category" attribute
protected  IConfigurationElement getConfigurationElement()
           
 String getId()
          Return the value of the "id" attribute
 ImageDescriptor getImage()
          Return value of the icon xml attribute.
 ImageDescriptor getLiveImage()
          Return image to use when this susystem is connection.
 String getName()
          Return the value of the "name" attribute
protected  ImageDescriptor getPluginImage(IConfigurationElement element, String fileName)
          Retrieve image in given plugin's directory tree, given its file name.
 SubSystemFactory getSubSystemFactory()
          Return the subsystem factory's object, which is an instance of the class specified in the class attribute of the extender's xml for the factory extension point.
 ISystem getSystemObject()
          Return an instance of the ISystem class identified by the "systemClass" attribute * of this subsystemFactory extension point.
 String[] getSystemTypes()
          Return all defined system types
 String getVendor()
          Return the value of the "vendor" attribute
 int hashCode()
           
 boolean isSubSystemFactoryActive()
          Return true if this subsystem factory has been instantiated yet
 void reset()
          Reset for a full refresh from disk, such as after a team synch.
 void restore()
          After a reset, restore from disk
 boolean supportsAllSystemTypes()
          Return true if this factory supports all system types
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

copyright

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

SubSystemFactoryProxy

public SubSystemFactoryProxy(IConfigurationElement element)
Constructor

Parameters:
element - The IConfigurationElement for this factory's plugin
Method Detail

getVendor

public String getVendor()
Return the value of the "vendor" attribute

Specified by:
getVendor in interface ISubSystemFactoryProxy

getName

public String getName()
Return the value of the "name" attribute

Specified by:
getName in interface ISubSystemFactoryProxy

getId

public String getId()
Return the value of the "id" attribute

Specified by:
getId in interface ISubSystemFactoryProxy

getSystemTypes

public String[] getSystemTypes()
Return all defined system types

Specified by:
getSystemTypes in interface ISubSystemFactoryProxy

supportsAllSystemTypes

public boolean supportsAllSystemTypes()
Return true if this factory supports all system types

Specified by:
supportsAllSystemTypes in interface ISubSystemFactoryProxy

getCategory

public String getCategory()
Return the value of the "category" attribute

Specified by:
getCategory in interface ISubSystemFactoryProxy
See Also:
ISubSystemFactoryCategories

getImage

public ImageDescriptor getImage()
Description copied from interface: ISubSystemFactoryProxy
Return value of the icon xml attribute. Return actual graphics image used for subsystems when there is no live connection.

Specified by:
getImage in interface ISubSystemFactoryProxy

getLiveImage

public ImageDescriptor getLiveImage()
Return image to use when this susystem is connection. Comes from icon attribute in extension point xml

Specified by:
getLiveImage in interface ISubSystemFactoryProxy

appliesToSystemType

public boolean appliesToSystemType(String type)
Return true if this extension's systemtypes attribute matches the given system type

Specified by:
appliesToSystemType in interface ISubSystemFactoryProxy

getPluginImage

protected ImageDescriptor getPluginImage(IConfigurationElement element,
                                         String fileName)
Retrieve image in given plugin's directory tree, given its file name. The file name should be relatively qualified with the subdir containing it.


isSubSystemFactoryActive

public boolean isSubSystemFactoryActive()
Return true if this subsystem factory has been instantiated yet. * Use this when you want to avoid the side effect of starting the subsystem factory object.

Specified by:
isSubSystemFactoryActive in interface ISubSystemFactoryProxy

getSubSystemFactory

public SubSystemFactory getSubSystemFactory()
Return the subsystem factory's object, which is an instance of the class specified in the class attribute of the extender's xml for the factory extension point. The object is only instantiated once, and returned on each call to this.

Specified by:
getSubSystemFactory in interface ISubSystemFactoryProxy

getSystemObject

public ISystem getSystemObject()
Return an instance of the ISystem class identified by the "systemClass" attribute * of this subsystemFactory extension point. Note each call to this method returns a * new instance of the class, or null if no "systemClass" attribute was specified.

Specified by:
getSystemObject in interface ISubSystemFactoryProxy

reset

public void reset()
Reset for a full refresh from disk, such as after a team synch.

Specified by:
reset in interface ISubSystemFactoryProxy

restore

public void restore()
After a reset, restore from disk

Specified by:
restore in interface ISubSystemFactoryProxy

getConfigurationElement

protected IConfigurationElement getConfigurationElement()

getBundle

protected org.osgi.framework.Bundle getBundle()

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

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.