com.adventnet.nms.extranet.remote.communication.fw
Interface SPPRegionalCommIfc

public interface SPPRegionalCommIfc

To provide flexibility of using any communication protocol between Central Server and DMS, necessary methods have been provided in this interface. To customize the communication channel between the Central Server and DMS (other than HTTP, HTTPS and TCP), the class must implement this interface. The implementing class must have the intelligence to handle read and write operations according to the protocol used. By default, implementation for some standard protocols like HTTP, HTTPS, and TCP, is provided.

Method Summary

boolean	initialize(java.util.Properties args) Initializes setting up of communication channel between Central Server and DMS.
DataObject	read() This method receives data from the other end of the communication channel.
void	shutdown() Shutdown notification is given to the method to take necessary actions.
DataObject	write(DataObject dataObject) This method sends data to the other end of the communication channel.

Method Detail

initialize

public boolean initialize(java.util.Properties args)
                   throws CommunicationException

Initializes setting up of communication channel between Central Server and DMS.

Parameters:

args - parameters required to initialize.

Returns:

status (true/false) of the initialization process.

Throws:

CommunicationException - if any error.

write

public DataObject write(DataObject dataObject)
                 throws CommunicationException

This method sends data to the other end of the communication channel.

Parameters:

data - the data to transfered to the other end.

Returns:

status (true/false) of the write operation.

Throws:

CommunicationException - if any error in sending data to the other end.

See Also:

read()

read

public DataObject read()
                throws CommunicationException

This method receives data from the other end of the communication channel.

Returns:

read data as DataObject.

Throws:

CommunicationException - if any error in reading data.

See Also:

write(DataObject)

shutdown

public void shutdown()
              throws CommunicationException

Shutdown notification is given to the method to take necessary actions.

Throws:

CommunicationException - if any error in doing shutdown operation.