com.adventnet.nms.extranet.remote.communication.datacustom
Interface ModuleDataCustomizer

public interface ModuleDataCustomizer

This interface helps in customizing or filtering the data sent from DMS to Central Server or vice versa. If the framework finds an entry of the interface implementation in DataCustomization.xml, then it directs all the data using the getCustomizedData method of the implementation class. This method is used for customization, such as dropping of the data that is not required.To achieve proper customization, the customized data requires handling in the receiving side (Central server) by placing another implementation (here, the implementation is to handle the customized data) of this interface. That is, if customized data is sent from DMS, the customization is completed only if the customized data is handled in the Central Server. To distinguish whether the data is to parse the customization or to customize, a boolean isFromDMS is given to the method as an argument.This boolean is set as true if the data is from DMS to Central Server i.e., Central server side implementation parses the data if the boolean is true. If the boolean is false, it is implied that the data is from Central Server which needs customization before sending to DMS.

Method Summary

DataObject

getCustomizedData(java.lang.String moduleName, DataObject dataObject, boolean isFromDMS) This method returns customized data in DMS and parsed data in Central Server.

Method Detail

getCustomizedData

public DataObject getCustomizedData(java.lang.String moduleName,
                                    DataObject dataObject,
                                    boolean isFromDMS)

This method returns customized data in DMS and parsed data in Central Server.

Parameters:

moduleName - an identifier to know the module of which the data belongs to.

dataObject - the data from or to DMS on which customization can be done.

isFromDMS - a boolean to identify whether the data is from DMS or from Central Server. It will hold true as its value if the data is from DMS and false if the data is from Central Server. By using this flag, one can decide whether the data is to be customized or to be parsed.

Returns:

the data (customized or parsed).