AdventNet Web NMS 4 API Specification

com.adventnet.management.config.ftp
Class FTPAttributeEvent

java.lang.Object
  |
  +--com.adventnet.management.config.AttributeEvent
        |
        +--com.adventnet.management.config.ftp.FTPAttributeEvent
All Implemented Interfaces:
java.io.Serializable

public class FTPAttributeEvent
extends AttributeEvent

This event indicates that a FTPAttribute has been configured over a FTPDevice. Registered Listeners will be notified with these events for each attribute defined in a ConfigTask . Listeners can be registered with the ConfigServer through DeviceConfigurationAPI. AttributeEvent will be generated and notified for each retry of attribute on the device.

See Also:
ConfigTask, FTPAttribute, DeviceConfigurationAPI.registerTaskListener(String, ConfigTaskListener), Serialized Form

Constructor Summary
FTPAttributeEvent(java.lang.String taskName, java.lang.String subTaskName, java.lang.String deviceName, java.lang.String attribute, int errorCode, java.lang.String status)
          Creates an AttributeEvent of type GROUP_ATTRIBUTE.
FTPAttributeEvent(java.lang.String taskName, java.lang.String subTaskName, java.lang.String deviceName, java.lang.String identifier, java.lang.String label, java.lang.String value, int errorCode, java.lang.String status, boolean endOfRetry)
          Creates an AttributeEvent of type SCALAR_ATTRIBUTE.
 
Methods inherited from class com.adventnet.management.config.AttributeEvent
getAttribute, getAttributeType, getDeviceName, getGroupEvents, getLabel, getMessage, getStatus, getSubTaskName, getTaskName, getValue, isEndOfRetry, setAttributeType, setGroupEvents, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FTPAttributeEvent

public FTPAttributeEvent(java.lang.String taskName,
                         java.lang.String subTaskName,
                         java.lang.String deviceName,
                         java.lang.String attribute,
                         int errorCode,
                         java.lang.String status)
Creates an AttributeEvent of type GROUP_ATTRIBUTE. If the configured attribute is of type GROUP_ATTRIBUTE, then the FTPAttributeEvent for the child attributes can be get from getGroupEvents()
Parameters:
taskName - name of the task to which this attribute belongs.
subTaskName - name of the subtask in a CombinedTask.
deviceName - name of the configured device.
attribute - name of the command( GET or PUT ) .
errorcode - status of configuration for this attribute.
status - result of configuration for this attribute.

FTPAttributeEvent

public FTPAttributeEvent(java.lang.String taskName,
                         java.lang.String subTaskName,
                         java.lang.String deviceName,
                         java.lang.String identifier,
                         java.lang.String label,
                         java.lang.String value,
                         int errorCode,
                         java.lang.String status,
                         boolean endOfRetry)
Creates an AttributeEvent of type SCALAR_ATTRIBUTE.
Parameters:
taskName - name of the task to which this attribute belongs.
subTaskName - name of the subtask in a CombinedTask.
deviceName - name of the configured device.
identifier - name of the command ( GET or PUT)
label - label of the configured attribute.
value - source file name of the FTP Transfer.
errorCode - status of configuration for this attribute.
status - result of configuration for this attribute.
endOfRetry - denotes end of retries.

AdventNet Web NMS 4 API Specification