Interface NodeAPIFactory

All Superinterfaces:
Remote
All Known Implementing Classes:
APIMetaFactory

public interface NodeAPIFactory extends Remote
A factory for create NodeAPI objects.

This interface is used to create NodeAPI objects for configuring specific nodes currently existing in Network Mediation.

The NodeAPIFactory can be obtained by requesting it from the admin server's RMI registry. For example:

 Registry reg = LocateRegistry.getRegistry("10.13.3.34", 11001);
 Remote obj = reg.lookup("tl1configuration");
 NodeAPIFactory factory = (NodeAPIFactory)obj;
 

This code fragment obtains a NodeAPIFactory from the admin server at 10.13.3.34 on port 11001. This factory can then be used to create instances of the XmlTl1Api interface to configure specific nodes.

  • Method Summary

    Modifier and Type
    Method
    Description
    getNodeAPI(String nodeName)
    Create a XmlTl1Api object for a specific node.
  • Method Details

    • getNodeAPI

      NodeAPI getNodeAPI(String nodeName) throws NodeAPIException, RemoteException
      Create a XmlTl1Api object for a specific node.

      Given a node name, create a NodeApi object for configurating that node. If there is more than one node with the specified node name a NodeApiException will be thrown. It is the responsibility of the user to ensure that only one node with the given name exists.

      Parameters:
      nodeName - The name of the node which is to be configured.
      Returns:
      The NodeApi object for the specified node.