com.tivoli.twg.snmp
Class TWGSNMPDevice

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGObject
      extended bycom.tivoli.twg.engine.TWGPersistentObject
          extended bycom.tivoli.twg.engine.TWGManagedObject
              extended bycom.tivoli.twg.snmp.TWGSNMPDevice
All Implemented Interfaces:
TWGBaseShadowedObject, TWGGetSetDescInterface, TWGGetSetInterface, TWGManagedObjectLifeCycleListener, TWGPersistentObjectSubclassRestorable, TWGShadowedObject
Direct Known Subclasses:
TWGRMONDevice

public class TWGSNMPDevice
extends TWGManagedObject
implements TWGManagedObjectLifeCycleListener

This class represents a base level SNMP Device. This is the class that all other TWGSNMPxxxx device types are derived from. It represents the existance of an SNMP agent at a particular IP address, and the existance of at least part of MIB II.

See Also:
SNMP, SNMPContext, SNMPPDU, SNMPEntity

Field Summary
static java.lang.String CLASSNAME
           
protected static com.tivoli.twg.snmp.TWGSNMPDeviceTracker deviceTracker
           
protected static com.tivoli.twg.snmp.SNMPDisc Engine
           
protected static SNMP Stack
           
 
Fields inherited from class com.tivoli.twg.engine.TWGManagedObject
CLIENT_SERVICE_NOT_SUPPORTED, CLIENT_SERVICE_START_FAILED, CLIENT_SERVICE_START_SUCCEEDED, CLIENT_SERVICE_STOP_FAILED, CLIENT_SERVICE_STOP_SUCCEEDED, MO_SHADOW_ATTRIB_FLAGS_OFF, MO_SHADOW_CNTTASK_OFF, MO_SHADOW_HDRLEN, MO_SHADOW_HDRLEN_001, MO_SHADOW_HDRLEN_OFF, MO_SHADOW_IMGSET_OFF, MO_SHADOW_OFFNAME_OFF, MO_SHADOW_OFFTASK_OFF, MO_SHADOW_PINGINT_OFF, MO_SHADOW_STATE_OFF, MOSTATE_ERROR_OFFLINE, MOSTATE_ERROR_ONLINE, MOSTATE_INDETERMINATE, MOSTATE_INVALID_OBJECT, MOSTATE_NORMAL_OFFLINE, MOSTATE_NORMAL_ONLINE, MOSTATE_UNKNOWN, MOSTATE_UNLICENSED, SHADOWCLASSNAME
 
Fields inherited from class com.tivoli.twg.engine.TWGPersistentObject
CLASS_NAME, SIZEOF_BYTE, SIZEOF_CHAR, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_INT, SIZEOF_LONG, SIZEOF_SHORT
 
Constructor Summary
TWGSNMPDevice()
          INTERNAL USE ONLY Construct A TWGSNMPDevice instance into the system.
TWGSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks, com.tivoli.twg.snmp.SNMPDeviceData deviceData)
          Construct A TWGSNMPDevice instance into the system.
TWGSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks, java.lang.String context, int subNet)
          Deprecated. Use one of the above
TWGSNMPDevice(java.lang.String address, java.lang.String context, int subNet)
          Construct a TWGSNMPDevice instance into the system.
 
Method Summary
protected  void advanceCurrentAddressInUse()
          Increment the index of the current address in use
protected static TWGSNMPDevice CheckAdd(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks, com.tivoli.twg.snmp.SNMPDeviceData deviceData)
          Check for the object passed in.
protected  void copyTo(TWGManagedObject managedObject)
          Copy instance data to another managed object.
 void Delete()
          INTERNAL USE ONLY Destructor for TWGSNMPDevice: remove object from lists
 void Destroy()
          INTERNAL USE ONLY Destroy for TWGSNMPDevice: send delete to NetMgr
static void DiscoveryStart()
          INTERNAL USE ONLY
protected static boolean exists(byte[] engineID)
          Check to see if a particular address is already known.
 java.lang.String GetAddress()
          Query the IP address of this SNMP Device.
 com.tivoli.twg.snmp.SNMPAddressBlock[] GetAddressList()
          Query the IP address list of this SNMP Device.
 java.lang.String getAttributeDescription(java.lang.String id, java.util.Locale loc)
          Get description string for given attribute in given locale
 java.lang.String[] getAttributeIDList()
          Attribute ID enumeration : this method is expected to return a List of strings containing the String names of the attributes supported for a given object.
 int getAttributeType(java.lang.String id)
          Get type of attribute value for given attribute
 DataValue getAttributeValue(java.lang.String id, java.util.Locale loc)
          Get value of attribute with given ID
 java.lang.String getAttributeValueString(java.lang.String id, java.util.Locale loc)
          Get descriptive value string for given attribute in given locale.
 java.lang.String GetContext()
          Query the Context (Community Name) of this SNMP Device.
static long GetCount()
          Deprecated. use TWGSNMPDeviceObjectFactory.getManagedObjectSetAsIds
static TWGSNMPDevice GetDeviceFromID(long ID)
          Locate the instance of an SNMP Device by Object ID.
 long GetDeviceID()
          Used to retrieve the Object ID assigned to this object by Director.
 byte[] getEngineID()
          Query the SnmpEngineID of this SNMP Device.
 com.tivoli.twg.engine.TWGManagedObjectFingerprint getFingerprint()
          Get fingerprint.
 byte[] getOurAddressEntryRecord()
          INTERNAL USE ONLY
protected static TWGSNMPDevice GetSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
          Locate the instance of an SNMP Device by its address.
static TWGSNMPDevice GetSNMPDevice(java.lang.String address)
          Deprecated.  
protected static int getSNMPDeviceID(byte[] engineID)
          Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it.
protected static int GetSNMPDeviceID(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
          Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it.
protected static int GetSNMPDeviceID(java.lang.String address)
          Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it.
static com.tivoli.twg.snmp.SNMPDisc GetSNMPDiscEngine()
          INTERNAL USE ONLY
static SNMP GetSNMPStack()
          Acquire a reference to an instance of the default SNMP stack in use by this JVM.
 void GetSubNetMask()
          Deprecated. Does nothing
 java.lang.String GetTitle()
          Return the title used for this SNMP Device
 int getVersion()
          Get the SNMP version for this device
static boolean Initialize()
          INTERNAL USE ONLY
 boolean isEncryptionEnabled()
          Test if managed object 'encryption enabled' flag is set
 boolean IsIP()
          Deprecated. always returns true
 void managedObjectChanged(TWGManagedObject managedObject, int reason)
          Implemented method as part of the TWGManagedObjectLifeCycleListener
 void managedObjectCreated(TWGManagedObject managedObject)
          Implemented method as part of the TWGManagedObjectLifeCycleListener
 void managedObjectDestroyed(TWGManagedObject managedObject)
          Implemented method as part of the TWGManagedObjectLifeCycleListener
protected  void PingStatusChange(boolean responded)
          INTERNAL USE ONLY
protected  void restoreData(TWGPersistentObjectDictionary dictionary, boolean resolveObjectReferences)
          INTERNAL USE ONLY Method for restoring persistent object data.
protected  void saveData(TWGPersistentObjectDictionary dictionary)
          INTERNAL USE ONLY Method for saving persistent object data.
protected  boolean SetAddressList(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
          Change the IP address list of this SNMP Device.
 boolean setAttributeValue(java.lang.String id, DataValue val)
          Set value of attribute with given ID
 boolean SetContext(java.lang.String context)
          Change the Context (Community Name) of this SNMP Device.
 void SetObjectID(long oid)
          INTERNAL USE ONLY
 int SetPingRetries(int retries)
          Deprecated. Does nothing, always returns zero
 int SetPingTimeout(int timeout)
          Deprecated. Does nothing, always returns zero
 void SetSubnetMask(int mask)
          Deprecated. Does nothing
 void SetSubnetMask(java.lang.String mask)
          Deprecated. Does nothing
 void SetTitle(java.lang.String title)
          Set the title used for this SNMP Device
protected  boolean setVersion(int newVersion)
          Set the SNMP version for this device.
static void ShutDown()
          INTERNAL USE ONLY
 boolean startPing()
          Start a ping on this SNMP Device.
 boolean startPingWithReauthenticate()
          Default ping with reauthenticate method for SNMP device.
 java.lang.String SubnetMask()
          Deprecated. Does nothing, always returns null
 int SubnetMaskRaw()
          Deprecated. always returns zero
 
Methods inherited from class com.tivoli.twg.engine.TWGManagedObject
AddClientService, addDatabaseRecord, addTask, addTask, categorizedManagedObjectIDs, clearPingInterval, ClientServiceStart, ClientServiceStart, ClientServiceStop, ClientServiceStop, containsTask, containsTask, deregisterNewOSListener, FindByAttributeValue, FindByAttributeValue, getAddressEntryRecord, getAddressEntryShadowClass, getAgentPingInterval, getAgentTimezoneOffset, getAllManagedObjectIDs, getAllManagedObjects, GetClientServices, GetConShadowClass, getDatabaseList, getEventCorrelator, getImageSet, getLicenseVersionRequired, getManagedObjectByID, getManagedObjectsSupportingClientService, getMof, getName, getOEMID, getPinger, getPingInterval, getPingInterval, getPingType, GetShadowRecord, GetShadowVersion, getState, getTaskListAsIds, getTaskListSize, initializeRestoredLicenses, initializeRestoredStatusGroups, ipAddressChangeNotify, isAccessDenied, isAccessRequestSupported, isAttribFlagSet, isClientSecureSupported, IsClientServiceSupported, isClientUnsecure, isConsoleDeletable, isConsoleRenamable, isPowerdownSupported, isRestartSupported, isServerMO, isShutdownSupported, isTMADetectable, isTMADetected, isWakeOnLANSupported, licenseGranted, licenseRequired, ObjectAddressEntryChangeNotify, ObjectChangedNotify, ObjectCreateNotify, ObjectDestroyNotify, ObjectStateChangeNotify, proce ssGrantRevokeLicense, registerClientServiceSubscriber, registerIPAddressChangeListener, RegisterLifeCycleListener, registerNewOSListener, RegisterStateListener, reissueLicenses, removeAllTaskAssociations, removeAllTaskAssociations, RemoveClientService, removeTask, removeTask, ReplaceClientServiceList, reportOSTypeAndVersion, requestAccess, requestClientSecure, requestPowerdown, requestRestart, requestShutdown, requestWakeOnLAN, saveAndUpdateIfNeeded, setAccessDenied, setAccessRequestSupported, setAgentPingInterval, setAgentTimezoneOffset, setAsServerMO, setClientSecureSupported, setClientUnsecureFlag, setConsoleDeletable, setConsoleRenamable, setEncryptionEnabled, setEventCorrelator, setImageSet, setName, setOEMID, setPinger, setPingInterval, setPowerdownSupported, setRestartSupported, setShutdownSupported, setState, setTMADetectable, setTMADetected, setWakeOnLANSupported, startPing, startPing, synchronizedObjectWithDatabase, toString, unregisterClientServiceSubscriber, unregisterIPAddressChangeListener, UnregisterLifeCycleListener, UnregisterStateListener, updateNameInDatabaseRecord, UpdateShadowVersion, updateStateInDatabaseRecord
 
Methods inherited from class com.tivoli.twg.engine.TWGPersistentObject
enableAsyncWrites, fromPersistID, initialize, isNewPersistentStore, isSaveRequired, PersistID, restore, restoreAll, save, save, setSaveRequired, terminate, toPersistID
 
Methods inherited from class com.tivoli.twg.engine.TWGObject
AllObjects, AllObjects, DumpTWGObjects, FindObject, isDeleted, isNewObject, isPersistent, isPersistent, isValid, isValid, ObjectID, setDistinctObjectID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
See Also:
Constant Field Values

deviceTracker

protected static com.tivoli.twg.snmp.TWGSNMPDeviceTracker deviceTracker

Stack

protected static SNMP Stack

Engine

protected static com.tivoli.twg.snmp.SNMPDisc Engine
Constructor Detail

TWGSNMPDevice

public TWGSNMPDevice(java.lang.String address,
                     java.lang.String context,
                     int subNet)
Construct a TWGSNMPDevice instance into the system. This usually occurs as a result of information obtained from the IP discovery process.

Parameters:
address - An IP address, in string format.
context - An SNMP V1 Community name.
subNet - The subnet on which this device exists.

TWGSNMPDevice

public TWGSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks,
                     com.tivoli.twg.snmp.SNMPDeviceData deviceData)
Construct A TWGSNMPDevice instance into the system. This usually occurs as the result of information obtained from the IP discovery process. This version of the constructor was added for version 4.2 in support of SNMP versioning.

Parameters:
addressBlocks - An array of addressing information.

TWGSNMPDevice

public TWGSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks,
                     java.lang.String context,
                     int subNet)
Deprecated. Use one of the above

Construct A TWGSNMPDevice instance into the system. This usually occurs as the result of information obtained from the IP discovery process. This version of the constructor was added for version 3.1 in support of Multi-homed devices. As such, it takes an array of addresses, as opposed to the single address used in previous versions of this class.

Parameters:
addressBlocks - An array of addressing information.
context - An SNMP V1 Community name.
subNet - The subnet on which this device exists.

TWGSNMPDevice

public TWGSNMPDevice()
INTERNAL USE ONLY Construct A TWGSNMPDevice instance into the system. This will occur ONLY at system restart, and will be used to rebuild objects we already knew about.

Method Detail

managedObjectCreated

public void managedObjectCreated(TWGManagedObject managedObject)
Implemented method as part of the TWGManagedObjectLifeCycleListener

Specified by:
managedObjectCreated in interface TWGManagedObjectLifeCycleListener
Parameters:
managedObject - - Reference to newly created TWGManagedObject
See Also:
TWGManagedObjectLifeCycleListener

managedObjectDestroyed

public void managedObjectDestroyed(TWGManagedObject managedObject)
Implemented method as part of the TWGManagedObjectLifeCycleListener

Specified by:
managedObjectDestroyed in interface TWGManagedObjectLifeCycleListener
Parameters:
managedObject - - Reference to TWGManagedObject to be deleted
See Also:
TWGManagedObjectLifeCycleListener

managedObjectChanged

public void managedObjectChanged(TWGManagedObject managedObject,
                                 int reason)
Implemented method as part of the TWGManagedObjectLifeCycleListener

Specified by:
managedObjectChanged in interface TWGManagedObjectLifeCycleListener
Parameters:
managedObject - - Reference to modified TWGManagedObject
reason - - reason for change notification
See Also:
TWGManagedObjectLifeCycleListener

IsIP

public boolean IsIP()
Deprecated. always returns true

Used to determine if this device is an IP based device.

Returns:
boolean Returns true if this is IP, false if not.

copyTo

protected void copyTo(TWGManagedObject managedObject)
Copy instance data to another managed object.

Overrides:
copyTo in class TWGManagedObject
Parameters:
managedObject - target managed object.

SetObjectID

public void SetObjectID(long oid)
                 throws DuplicateObjectIDException
INTERNAL USE ONLY

Overrides:
SetObjectID in class TWGManagedObject
Parameters:
oid - - new object ID, or INVALID_OBJECT_ID if none
Throws:
DuplicateObjectIDException - if ID is duplicate

GetDeviceID

public final long GetDeviceID()
Used to retrieve the Object ID assigned to this object by Director.

Returns:
long The Director assigned Object ID for this SNMP Device.

Initialize

public static final boolean Initialize()
                                throws TWGSNMPException
INTERNAL USE ONLY

Throws:
TWGSNMPException

DiscoveryStart

public static final void DiscoveryStart()
                                 throws TWGSNMPException
INTERNAL USE ONLY

Throws:
TWGSNMPException

ShutDown

public static final void ShutDown()
INTERNAL USE ONLY


GetTitle

public final java.lang.String GetTitle()
Return the title used for this SNMP Device

Returns:
String The title used to represent this SNMP Device throughout the system.

SetTitle

public final void SetTitle(java.lang.String title)
Set the title used for this SNMP Device

Parameters:
title - The new title to use when representing this SNMP Device throughout the system.

GetSNMPStack

public static final SNMP GetSNMPStack()
Acquire a reference to an instance of the default SNMP stack in use by this JVM.

Returns:
SNMP The default stack being used in this JVM.

GetSNMPDiscEngine

public static final com.tivoli.twg.snmp.SNMPDisc GetSNMPDiscEngine()
INTERNAL USE ONLY


startPing

public boolean startPing()
Start a ping on this SNMP Device. Changes in the state of this device, that might result from this ping action can be captured by listening to the state changes of this instance.

Overrides:
startPing in class TWGManagedObject
Returns:
false for ping failure

startPingWithReauthenticate

public boolean startPingWithReauthenticate()
Default ping with reauthenticate method for SNMP device. If not overridden, just calls SNMP device's startPing method which may have been overridden.

Overrides:
startPingWithReauthenticate in class TWGManagedObject
Returns:
TRUE: Ping function supported. FALSE: Function not supported for this instance.

GetSubNetMask

public final void GetSubNetMask()
Deprecated. Does nothing

Starts a request to refresh the Sub-Net mask for this device. This is an asyncronous operation, and may take a while to complete.


SetPingRetries

public final int SetPingRetries(int retries)
Deprecated. Does nothing, always returns zero

Sets the number of retries to be attempted on a Ping request.

Parameters:
retries - the new retry count
Returns:
int The newly set retry count.

SetPingTimeout

public final int SetPingTimeout(int timeout)
Deprecated. Does nothing, always returns zero

Sets the timeout to apply to each ping attempt.

Parameters:
timeout - the new Ping timeout value, in Msecs
Returns:
int The newly set timeout value.

PingStatusChange

protected final void PingStatusChange(boolean responded)
INTERNAL USE ONLY


GetCount

public static long GetCount()
Deprecated. use TWGSNMPDeviceObjectFactory.getManagedObjectSetAsIds

Query the number of SNMPDevices known to Director.

Returns:
always 0

exists

protected static boolean exists(byte[] engineID)
Check to see if a particular address is already known.

Parameters:
engineID - snmpEngineID of device
Returns:
true if device exists, false otherwise

GetSNMPDeviceID

protected static int GetSNMPDeviceID(java.lang.String address)
Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it. Note this method is not very accurate. It will return the first device that matches the given address. This is not necessarily the correct one.

Parameters:
address - a dotted decimal version of an IP address
Returns:
int the object ID assigned to this device.

GetSNMPDeviceID

protected static int GetSNMPDeviceID(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it. Note this method is not very accurate. It will return the first device that matches the given addresses. This is not necessarily the correct one.

Parameters:
addressBlocks - address block array
Returns:
int the object ID assigned to this device.

getSNMPDeviceID

protected static int getSNMPDeviceID(byte[] engineID)
Check to see if a particular address is an SNMP Device, and if so, what device ID has been assigned to it.

Parameters:
engineID - snmpEngineID of device
Returns:
int the Object ID assigned to this device

CheckAdd

protected static final TWGSNMPDevice CheckAdd(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks,
                                              com.tivoli.twg.snmp.SNMPDeviceData deviceData)
Check for the object passed in. If new, create a new one. Otherwise update existing object.

Parameters:
addressBlocks - array of SNMPAddressBlocks containing address information
Returns:
new TWGSNMPDevice object or existing one.

GetSNMPDevice

public static TWGSNMPDevice GetSNMPDevice(java.lang.String address)
Deprecated.  

This is not an accurate way to lookup SNMP devices. Use GetDeviceFromID instead. It now always returns null.


GetSNMPDevice

protected static TWGSNMPDevice GetSNMPDevice(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
Locate the instance of an SNMP Device by its address.

Parameters:
addressBlocks -
Returns:
TWGSNMPDevice A valid reference to the device, or null, if it doesn't exist.

GetDeviceFromID

public static TWGSNMPDevice GetDeviceFromID(long ID)
Locate the instance of an SNMP Device by Object ID.

Parameters:
ID - a managed object identifier
Returns:
TWGSNMPDevice A valid reference to the device, or null, if it doesn't exist.

GetAddress

public java.lang.String GetAddress()
Query the IP address of this SNMP Device.

Returns:
String The IP address of this SNMP Device.

advanceCurrentAddressInUse

protected void advanceCurrentAddressInUse()
Increment the index of the current address in use


GetAddressList

public com.tivoli.twg.snmp.SNMPAddressBlock[] GetAddressList()
Query the IP address list of this SNMP Device.

Returns:
SNMPAddressBlock[] The IP addresses of this SNMP Device.

SetAddressList

protected boolean SetAddressList(com.tivoli.twg.snmp.SNMPAddressBlock[] addressBlocks)
Change the IP address list of this SNMP Device.

Parameters:
addressBlocks -
Returns:
whether the set was successful

getVersion

public int getVersion()
Get the SNMP version for this device

Returns:
the SNMP version

setVersion

protected boolean setVersion(int newVersion)
Set the SNMP version for this device.


GetContext

public java.lang.String GetContext()
Query the Context (Community Name) of this SNMP Device.

Returns:
String The Context (Community Name) of this SNMP Device.

SetContext

public boolean SetContext(java.lang.String context)
Change the Context (Community Name) of this SNMP Device.

Parameters:
context - the new context (Community Name) for this SNMP Device
Returns:
boolean Returns true if the new context was successfully set.

getEngineID

public byte[] getEngineID()
Query the SnmpEngineID of this SNMP Device.

Returns:
byte array of the engine ID

SubnetMaskRaw

public final int SubnetMaskRaw()
Deprecated. always returns zero

This method will return the current subnet in its raw (integer) format. (ONLY valid for IP devices)

Returns:
int The subnet for this SNMP Device.

SubnetMask

public final java.lang.String SubnetMask()
Deprecated. Does nothing, always returns null

This method will return the current subnet in its string format. (ONLY valid for IP devices)

Returns:
String The subnet for this SNMP Device.

SetSubnetMask

public final void SetSubnetMask(int mask)
Deprecated. Does nothing

Set the subnet for this SNMP Device. This is generally only used by the Discovery engine in Director, but is supplied to allow for overriding those results. (ONLY valid for IP devices)

Parameters:
mask - int New Sub-net to store for this SNMP Device

SetSubnetMask

public final void SetSubnetMask(java.lang.String mask)
Deprecated. Does nothing

Set the subnet for this SNMP Device. This is generally only used by the Discovery engine in Director, but is supplied to allow for overriding those results. (ONLY valid for IP devices)

Parameters:
mask - int New Sub-net to store for this SNMP Device

saveData

protected void saveData(TWGPersistentObjectDictionary dictionary)
                 throws TWGPersistentObjectSaveException
INTERNAL USE ONLY Method for saving persistent object data.

Overrides:
saveData in class TWGManagedObject
Parameters:
dictionary - used to collect persistent object.
Throws:
TWGPersistentObjectSaveException - thrown to abort save procedure.

restoreData

protected void restoreData(TWGPersistentObjectDictionary dictionary,
                           boolean resolveObjectReferences)
                    throws TWGPersistentObjectRestoreException
INTERNAL USE ONLY Method for restoring persistent object data.

Overrides:
restoreData in class TWGManagedObject
Parameters:
dictionary - used to restore persistent object.
resolveObjectReferences - used to indicate if object references should be resolved during restore.
Throws:
TWGPersistentObjectRestoreException - thrown to abort restore procedure.

Delete

public void Delete()
INTERNAL USE ONLY Destructor for TWGSNMPDevice: remove object from lists

Overrides:
Delete in class TWGManagedObject

Destroy

public void Destroy()
             throws TWGObjectDestroyException
INTERNAL USE ONLY Destroy for TWGSNMPDevice: send delete to NetMgr

Overrides:
Destroy in class TWGManagedObject
Throws:
TWGObjectDestroyException - if error during destroy

getAttributeIDList

public java.lang.String[] getAttributeIDList()
Attribute ID enumeration : this method is expected to return a List of strings containing the String names of the attributes supported for a given object. Subclasses of base classes implementing the interface should report additional attributes by adding them to the list returned by the base class.

Specified by:
getAttributeIDList in interface TWGGetSetInterface
Overrides:
getAttributeIDList in class TWGManagedObject

getAttributeValue

public DataValue getAttributeValue(java.lang.String id,
                                   java.util.Locale loc)
Get value of attribute with given ID

Specified by:
getAttributeValue in interface TWGGetSetInterface
Overrides:
getAttributeValue in class TWGManagedObject
Parameters:
id - - attribute ID requested
loc - - locale to use for value, if applicable
Returns:
value object, or null if no value

setAttributeValue

public boolean setAttributeValue(java.lang.String id,
                                 DataValue val)
Set value of attribute with given ID

Specified by:
setAttributeValue in interface TWGGetSetInterface
Overrides:
setAttributeValue in class TWGManagedObject
Parameters:
id - - attribute ID to be set
val - - attribute value to be set
Returns:
true if set successful, false if not successful

getAttributeType

public int getAttributeType(java.lang.String id)
Get type of attribute value for given attribute

Specified by:
getAttributeType in interface TWGGetSetInterface
Overrides:
getAttributeType in class TWGManagedObject
Parameters:
id - - attribute ID
Returns:
DataValue type of attribute, or DataValue.NONE_TYPE if undefined

getAttributeDescription

public java.lang.String getAttributeDescription(java.lang.String id,
                                                java.util.Locale loc)
Get description string for given attribute in given locale

Specified by:
getAttributeDescription in interface TWGGetSetDescInterface
Overrides:
getAttributeDescription in class TWGManagedObject
Parameters:
id - - attribute ID
loc - - locale to use for description
Returns:
description string, or null if not available

getAttributeValueString

public java.lang.String getAttributeValueString(java.lang.String id,
                                                java.util.Locale loc)
Get descriptive value string for given attribute in given locale.

Specified by:
getAttributeValueString in interface TWGGetSetDescInterface
Overrides:
getAttributeValueString in class TWGManagedObject
Parameters:
id - - attribute ID
loc - - locale to use for description
Returns:
descriptive string for attribute value, or null if not available

isEncryptionEnabled

public boolean isEncryptionEnabled()
Test if managed object 'encryption enabled' flag is set

Overrides:
isEncryptionEnabled in class TWGManagedObject
Returns:
true if encryption enabled is set

getFingerprint

public com.tivoli.twg.engine.TWGManagedObjectFingerprint getFingerprint()
Get fingerprint.

Overrides:
getFingerprint in class TWGManagedObject
Returns:
TWGManagedObjectFingerprint

getOurAddressEntryRecord

public byte[] getOurAddressEntryRecord()
INTERNAL USE ONLY

Returns: