com.ibm.datapower.wamt.amp
Class DeviceMetaInfo

java.lang.Object
  extended by com.ibm.datapower.wamt.amp.DeviceMetaInfo

public class DeviceMetaInfo
extends java.lang.Object

This represents the data that would be returned from Commands.getDeviceMetaInfo(DeviceContext). Objects of this class are automatically instantiated by that getDeviceMetaInfo method.


Field Summary
static java.lang.String COPYRIGHT_2009_2013
           
 
Constructor Summary
DeviceMetaInfo(java.lang.String deviceName, java.lang.String serialNumber, java.lang.String currentAMPVersion, ModelType modelType, java.lang.String hardwareOptions, int guiPort, DeviceType deviceType, java.lang.String firmwareLevel, StringCollection featureLicenses)
          Construct a new DeviceMetaInfo object.
DeviceMetaInfo(java.lang.String deviceName, java.lang.String serialNumber, java.lang.String currentAMPVersion, ModelType modelType, java.lang.String hardwareOptions, int guiPort, DeviceType deviceType, java.lang.String firmwareLevel, StringCollection featureLicenses, int[] supportedCommands)
           
DeviceMetaInfo(java.lang.String deviceName, java.lang.String serialNumber, java.lang.String currentAMPVersion, ModelType modelType, java.lang.String hardwareOptions, int guiPort, DeviceType deviceType, java.lang.String firmwareLevel, StringCollection featureLicenses, int[] supportedCommands, java.lang.String secureBackup)
           
 
Method Summary
 java.lang.String getCurrentAMPVersion()
          Get the current AMP version.
 java.lang.String getDeviceName()
          Get the name of the device.
 DeviceType getDeviceType()
          Get the type of the device.
 StringCollection getFeatureLicenses()
          Get the list features that this device is licensed for.
 java.lang.String getFirmwareLevel()
          Get the level of the firmware that is currently running on the device.
 java.lang.String getHardwareOptions()
          Get the options configured in the Datapower hardware
 ModelType getModelType()
          Get the version of the Datapower hardware
 java.lang.String getSecurebackup()
          Get the status of secure backup.
 java.lang.String getSerialNumber()
          Get the serial number of this device.
 int[] getSupportedCommands()
          Get the list of commands that this device supports.
 int getWebGUIPort()
          Get the port that accepts WebGUI connections.
 java.lang.String toString()
          Get a String representation of this object for the purpose of debugging and tracing.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2013

public static final java.lang.String COPYRIGHT_2009_2013
See Also:
Constant Field Values
Constructor Detail

DeviceMetaInfo

public DeviceMetaInfo(java.lang.String deviceName,
                      java.lang.String serialNumber,
                      java.lang.String currentAMPVersion,
                      ModelType modelType,
                      java.lang.String hardwareOptions,
                      int guiPort,
                      DeviceType deviceType,
                      java.lang.String firmwareLevel,
                      StringCollection featureLicenses)
Construct a new DeviceMetaInfo object. In general this should be invoked only by Commands.getDeviceMetaInfo(DeviceContext).

Parameters:
deviceName - name of the device. This is not the hostname nor the IP address. It is the System Identifier stored in the device. For more information, refer to getDeviceName().
serialNumber - serial number of the device
modelType - version of the Datapower hardware (9002, 9003, etc).
guiPort - the device's port that accepts WebGUI connections
deviceType - the type of the device
featureLicenses - the features that this device is licensed for

DeviceMetaInfo

public DeviceMetaInfo(java.lang.String deviceName,
                      java.lang.String serialNumber,
                      java.lang.String currentAMPVersion,
                      ModelType modelType,
                      java.lang.String hardwareOptions,
                      int guiPort,
                      DeviceType deviceType,
                      java.lang.String firmwareLevel,
                      StringCollection featureLicenses,
                      int[] supportedCommands,
                      java.lang.String secureBackup)

DeviceMetaInfo

public DeviceMetaInfo(java.lang.String deviceName,
                      java.lang.String serialNumber,
                      java.lang.String currentAMPVersion,
                      ModelType modelType,
                      java.lang.String hardwareOptions,
                      int guiPort,
                      DeviceType deviceType,
                      java.lang.String firmwareLevel,
                      StringCollection featureLicenses,
                      int[] supportedCommands)
Method Detail

getSerialNumber

public java.lang.String getSerialNumber()
Get the serial number of this device.

Returns:
the serial number of this device. This will be the device's hardware serial number, not the IP address. This can be treated as an opaque value. It is guaranteed to be unique. It will be used to correlate the source of notifications and to act as a primary key for each device.
See Also:
Notification.getDeviceSerialNumber()

getDeviceName

public java.lang.String getDeviceName()
Get the name of the device.

Returns:
the name of the device. This is not the hostname nor the IP address. It is also independent from Device.getSymbolicName(). It is the System Identifier in the System Settings, which is a symbolic name used for functions like SNMP and is stored on the device.

getModelType

public ModelType getModelType()
Get the version of the Datapower hardware

Returns:
the version of the Datapower hardware

getHardwareOptions

public java.lang.String getHardwareOptions()
Get the options configured in the Datapower hardware

Returns:
the options configured in the Datapower hardware

getWebGUIPort

public int getWebGUIPort()
Get the port that accepts WebGUI connections. If it is equal to -1, the WebGUI is not enabled on the device (or wasn't returned by AMP)

Returns:
the port number that accepts WebGUI connections

getDeviceType

public DeviceType getDeviceType()
Get the type of the device.

Returns:
the type of the device

getFirmwareLevel

public java.lang.String getFirmwareLevel()
Get the level of the firmware that is currently running on the device.

Returns:
the level of the firmware that is currently running on the device. This may not be the same as the level desired by the Manager.

getFeatureLicenses

public StringCollection getFeatureLicenses()
Get the list features that this device is licensed for. If this is null, there are no feature licenses on the device (or none were returned from the AMP call).

Returns:
the list of features that this device is licensed for. Each feature will be a single String.

getSupportedCommands

public int[] getSupportedCommands()
Get the list of commands that this device supports. If this is null, there are no commands supported on the device (or none were returned from the AMP call).

Returns:
the list of commands that this device supports. Each commands will be a single String.

getCurrentAMPVersion

public java.lang.String getCurrentAMPVersion()
Get the current AMP version.

Returns:
the current AMP version that this device supports.

getSecurebackup

public java.lang.String getSecurebackup()
Get the status of secure backup.

Returns:
the status of secure backup (enabled/disabled).

toString

public java.lang.String toString()
Get a String representation of this object for the purpose of debugging and tracing.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object for the purpose of debugging and tracing.


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.