com.adventnet.nms.commonfe
Class GenericFEAPIImpl

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.adventnet.nms.commonfe.GenericFEAPIImpl

All Implemented Interfaces:

GenericFEAPI, java.rmi.Remote, java.io.Serializable

public class GenericFEAPIImpl

extends java.rmi.server.UnicastRemoteObject

implements GenericFEAPI

See Also:

Serialized Form

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

GenericFEAPIImpl()
Creates a new GenericFEAPIImpl instance.

Method Summary

boolean	addActiveUser(java.lang.String userName)
void	addActiveUserProps(java.lang.Object mss, java.util.Properties cProps)
java.util.Vector	getActiveUsers() Returns a Vector containing the list of distinct user names by which Java Clients have logged in to this FE Server.
java.util.List	getActualUsers() Returns an unmodifiable List of user names by which Clients have logged in to this FE Server.
static GenericFEAPIImpl	getAPI() Returns the singleton GenericFEAPIImpl instance in the FE server.
java.util.Vector	getClientDetailsOfType(java.lang.String type, java.lang.String key) Gets the details about the clients that are connected to this WebNMS FE server.The client details that are provided by this method are : FE_SERVER : The FE server host name to which this client is connected.
boolean	isReadyForConnection() Checks if the FE server is ready to accept client connections.
static void	log(java.lang.String str) Describe log method here.
boolean	removeActiveUser(java.lang.String userName)
void	removeActiveUserProps(java.lang.Object mss)

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericFEAPIImpl

public GenericFEAPIImpl()
                 throws java.rmi.RemoteException

Creates a new GenericFEAPIImpl instance.

Throws:

java.rmi.RemoteException - if an error occurs

Method Detail

getAPI

public static GenericFEAPIImpl getAPI()

Returns the singleton GenericFEAPIImpl instance in the FE server. This method can be used only within the FE server JVM.

The GenericFEAPIImpl is the implementation class for the GenericFEAPI and hence it is recommended that the public methods, other than the interface methods and the getAPI, in this class not be used.

Returns:

GenericFEAPIImpl instance, or null if this method is called before instantiation of the API in the JVM.

log

public static void log(java.lang.String str)

Describe log method here. Will print the information with module as MISC.

Parameters:

str - a String value

addActiveUser

public boolean addActiveUser(java.lang.String userName)

removeActiveUser

public boolean removeActiveUser(java.lang.String userName)

getActiveUsers

public java.util.Vector getActiveUsers()
                                throws java.rmi.RemoteException

Description copied from interface: GenericFEAPI

Returns a Vector containing the list of distinct user names by which Java Clients have logged in to this FE Server.

Specified by:

getActiveUsers in interface GenericFEAPI

Following copied from interface: com.adventnet.nms.commonfe.GenericFEAPI

Returns:

A Vector containing the list of user names currently connected to this FE Server using Java Client

Throws:

java.rmi.RemoteException - : if any communication related error occurs

isReadyForConnection

public boolean isReadyForConnection()
                             throws java.rmi.RemoteException,
                                    java.io.IOException

Description copied from interface: GenericFEAPI

Checks if the FE server is ready to accept client connections. Only when all the modules in the FE server have started successfully, the FE server starts accepting client connections.

Specified by:

isReadyForConnection in interface GenericFEAPI

Following copied from interface: com.adventnet.nms.commonfe.GenericFEAPI

Returns:

true if the FE server is ready for accepting client connections, false otherwise.

Throws:

java.rmi.RemoteException - : if any communication related error occurs

getActualUsers

public java.util.List getActualUsers()
                              throws java.rmi.RemoteException

Description copied from interface: GenericFEAPI

Returns an unmodifiable List of user names by which Clients have logged in to this FE Server.

Specified by:

getActualUsers in interface GenericFEAPI

Following copied from interface: com.adventnet.nms.commonfe.GenericFEAPI

Returns:

a List containing the list of user names by which Clients have currently connected to this FE Server

Throws:

java.rmi.RemoteException - if an error occurs

getClientDetailsOfType

public java.util.Vector getClientDetailsOfType(java.lang.String type,
                                               java.lang.String key)
                                        throws java.rmi.RemoteException

Gets the details about the clients that are connected to this WebNMS FE server.The client details that are provided by this method are : FE_SERVER : The FE server host name to which this client is connected. IPAddress : The FE server ipaddress to which this client is connected. FE_SERVER_PORT : The webserver port of the FE to which this client is connected. CLIENT_IPAddress : The ipaddress of the machine from which this client is connected. CLIENT_TYPE : The type of client,ie, APPLETCLIENT,APPLICATIONCLIENT,JAVAWEBSTART,WEBCLIENT. CLIENT_TIME : The time at which this client has connected to the server. USER_NAME : The login user name of the client.

Specified by:

getClientDetailsOfType in interface GenericFEAPI

Parameters:

type - denotes the criteria for fetching the details about the clients connected to the NMS FE Server.This takes the value of "ALL" or any of the above given client details name like,"USER_NAME","CLIENT_TYPE" etc. "ALL" fetches the details of all the clients that are connected to the NMS FE server.A client detail name like,"USER_NAME" or "CLIENT_TYPE" as the "type" value, returns the list of clients that matches for this property name against the value given in the "key" argument of the method.

key - match criteria for fetching the client details.If the "type" argument is "ALL", this takes the value "null".For example, if the details about all the clients logged in with username as "root"is required,this method should be invoked as : getClientDetailsOfType("USER_NAME","root")

Returns:

Vector of Properties object containing the details of clients connected to the NMS Server.

addActiveUserProps

public void addActiveUserProps(java.lang.Object mss,
                               java.util.Properties cProps)

removeActiveUserProps

public void removeActiveUserProps(java.lang.Object mss)