AdventNet WiFi Mediation API, v1.0

com.adventnet.wifi.mediation
Class Device

java.lang.Object
  extended bycom.adventnet.wifi.mediation.Device

public class Device
extends java.lang.Object

Class representing a WLAN Device in the network. Users have to create an instance of this class to communicate with the real device. Ensure to set appropriate credentials (SNMP, CLI etc.,) before configuring or fetching details from the WLAN Device.

See Also:
CLICredentials, SNMPCredentials, MediationAPI

Constructor Summary
Device(java.lang.String name, int vendor, int model)
          Constructs a Device with the specified name, vendor and model.
 
Method Summary
 CLICredentials getCLICredentials()
          Fetches the CLI Credentials of this Device which has been set using setCLICredentials Method.
 java.lang.String getCompatibleFirmwareVersion()
          Used Internally.
 java.lang.String getDeviceName()
          Returns either DNS Name or IP Address which has been set using setDeviceName Method.
 java.lang.String getFirmwareVersion()
          Returns the firmware version of the device which has been assigned using setFirmwareVersion.
 int getModel()
          Returns the model ID for this device.
 SNMPCredentials getSNMPCredentials()
          Fetches the SNMP Credentials of this Device which has been set using setSNMPCredentials Method.
 int getVendor()
          Returns the WLAN Device's Vendor ID.
 void setCLICredentials(CLICredentials CLICredentials)
          Sets the CLI Credentials for this Device.
 void setCompatibleFirmwareVersion(java.lang.String version)
          Used Internally.
 void setFirmwareVersion(java.lang.String version)
          Sets the firmware version of the device.
 void setModel(int model)
          Sets the model ID of this device.
 void setSNMPCredentials(SNMPCredentials snmpCredentials)
          Sets the SNMP credentials for this device.
 void setVendor(int vendor)
          Method to set the WLAN Device's Vendor.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Device

public Device(java.lang.String name,
              int vendor,
              int model)
       throws ModelNotSupportedException
Constructs a Device with the specified name, vendor and model.

Parameters:
name - Represents the DNS Name or IP Address of the device.
vendor - Represents the Manufacturer
model - Represents a particular model from that Vendor.
Throws:
ModelNotSupportedException - throws ModelNotSupportedException when the combination of vendor and model passed as arguments is not in the supported list.
See Also:
VendorConstants
Method Detail

getDeviceName

public java.lang.String getDeviceName()
Returns either DNS Name or IP Address which has been set using setDeviceName Method.

Returns:
the identifier

getVendor

public int getVendor()
Returns the WLAN Device's Vendor ID.

See Also:
VendorConstants

setVendor

public void setVendor(int vendor)
Method to set the WLAN Device's Vendor.

See Also:
VendorConstants

getModel

public int getModel()
Returns the model ID for this device.

See Also:
VendorConstants

setModel

public void setModel(int model)
              throws ModelNotSupportedException
Sets the model ID of this device. Ensure that the vendor is properly set before setting the model. If we try to set the model number without setting the vendor then it may throw ModelNotSupportedException.

Parameters:
model - the model ID of this device
Throws:
ModelNotSupportedException - throws ModelNotSupportedException when the combination of vendor (set via the constructor or via setVendor method) and model passed as argument is not in the supported list.
See Also:
VendorConstants

setSNMPCredentials

public void setSNMPCredentials(SNMPCredentials snmpCredentials)
Sets the SNMP credentials for this device.

Parameters:
snmpCredentials - the SNMP credentials
See Also:
SNMPCredentials

getSNMPCredentials

public SNMPCredentials getSNMPCredentials()
Fetches the SNMP Credentials of this Device which has been set using setSNMPCredentials Method.

Returns:
the SNMP Credentials.
See Also:
SNMPCredentials

setCLICredentials

public void setCLICredentials(CLICredentials CLICredentials)
Sets the CLI Credentials for this Device.

Parameters:
CLICredentials - the CLI Credentials
See Also:
CLICredentials

getCLICredentials

public CLICredentials getCLICredentials()
Fetches the CLI Credentials of this Device which has been set using setCLICredentials Method.

Returns:
the CLI Credentials
See Also:
CLICredentials

getFirmwareVersion

public java.lang.String getFirmwareVersion()
Returns the firmware version of the device which has been assigned using setFirmwareVersion.


setFirmwareVersion

public void setFirmwareVersion(java.lang.String version)
Sets the firmware version of the device.


getCompatibleFirmwareVersion

public java.lang.String getCompatibleFirmwareVersion()
Used Internally.


setCompatibleFirmwareVersion

public void setCompatibleFirmwareVersion(java.lang.String version)
Used Internally.


toString

public java.lang.String toString()

AdventNet WiFi Mediation API, v1.0

Copyright © 2005 AdventNet Inc. All Rights Reserved.