com.adventnet.nms.config
Class ClientAuditAPIImpl

java.lang.Object
  |
  +--com.adventnet.nms.client.ClientCVAPIImpl
        |
        +--com.adventnet.nms.config.ClientAuditAPIImpl

All Implemented Interfaces:

ClientAuditAPI, CommonClientAPI

public class ClientAuditAPIImpl

extends ClientCVAPIImpl

implements ClientAuditAPI

ClientAuditAPIImpl is the implementation of the ClientAuditAPI which the API users would instantiate to manipulate with Audit Custom Views.

Fields inherited from class com.adventnet.nms.client.ClientCVAPIImpl

customViewsHT, lookupName, serverCVApi, sessionId, temporaryCustomViews, user

Constructor Summary

ClientAuditAPIImpl(java.lang.String hostName, int rmiRegPort, java.lang.String userName)
Constructor with params of host name and rmi registry port of the server and user name with which the client logs in.

ClientAuditAPIImpl(java.lang.String hostName, int rmiRegPort, java.lang.String userName, java.lang.String password)
Creates a new ClientAuditAPIImpl instance.

ClientAuditAPIImpl(java.lang.String hostName, int rmiRegPort, java.lang.String userName, java.lang.String password, java.lang.String cryptoClass)
Creates a new ClientAuditAPIImpl instance.

ClientAuditAPIImpl(java.lang.String hostName, java.lang.String userName)

Method Summary

java.lang.String[]	getDefaultDisplayFields() getDefaultDisplayFields method returns an array of default field names to be used as display fields for new Custom Views.
java.lang.String[]	getDefaultDisplayLabels() getDefaultDisplayLabels method returns an array of default labels (display names) for the fields in the Custom View.
protected java.lang.String	getKeyFieldName() getKeyFieldName returns the name of the property by which the Object is uniquely identified.
protected java.lang.String	getLookupName() getLookupName returns the name to be used for RMI lookup.
java.util.Hashtable	getPropertiesOfObject(java.lang.String name) This method will accept name of a ManagedObject and returns properties of the object.
protected boolean	isShowLatest() isShowLatest specifies whether or not a module shows the latest objects (objects created/updated lately) always.

Methods inherited from class com.adventnet.nms.client.ClientCVAPIImpl

createCustomView, createCustomView, createCustomView, createCustomView, createCustomView, getAPI, getCustomView, getCustomViewNames, getServerAPI, getSessionId, getUserName, removeCustomView, retrieveCustomView, saveCustomView, saveCustomViewForAll, showDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adventnet.nms.client.CommonClientAPI

createCustomView, createCustomView, createCustomView, createCustomView, createCustomView, getCustomView, getCustomViewNames, removeCustomView, retrieveCustomView, saveCustomView, saveCustomViewForAll

Constructor Detail

ClientAuditAPIImpl

public ClientAuditAPIImpl(java.lang.String hostName,
                          java.lang.String userName)

ClientAuditAPIImpl

public ClientAuditAPIImpl(java.lang.String hostName,
                          int rmiRegPort,
                          java.lang.String userName)

Constructor with params of host name and rmi registry port of the server and user name with which the client logs in.

ClientAuditAPIImpl

public ClientAuditAPIImpl(java.lang.String hostName,
                          int rmiRegPort,
                          java.lang.String userName,
                          java.lang.String password)
                   throws java.lang.Exception

Creates a new ClientAuditAPIImpl instance.

Parameters:

hostName - The FE server's hostName to lookup for the API

rmiRegPort - The port in which the RMI registry is listening

userName - The user for whom the instance is created

password - The password for the user. This is required in case WebNMS is started in Secure RMI Mode. In such a case only RMIAccessAPI will be available via RMI and all other APIs will be available only after authentication. This can be set to null in normal setup of WebNMS.

ClientAuditAPIImpl

public ClientAuditAPIImpl(java.lang.String hostName,
                          int rmiRegPort,
                          java.lang.String userName,
                          java.lang.String password,
                          java.lang.String cryptoClass)
                   throws java.lang.Exception

Creates a new ClientAuditAPIImpl instance.

Parameters:

hostName - The FE server's hostName to lookup for the API

rmiRegPort - The port in which the RMI registry is listening

userName - The user for whom the instance is created

password - The password for the user. This is required if WebNMS is started in Secure RMI Mode * In such a case only RMIAccessAPI will be available via RMI and all other APIs will be available only after authentication. This can be set to null in normal setup of WebNMS.

cryptoClass - name of the class which is used to encrypt the password, if Custom Authentication is used

Method Detail

getPropertiesOfObject

public java.util.Hashtable getPropertiesOfObject(java.lang.String name)
                                          throws java.rmi.RemoteException

This method will accept name of a ManagedObject and returns properties of the object.

Specified by:

getPropertiesOfObject in interface ClientAuditAPI

getLookupName

protected java.lang.String getLookupName()

Description copied from class: ClientCVAPIImpl

getLookupName returns the name to be used for RMI lookup. The RMI lookup with this name should return a reference to a class which implements ServerCustomViewAPI.

Overrides:

getLookupName in class ClientCVAPIImpl

Following copied from class: com.adventnet.nms.client.ClientCVAPIImpl

Returns:

a String value of the name to used for lookup

getKeyFieldName

protected java.lang.String getKeyFieldName()

Description copied from class: ClientCVAPIImpl

getKeyFieldName returns the name of the property by which the Object is uniquely identified.

Overrides:

getKeyFieldName in class ClientCVAPIImpl

Following copied from class: com.adventnet.nms.client.ClientCVAPIImpl

Returns:

the unique property name for the specific module.

getDefaultDisplayFields

public java.lang.String[] getDefaultDisplayFields()

Description copied from interface: CommonClientAPI

getDefaultDisplayFields method returns an array of default field names to be used as display fields for new Custom Views. These are a subset of the property names for an Object in that module. The labels that are displayed for these fields are available in CommonClientAPI.getDefaultDisplayLabels()

Specified by:

getDefaultDisplayFields in interface CommonClientAPI

Overrides:

getDefaultDisplayFields in class ClientCVAPIImpl

Following copied from interface: com.adventnet.nms.client.CommonClientAPI

Returns:

a String[] of display fields for the new Custom View.

getDefaultDisplayLabels

public java.lang.String[] getDefaultDisplayLabels()

Description copied from interface: CommonClientAPI

getDefaultDisplayLabels method returns an array of default labels (display names) for the fields in the Custom View.

The size of the array returned by this method should match with those returned by CommonClientAPI.getDefaultDisplayFields()

Specified by:

getDefaultDisplayLabels in interface CommonClientAPI

Overrides:

getDefaultDisplayLabels in class ClientCVAPIImpl

Following copied from interface: com.adventnet.nms.client.CommonClientAPI

Returns:

a String[] value

isShowLatest

protected boolean isShowLatest()

Description copied from class: ClientCVAPIImpl

isShowLatest specifies whether or not a module shows the latest objects (objects created/updated lately) always.

If this returns true and if the objects in the Custom View show the latest, then the view will get updated such that it will always contain the latest.

For example, if the custom view contains 95 objects and and what is being currently viewed is from 86 to 95 (latest) with the view length of 10. The view can be specified as [86 to 95 of 95].

Say a new object gets added increasing the total to 96 for this custom view.

Now if this method were to return true, then the row gets added in the view, with the range changing to [87 to 96 of 96] example : Event module custom views.

If this method returns false, then the rows stay unaffected, with the total alone changing .Hence the view will be [86 to 95 of 96]. You may see the 96th row by doing a query for next set of rows. example : Topo module custom views.

Overrides:

isShowLatest in class ClientCVAPIImpl

Following copied from class: com.adventnet.nms.client.ClientCVAPIImpl

Returns:

a boolean value whether to showlatest or not.