com.adventnet.nms.tl1.config
Interface TL1ConfigAPI

All Superinterfaces:

java.rmi.Remote

public interface TL1ConfigAPI
extends java.rmi.Remote

The TL1ConfigAPI defines the methods that allow addition and deletion of TL1 Objects at Runtime. You can reconnect to a TL1 Device and also send commands to the TL1 Device in sync mode. The TL1 Objects comprises of TL1 Interface, TL1 Node, TL1 Gateway Node, TL1 Gateway Access Session. The following are the functionalities provided by this API:

• Provision to add TL1 Node, TL1 Interface, TL1 Gateway Node, TL1 Gateway Access Session
• Provision to add a Group
• Provision for Reconnect
• Provision to add TL1 Node with TID
• Provision to delete TL1 Node with TID

Accessing the TL1ConfigAPI You can access the TL1ConfigAPI through:

• same JVM - For e.g.,TL1ConfigAPI tl1Api = (TL1ConfigAPI) NmsUtil.getAPI ("TL1ConfigAPI");
• RMI - For e.g.,TL1Config API api = (TL1ConfigAPI)Naming.lookup("rmi://"+host+":"+port+"/TL1ConfigAPI");




Operation	Methods Used
Adding TL1 Objects	addTL1Node(TL1Config tl1node) , addGNE(GNEConfig gne) , addObject(String className,Properties prop) , addTID(TIDConfig tid,String ip,String port)
Adding a Group	addGroup(TL1Config group)
Deleting TL1 Nodes with TargetID	deleteTID(String tidname,String ip,String port)
Sending command to NE in Sync Mode	syncSend(Properties prop)
Reconnecting to the Device	reconnect(String ipaddress,String port)

Method Summary

void	addGNE(GNEConfig gne) Deprecated.
void	addGroup(TL1Config group) This method is used to add a new Group.
void	addObject(java.lang.String className, java.util.Properties prop) This method is used to add TL1 Objects such as TL1 Node, TL1 Gateway Node and TID Device.
void	addTID(TIDConfig tid, java.lang.String ip, java.lang.String port) Deprecated.
void	addTL1Node(TL1Config tl1node) Deprecated.
void	deleteTID(java.lang.String tidname, java.lang.String ip, java.lang.String port) This method is used to delete a TID Object.
boolean	reconnect(java.lang.String ipaddress, java.lang.String port) This method is used to reconnect to a TL1 Node or a TL1 Gateway Access Session.
java.lang.String	syncSend(java.util.Properties prop) This method is used to send a command to the NE in sync mode and it returns the result as a string.

Method Detail

addTL1Node

void addTL1Node(TL1Config tl1node)
                throws java.rmi.RemoteException

Deprecated.

This method is used to add a directly accessible TL1Node to an existing group. The group should be configured in the tl1seed.file found in /conf directory. The parameter that is passed to this method is the TL1Config Object. The TL1Config Object contains details such as IPAddress, GroupName, Netmask and the TL1 Port. It is mandatory that Group has to exist before a TL1Node is added. When a TL1Node is added through this method, the tl1seed.file is updated and the addNode(ManagedObject, boolean, boolean, boolean) method is called to initiate discovery.

Parameters:

TL1Config - This object contains the properties of the TL1Node that has to be added to the database.

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

addGNE

void addGNE(GNEConfig gne)
            throws java.rmi.RemoteException

Deprecated.

This method is used to add TL1 Gateway Node, TL1 Interface, TL1 Gateway Access Session Objects to an exisiting group. The group should be configured in the tl1seed.file found in /conf directory. The parameter that is passed to this method is the GNEConfig Object. The GNEConfig Object contains the Gateway properties of which the essential properties are IPAddress, Netmask,GroupName and the TL1 Port. It is mandatory that the Group has to exist before a GNE object is added to the database. When a TL1 Gateway Node, TL1 Interface or TL1 Gateway Access Session is added through this method, the tl1seed.file is updated and the addNode(ManagedObject, boolean, boolean, boolean) method is called to initiate discovery.

Parameters:

GNEConfig - This object contains the properties of the GNE that has to be added to the database.

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

addTID

void addTID(TIDConfig tid,
            java.lang.String ip,
            java.lang.String port)
            throws java.rmi.RemoteException

Deprecated.

This method is used to add a TL1Node which has a TargetID to an existing GNE Configuration and an existing Group. The parameters that are passed to this method are TIDConfig Object, GNE IPAddress and GNE Port. The essential properties of the TIDConfig Object are TIDName and GroupName. It is mandatory that the Group and GNE should exist before the TID Object is added. When the TID device is added through this method, the tlseed.file is updated and the addNode(ManagedObject,boolean,boolean,boolean) method is called to initiate discovery.

Parameters:

TIDConfig - This object contains the properties of the TL1Node with TID that has to be added to the database.

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

addGroup

void addGroup(TL1Config group)
              throws java.rmi.RemoteException

This method is used to add a new Group. The parameter that is passed to this method is TL1Config Object. The TL1Config Object contains properties such as GroupName and Type. When a Group is added through this method, the tl1seed.file is updated.

Parameters:

TL1Config - This object contains the properties of the TL1Node that has to be added to the database.

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

deleteTID

void deleteTID(java.lang.String tidname,
               java.lang.String ip,
               java.lang.String port)
               throws java.rmi.RemoteException

This method is used to delete a TID Object. The parameters that are passed to this method are TIDName, GNE IPAddress and GNE Port. When this method is used, the TID Object is removed from the Database and the tl1seed.file is updated.

Parameters:

tidname - Name of the TID Device that has to be deleted

ip - IPAddress of the GNE

port - Port of the GNE

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

syncSend

java.lang.String syncSend(java.util.Properties prop)
                          throws java.rmi.RemoteException

This method is used to send a command to the NE in sync mode and it returns the result as a string. The parameter that is passed to this method is the Properties object. The essential parameters in this object are TargetHost, TargetPort and the Command parameters such as CommandCode, TargetID/AccessID.

Parameters:

Properties -

Returns:

string

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

reconnect

boolean reconnect(java.lang.String ipaddress,
                  java.lang.String port)
                  throws java.rmi.RemoteException

This method is used to reconnect to a TL1 Node or a TL1 Gateway Access Session. This method returns a boolean value and the parameters passed to this method are IPAddress and TL1 Port. If the IPAddress is passed as a parameter then reconnection is made with the specified TL1 Node. If the port is also specified, reconnection is made with the TL1 Gateway Access Session. If the IPAddress has been specified with port being null,then the connection will be established with the TL1 Node and even though the connection fails boolean true would be returned.

Parameters:

ipaddress - IPAddress of the TL1 device to which reconnection has to be made

port - TL1 port at which reconnection has to be made.

Returns:

boolean

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.

addObject

void addObject(java.lang.String className,
               java.util.Properties prop)
               throws java.rmi.RemoteException

This method is used to add TL1 Objects such as TL1 Node, TL1 Gateway Node and TID Device. The parameters that are passed to this method are className and Properties. The classname that can be specified are TL1Config Object, GNEConfig Object, TIDConfig Object.

Parameters:

className - Class of the TL1 Object that has to be added to the database

properties -

Throws:

java.rmi.RemoteException - if a problem occurs when accessing through RMI.