com.adventnet.nms.commonfe
Interface GenericFEAPI

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

GenericFEAPIImpl

public interface GenericFEAPI

extends java.rmi.Remote

A remote interface for getting general information about the FE server.

From the same JVM as that of the FE server, this API can be accessed through the GenericFEAPIImpl.getAPI() method.

This remote API is bound to the RMI registry with the handle GenericFEAPI. Clients from remote JVM can look up the RMI registry of the FE server (Naming.lookup ("//FeServerHost/GenericFEAPI")) and get the handle to this API.

Since:

Web NMS 2.3

See Also:

Remote

Method Summary

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.
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 :
boolean	isReadyForConnection() Checks if the FE server is ready to accept client connections.

Method Detail

getActiveUsers

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

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

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

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.

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

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

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 host name of the FE server to which this client is connected.

IPAddress : The ipaddress of the FE server 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.

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.