com.adventnet.nms.fe.common
Class BEFailOverEvent

java.lang.Object
  |
  +--com.adventnet.nms.fe.common.BEFailOverEvent

public class BEFailOverEvent

extends java.lang.Object

An event which indicates to the modules in the FE server, about the switch over of the FE server to the standby BE server. This switch over happens when the BE server, to which the FE server is connected, fails and the standby BE server takes over as the primary.

This event is passed to all the BEFailOverListeners by the FE server, both when it has detected the failure of the BE server and after it has successfully reestablished the conection with the current primary BE server.

This event provides information about the failed and the current primary BE servers to the BEFailOverListeners.

Since:

2.3 SP6

See Also:

BEFailOverListener

Constructor Summary

BEFailOverEvent(java.util.Properties previousBEInfo, java.util.Properties presentBEInfo)
Constructs a BEFailOverEvent object with the details about the failed and the current primary BE server.

Method Summary

java.lang.String	getNewBEHost() Returns the host name of the current primary BE server, to which the FE server can establish connection.
int	getNewBEPort() Returns the TCP port number of the current primary BE server, to which the FE server can establish connection.
int	getNewRMIPort() Returns the RMI registry port number of the current primary BE server, to which the FE server can establish connection.
java.lang.String	getOldBEHost() Returns the host name of the failed BE server, to which the FE server was connected.
int	getOldBEPort() Returns the TCP port number of the failed BE server, to which the FE server was connected.
int	getOldRMIPort() Returns the RMI registry port number of the failed BE server, to which the FE server was connected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BEFailOverEvent

public BEFailOverEvent(java.util.Properties previousBEInfo,
                       java.util.Properties presentBEInfo)

Constructs a BEFailOverEvent object with the details about the failed and the current primary BE server. The FE server constructs this object and notifies the BEFailOverListeners.

Parameters:

previousBEInfo - Properties object containing details about the failed BE server

presentBEInfo - Properties object containing details about the current primary BE server

Method Detail

getNewBEPort

public int getNewBEPort()

Returns the TCP port number of the current primary BE server, to which the FE server can establish connection.

When notified through the BEFailOverListener.preBEFailOverNotification(BEFailOverEvent) method, this indicates the TCP port number of the BE server to which the FE server will try to connect. When notified through the BEFailOverListener.postBEFailOverNotification(BEFailOverEvent) method, this indicates the TCP port number of the BE server to which the FE server has established the connection. If the BE and FE servers are communicating in the RMI mode, the result of this method is of no relevance.

Returns:

TCP port number of the current primary BE server, to which the FE server will establish connection or has already established connection. -1 is returned if the TCP port number is not configured, or if an error occurs while trying to get the port number.

getNewRMIPort

public int getNewRMIPort()

Returns the RMI registry port number of the current primary BE server, to which the FE server can establish connection.

When notified through the BEFailOverListener.preBEFailOverNotification(BEFailOverEvent) method, this indicates the RMI registry port number of the BE server to which the FE server will try to connect. When notified through the BEFailOverListener.postBEFailOverNotification(BEFailOverEvent) method, this indicates the RMI registry port number of the BE server to which the FE server has established the connection.

Returns:

RMI registry port number of the current primary BE server, to which the FE server will establish connection or has already established connection. -1 is returned if the RMI registry port number is not configured, or if an error occurs while trying to get the port number.

getNewBEHost

public java.lang.String getNewBEHost()

Returns the host name of the current primary BE server, to which the FE server can establish connection.

When notified through the BEFailOverListener.preBEFailOverNotification(BEFailOverEvent) method, this indicates the host name of the BE server to which the FE server will try to connect. When notified through the BEFailOverListener.postBEFailOverNotification(BEFailOverEvent) method, this indicates the host name of the BE server to which the FE server has established the connection.

Returns:

Host name of the current primary BE server, to which the FE server will establish connection or has already established connection. null is returned if the host name is not configured, or if an error occurs while trying to get the host name.

getOldBEPort

public int getOldBEPort()

Returns the TCP port number of the failed BE server, to which the FE server was connected. The returned value is of no relevance if the BE and FE servers were communicating in the RMI mode.

Returns:

The TCP port number of the failed BE server to which the FE server was connected, -1 in case of any error.

getOldRMIPort

public int getOldRMIPort()

Returns the RMI registry port number of the failed BE server, to which the FE server was connected.

Returns:

The RMI registry port number of the failed BE server to which the FE server was connected, -1 in case of any error.

getOldBEHost

public java.lang.String getOldBEHost()

Returns the host name of the failed BE server, to which the FE server was connected.

Returns:

The host name of the failed BE server to which the FE server was connected, null in case of any error.