AdventNet Web NMS 4 DMS API Specification

com.adventnet.nms.extranet.remote.communication.fw
Interface SPPCommInitIfc
public interface SPPCommInitIfc

Implementation of this interface is responsible for initializing communication related modules. Initially, things which are required to establish a communication channel to the other end are expected to be initialized. After the successful initialization of the communication channel, open method should return an instance ofSPPRegionalCommIfc, by which communication operations can be accomplished.


Method Summary
 void init(java.util.Properties args)
          At the start up time, this method helps to initialize all the things required to establish a communication channel to the other end.
 SPPRegionalCommIfc open(java.util.Properties params)
          Creates and returns a new instance of SPPRegionalCommIfc.
 void shutdown()
          Shutdown notification will be given to this method to take necessary actions, like closing all sockets.
 

Method Detail

init

public void init(java.util.Properties args)
          throws CommunicationException
At the start up time, this method helps to initialize all the things required to establish a communication channel to the other end.
Parameters:
args - arguments needed for initialization.
Throws:
CommunicationException - if any error occurs during initialization.

open

public SPPRegionalCommIfc open(java.util.Properties params)
                        throws CommunicationException
Creates and returns a new instance of SPPRegionalCommIfc.
Parameters:
args - the arguments needed for initialization.
Returns:
instance of SPPRegionalCommIfc.
Throws:
CommunicationException - if any error is encountered when establishing communication channel with the other end.

shutdown

public void shutdown()
              throws CommunicationException
Shutdown notification will be given to this method to take necessary actions, like closing all sockets.
Throws:
CommunicationException - if any error during shutdown.

AdventNet Web NMS 4 DMS API Specification