com.adventnet.nms.extranet.remote.communication.fw.fe
Class SPPRegionalCommFE

com.adventnet.nms.extranet.remote.communication.fw.fe.SPPRegionalCommFE

All Implemented Interfaces:

com.adventnet.nms.fe.common.BEFailOverListener

public class SPPRegionalCommFE

implements com.adventnet.nms.fe.common.BEFailOverListener

This class controls the data flow between Central Server and DMS. This class is placed in the Front-end component of the Central Server, which holds methods to transfer data to DMS from Central Server or vice versa. Instance of this class can be accessed by calling SPPRegionalCommFE.getInstance(). In one-way communication mode, as the user has to write a receiving class in his custom communication model, this class is used to transfer data between Central Server and DMS. In two-way communication, the framework provides interfaces on both the sides.

Method Summary

void	deleteBuffer(java.lang.String regionID) After the successful transmission of data to the DMS, data stored in the buffer can be deleted by calling this method.
static com.adventnet.nms.extranet.remote.communication.fw.fe.SPPRegionalCommAPI	getInstance() Returns the reference of this object.
void	postBEFailOverNotification(com.adventnet.nms.fe.common.BEFailOverEvent beFailOverEvent) This is an implementation method of BEFailOverListener, responsible for re-creating communication channel after successful failover operation.
void	preBEFailOverNotification(com.adventnet.nms.fe.common.BEFailOverEvent beFailOverEvent) This is an implementation method of BEFailOverListener, responsible for closing stream sockets when failover is taking place.
void	shutDown() This is an implementation method of SPPRegionalCommAPI, responsible for shutting down the Front End Component when this method is called.
DataObject	transferDataToNOC(DataObject dataObject, java.lang.String regionID) Forwards the data from the DMS to the Back-end component of Central Server.
DataObject	transferDataToReg(java.lang.String regionID) Transfers the data to DMS.

Method Detail

getInstance

public static com.adventnet.nms.extranet.remote.communication.fw.fe.SPPRegionalCommAPI getInstance()

Returns the reference of this object. This class is initialized at server startup time and only one instance is maintained.

Returns:

reference of SPPRegionalCommFE

transferDataToNOC

public DataObject transferDataToNOC(DataObject dataObject,
                                    java.lang.String regionID)
                             throws java.rmi.RemoteException

Forwards the data from the DMS to the Back-end component of Central Server.

Parameters:

dataObject - DataObject that has to be forwarded to the Central Server.

regionID - ID of the DMS.

Returns:

Response from Central Server to the DMS as DataObject.

Throws:

java.rmi.RemoteException - if error while transfering data to Central Server.

transferDataToReg

public DataObject transferDataToReg(java.lang.String regionID)
                             throws java.rmi.RemoteException

Transfers the data to DMS. To transfer data specific to DMS, DMS ID is expected as an argument.

Parameters:

regionID - ID of the DMS.

Returns:

The DataObject that has to be sent to the DMS.

Throws:

java.rmi.RemoteException - if error while transfering data to DMS.

See Also:

deleteBuffer(String)

deleteBuffer

public void deleteBuffer(java.lang.String regionID)

After the successful transmission of data to the DMS, data stored in the buffer can be deleted by calling this method. ID of the DMS has to be given as an argument, so that the data in the buffer is deleted for the particular DMS.

Parameters:

regionID - The ID of the DMS.

See Also:

transferDataToReg(String)

shutDown

public void shutDown()

This is an implementation method of SPPRegionalCommAPI, responsible for shutting down the Front End Component when this method is called. Called internally when shutdown is in progress. Users are recommended not to use this method.

preBEFailOverNotification

public void preBEFailOverNotification(com.adventnet.nms.fe.common.BEFailOverEvent beFailOverEvent)

This is an implementation method of BEFailOverListener, responsible for closing stream sockets when failover is taking place. Called internally to take failover actions and is not intended for general use. Users are recommended not to use this method.

Specified by:

preBEFailOverNotification in interface com.adventnet.nms.fe.common.BEFailOverListener

postBEFailOverNotification

public void postBEFailOverNotification(com.adventnet.nms.fe.common.BEFailOverEvent beFailOverEvent)

This is an implementation method of BEFailOverListener, responsible for re-creating communication channel after successful failover operation. Called internally to take failover actions and is not intended for general use. Users are recommended not to use this method.

Specified by:

postBEFailOverNotification in interface com.adventnet.nms.fe.common.BEFailOverListener