com.adventnet.management.config.tl1
Class TL1ConfigProvider

java.lang.Object
  |
  +--com.adventnet.management.config.ConfigProvider
        |
        +--com.adventnet.management.config.tl1.TL1ConfigProvider

public class TL1ConfigProvider

extends ConfigProvider

This class does configuration of devices through TL1.

Since:

Web NMS 2.3

Fields inherited from class com.adventnet.management.config.ConfigProvider

configTask, deviceSessionMap, userName

Constructor Summary

TL1ConfigProvider()

Method Summary

AttributeResult[]	configureDevice(java.lang.String taskName, Attribute[] attributes, Device device) Configures various devices through TL1.
AttributeEvent	generateEvent(java.lang.String taskName, java.lang.String subTaskName, Device device, Attribute attribute, AttributeResult result, boolean endOfRetry) Generates an TL1AttributeEvent after configuring each Attribute over a device.
Attribute[]	getCurrentConfiguration(Device device) Uploads configuration from the specified device through TL1.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TL1ConfigProvider

public TL1ConfigProvider()

Method Detail

configureDevice

public AttributeResult[] configureDevice(java.lang.String taskName,
                                         Attribute[] attributes,
                                         Device device)

Configures various devices through TL1. This is called by the ConfigServer once the TL1 task is submitted for execution. ConfigServer removes those attributes which are successfully configured after each retry and pass only the failed attributes for configuration in the next retry.

Overrides:

configureDevice in class ConfigProvider

Following copied from class: com.adventnet.management.config.ConfigProvider

Parameters:

taskName - name of the task in execution.

attributeList - list of the attributes to be configured over a device.

device - name of the device to be configured.

Returns:

an AttributeResult array for the configured attributes.

generateEvent

public AttributeEvent generateEvent(java.lang.String taskName,
                                    java.lang.String subTaskName,
                                    Device device,
                                    Attribute attribute,
                                    AttributeResult result,
                                    boolean endOfRetry)

Generates an TL1AttributeEvent after configuring each Attribute over a device.

Overrides:

generateEvent in class ConfigProvider

Following copied from class: com.adventnet.management.config.ConfigProvider

Parameters:

taskName - name of the task for which the event is to be generated

subTaskName - name of the subtask in a CombinedTask, otherwise null.

device - Device that has been configured.

attribute - Attribute that has been configured over a device.

result - AttributeResult for the configuration.

endOfRetry - specifies whether number of retries set for the device has reached or not.

Returns:

an AttributeEvent for a configured attribute

getCurrentConfiguration

public Attribute[] getCurrentConfiguration(Device device)
                                    throws ConfigException

Uploads configuration from the specified device through TL1. This is same as the execution of TL1 tasks. This implementation can be overridded by specifying the class implementing ConfigurationUpload interface in <Web NMS Home >/conf/configprovider.xml.

Entry will be
<protocol
NAME="tl1"
CONFIGPROVIDER="com.adventnet.management.config.snmp.TL1ConfigProvider"
UPLOAD="<class implementing the ConfigurationUpload Interface>" >
</protocol>

Overrides:

getCurrentConfiguration in class ConfigProvider

Following copied from class: com.adventnet.management.config.ConfigProvider

Parameters:

device - Device for getting the configuration.

Returns:

an Attribute containing the configuration data.

Throws:

ConfigException - if it fails to upload configuration from the device.