com.tivoli.twg.engine
Class TWGSnapIn

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGSnapIn

public class TWGSnapIn
extends java.lang.Object

This class is a data object used to wrapper the information for a registered snap-in. Each snap-in is composed of a type string, a sub-type string and a class name. The type string is used to represent the type (or category) of snap-in that is being written. For example, there is a pre-defined type of SNAPIN_TYPE_TWG_CIM_INSTANCE_BROWSER that is used for snap-in's that implement TWGCIMInstanceBrowserInterface. The sub-type string is used to represent the type of data that is expected by the snap-in. For example, a snap-in that implements the SNAPIN_TYPE_TWG_CIM_INSTANCE_BROWSER for logical drives would have a sub-type of Win32_LogicalDrive (the name of the CIM class). The class name is the actual name of the class that should be loaded and used as a snap-in. The class should be available from the Director server CLASSPATH, or it will not function correctly.


Field Summary
static java.lang.String SNAPIN_TYPE_TWG_CIM_INSTANCE_BROWSER
          Pre-defined type string for TWGCIMInstanceBrowserInterface snap-in's
static java.lang.String SNAPIN_TYPE_TWG_CIM_PROPERTY_BROWSER
          Pre-defined type string for TWGCIMProperiesBrowserInterface snap-in's
static java.lang.String SNAPIN_TYPE_TWG_CONSOLE_SNAP_IN
          Pre-defined type string for TWGConsoleSnapInImplementor snap-in's
static java.lang.String SNAPIN_TYPE_TWG_DMI_GROUP_BROWSER
          Pre-defined type string for TWGDMIGroupBrowserInterface snap-in's
static java.lang.String SNAPIN_TYPE_TWG_SNMP_INFO_BROWSER
          Pre-defined type string for TWGSNMPInfoBrowserInterface snap-in's
 
Constructor Summary
TWGSnapIn(byte[] flat_data)
          This constructor is used to restore a snap-in object from a flattened byte array.
TWGSnapIn(java.lang.String siType, java.lang.String siSubType, java.lang.String siClassName)
          This constructor is used to build a snap-in object from the type, sub-type and class name.
 
Method Summary
 boolean equals(TWGSnapIn si)
          This method is used to compare two snap-in objects.
 byte[] flatten()
          This method is used to convert the snap-in object to a byte array that can be sent over the transport.
 java.lang.String getClassName()
          This method is used to get the class name data for a snap-in object.
 java.lang.String getSubType()
          This method is used to get the sub-type data for a snap-in object.
 java.lang.String getType()
          This method is used to get the type data for a snap-in object.
 void setClassName(java.lang.String siClassName)
          This method is used to change the class name data for a snap-in object.
 void setSubType(java.lang.String siSubType)
          This method is used to change the sub-type data for a snap-in object.
 void setType(java.lang.String siType)
          This method is used to change the type data for a snap-in object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SNAPIN_TYPE_TWG_CIM_INSTANCE_BROWSER

public static final java.lang.String SNAPIN_TYPE_TWG_CIM_INSTANCE_BROWSER
Pre-defined type string for TWGCIMInstanceBrowserInterface snap-in's

See Also:
Constant Field Values

SNAPIN_TYPE_TWG_CIM_PROPERTY_BROWSER

public static final java.lang.String SNAPIN_TYPE_TWG_CIM_PROPERTY_BROWSER
Pre-defined type string for TWGCIMProperiesBrowserInterface snap-in's

See Also:
Constant Field Values

SNAPIN_TYPE_TWG_DMI_GROUP_BROWSER

public static final java.lang.String SNAPIN_TYPE_TWG_DMI_GROUP_BROWSER
Pre-defined type string for TWGDMIGroupBrowserInterface snap-in's

See Also:
Constant Field Values

SNAPIN_TYPE_TWG_SNMP_INFO_BROWSER

public static final java.lang.String SNAPIN_TYPE_TWG_SNMP_INFO_BROWSER
Pre-defined type string for TWGSNMPInfoBrowserInterface snap-in's

See Also:
Constant Field Values

SNAPIN_TYPE_TWG_CONSOLE_SNAP_IN

public static final java.lang.String SNAPIN_TYPE_TWG_CONSOLE_SNAP_IN
Pre-defined type string for TWGConsoleSnapInImplementor snap-in's

See Also:
Constant Field Values
Constructor Detail

TWGSnapIn

public TWGSnapIn(java.lang.String siType,
                 java.lang.String siSubType,
                 java.lang.String siClassName)
This constructor is used to build a snap-in object from the type, sub-type and class name.


TWGSnapIn

public TWGSnapIn(byte[] flat_data)
This constructor is used to restore a snap-in object from a flattened byte array.

Method Detail

setType

public void setType(java.lang.String siType)
This method is used to change the type data for a snap-in object.


setSubType

public void setSubType(java.lang.String siSubType)
This method is used to change the sub-type data for a snap-in object.


setClassName

public void setClassName(java.lang.String siClassName)
This method is used to change the class name data for a snap-in object.


getType

public java.lang.String getType()
This method is used to get the type data for a snap-in object.


getSubType

public java.lang.String getSubType()
This method is used to get the sub-type data for a snap-in object.


getClassName

public java.lang.String getClassName()
This method is used to get the class name data for a snap-in object.


flatten

public byte[] flatten()
This method is used to convert the snap-in object to a byte array that can be sent over the transport.


equals

public boolean equals(TWGSnapIn si)
This method is used to compare two snap-in objects. Two snap-in objects are equal only if the type, sub-type and class name are all equal.