Package com.nt.udc.admin.server

Class AdminServerAPI

java.lang.Object
com.nt.common.util.ServerAPI
com.nt.udc.admin.server.AdminServerAPI
All Implemented Interfaces:
AdminServerAPIInterface, TNCEventReceiverIfc, AcctEventListener, Serializable, Remote, EventListener
Direct Known Subclasses:
ASProxy
public class AdminServerAPI extends com.nt.common.util.ServerAPI implements AdminServerAPIInterface, AcctEventListener, TNCEventReceiverIfc
AdminServerAPI API class for allowing communication between a local client and a remote AdminServer. This class is an extension of ServerAPI, and as with all extensions of that class should be constructed with the static method getInstance().
See Also:

  • Field Details

  • Constructor Details

    • AdminServerAPI

      public AdminServerAPI(String ip, String port) throws com.nt.common.exceptions.APIException
      AdminServerAPI Constructor The constructors for AdminServerAPI should only be called by AdminServerAPI.getInstance() methods.
      Parameters:
      ip - The IP Address of the AdminServer.
      port - The port of the AdminServer.
      Throws:
      com.nt.common.exceptions.APIException

    • AdminServerAPI

      public AdminServerAPI(String ip, int port) throws com.nt.common.exceptions.APIException
      AdminServerAPI Constructor The constructors for AdminServerAPI should only be called by AdminServerAPI.getInstance() methods.
      Parameters:
      ip - The IP Address of the AdminServer we're connecting to.
      port - The port of the AdminServer we're connecting to.
      Throws:
      com.nt.common.exceptions.APIException

  • Method Details

    • getInstance

      public static com.nt.common.util.ServerAPI getInstance(String ip, String prt) throws com.nt.common.exceptions.APIException
      getInstance This static method should be used to get an instance of AdminServerAPI instead of using the constructor directly.
      Parameters:
      ip - The IP Address of the AdminServer we're connecting to.
      prt - The port of the AdminServer we're connecting to.
      Returns:
      ServerAPI A reference to this class, cast as it's super.
      Throws:
      com.nt.common.exceptions.APIException

    • getInstance

      public static com.nt.common.util.ServerAPI getInstance(String ip, int port) throws com.nt.common.exceptions.APIException
      getInstance This static method should be used to get an instance of AdminServerAPI instead of using the constructor directly.
      Parameters:
      ip - The IP Address of the AdminServer we're connecting to.
      port - The port of the AdminServer we're connecting to.
      Returns:
      ServerAPI A reference to this class, cast as it's super.
      Throws:
      com.nt.common.exceptions.APIException

    • getAdminSvrAuth

      public boolean getAdminSvrAuth(String adminIP, String nodeIp, int nodePort) throws com.nt.common.exceptions.APIException
      Specified by:
      getAdminSvrAuth in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • retryRemoteRef

      protected Remote retryRemoteRef(RemoteException e) throws com.nt.common.exceptions.APIException
      Overrides:
      retryRemoteRef in class com.nt.common.util.ServerAPI
      Throws:
      com.nt.common.exceptions.APIException

    • checkRemote

      public void checkRemote()
      Specified by:
      checkRemote in class com.nt.common.util.ServerAPI

    • setRemoteRef

      protected void setRemoteRef(String server) throws com.nt.common.exceptions.APIException
      Overrides:
      setRemoteRef in class com.nt.common.util.ServerAPI
      Throws:
      com.nt.common.exceptions.APIException

    • addAcctEventListener

      public void addAcctEventListener(AcctEventListener ael) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • removeAcctEventListener

      public void removeAcctEventListener(AcctEventListener ael) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getEventSender

      public AcctEventSender getEventSender()

    • nodeManagersAdded

      public void nodeManagersAdded(Vector nmList) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that one or more NodeManagers were added. The Vector associated with each NMItem object will represent all the nodes that are being managed by that Node Manager.
      Specified by:
      nodeManagersAdded in interface AcctEventListener
      Throws:
      RemoteException

    • nodeManagersRemoved

      public void nodeManagersRemoved(Vector nmList) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that one or more NodeManagers were removed.
      Specified by:
      nodeManagersRemoved in interface AcctEventListener
      Parameters:
      nmList - Vector of NMItem objects representing the Node Managers that were removed.
      Throws:
      RemoteException

    • nodeManagerChanged

      public void nodeManagerChanged(com.nt.udc.admin.NMItem nmItem) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that the properties of a Node Manager have changed.
      Specified by:
      nodeManagerChanged in interface AcctEventListener
      Parameters:
      nmItem - NMItem object representing the Node Manager that changed.
      Throws:
      RemoteException

    • nodesAdded

      public void nodesAdded(com.nt.udc.admin.NMItem nmItem) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that a Node has been added to a particular Node Manager.
      Specified by:
      nodesAdded in interface AcctEventListener
      Parameters:
      nmItem - NMItem object which represents the Node Manager managing the node that was added. The Vector associated with nodeManager will contain only the node that was added.
      Throws:
      RemoteException

    • nodesRemoved

      public void nodesRemoved(com.nt.udc.admin.NMItem nmItem) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that a Node has been removed from a particular Node Manager.
      Specified by:
      nodesRemoved in interface AcctEventListener
      Parameters:
      nmItem - NMItem object which represents the Node Manager managing the node that was removed. The Vector associated with nodeManager will contain only the node(s) that was(were) removed.
      Throws:
      RemoteException

    • nodeChanged

      public void nodeChanged(com.nt.udc.admin.NMItem nmItem) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that the properties of a Node have changed.
      Specified by:
      nodeChanged in interface AcctEventListener
      Parameters:
      nmItem - NMItem object which represents the Node Manager whose node changed. The Vector associated with nodeManager will contain the node that changed.
      Throws:
      RemoteException

    • fileChanged

      public void fileChanged(com.nt.udc.admin.FileItem file) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that a system file changed.
      Specified by:
      fileChanged in interface AcctEventListener
      Parameters:
      file - FileItem object representing the system file that changed.
      Throws:
      RemoteException

    • adminServerChanged

      public void adminServerChanged(StatusMessage sm)
      Description copied from interface: AcctEventListener
      Indicates that the properties of an Admin Server have changed.
      Specified by:
      adminServerChanged in interface AcctEventListener
      Parameters:
      sm - StatusMessage object representing the change in the AdminServer.

    • systemUpdate

      public void systemUpdate(SystemModel model) throws RemoteException
      Description copied from interface: AcctEventListener
      Indicates that the system has substantially changed.
      Specified by:
      systemUpdate in interface AcctEventListener
      Parameters:
      model - SystemModel representing the current state of the system.
      Throws:
      RemoteException

    • nodePerformanceUpdate

      public void nodePerformanceUpdate(Vector perfs)
      Description copied from interface: AcctEventListener
      Indicates that node performance information was updated.
      Specified by:
      nodePerformanceUpdate in interface AcctEventListener
      Parameters:
      perfs - Vector of node performance objects

    • setDirConnection

      public void setDirConnection(DirectoryConnection dirConn) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getStatus

      public StatusMessage getStatus() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return status of AS
      Specified by:
      getStatus in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getVersionInfo

      public VersionInfo getVersionInfo() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return a String containing info about the java environment and packages on the Admin Server.
      Specified by:
      getVersionInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getCartridgeVersionInfo

      public Map getCartridgeVersionInfo(String ip, int port) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return a Map containing cartridge name. InputSteam pairs.
      Specified by:
      getCartridgeVersionInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNMVersionInfo

      public VersionInfo getNMVersionInfo(String ip, int port) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return a String containing info about the java environment and packages on each Node Manager.
      Specified by:
      getNMVersionInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNMList

      public Vector getNMList() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns a vector of NMItem objects which represents all node managers known to the Admin Server.
      Specified by:
      getNMList in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNM

      public com.nt.udc.admin.NMItem getNM(String id) throws com.nt.common.exceptions.APIException
      Specified by:
      getNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getSystemModel

      public SystemModel getSystemModel() throws com.nt.common.exceptions.APIException
      Specified by:
      getSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • loadXMLSystemModel

      public void loadXMLSystemModel(String xmlSystemModel) throws com.nt.udc.upgrade.ImportException
      Specified by:
      loadXMLSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ImportException

    • checkImportStatus

      public List checkImportStatus() throws RemoteException
      Specified by:
      checkImportStatus in interface AdminServerAPIInterface
      Throws:
      RemoteException

    • importSystemModel

      public void importSystemModel(List nodeManagerMap, boolean corrIdMap, boolean isNodeChainImport) throws com.nt.udc.upgrade.ImportException
      Specified by:
      importSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ImportException

    • doBackUp

      public void doBackUp(List nodeManagerMap) throws com.nt.common.exceptions.APIException
      Specified by:
      doBackUp in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • validateNmMaps

      public void validateNmMaps(ArrayList<com.nt.udc.upgrade.NodeManagerMap> nmMaps) throws com.nt.common.exceptions.APIException
      Specified by:
      validateNmMaps in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getXMLNodeManagerMap

      public List getXMLNodeManagerMap() throws com.nt.udc.upgrade.ImportException
      Specified by:
      getXMLNodeManagerMap in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ImportException

    • exportXMLSystemModel

      public String exportXMLSystemModel() throws com.nt.udc.upgrade.ExportException
      Specified by:
      exportXMLSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ExportException

    • exportXMLSystemModelOfNodeChain

      public String exportXMLSystemModelOfNodeChain(Vector nodesToExport) throws com.nt.udc.upgrade.ExportException
      Specified by:
      exportXMLSystemModelOfNodeChain in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ExportException

    • exportXMLSystemModel

      public String exportXMLSystemModel(Vector nMItems, Vector nodesToExport) throws com.nt.udc.upgrade.ExportException
      Specified by:
      exportXMLSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ExportException

    • exportXMLSystemModel

      public String exportXMLSystemModel(Vector vctNMItemsToExport) throws com.nt.udc.upgrade.ExportException
      Specified by:
      exportXMLSystemModel in interface AdminServerAPIInterface
      Throws:
      com.nt.udc.upgrade.ExportException

    • addNM

      public void addNM(String inIPAddress, String inName, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Inform the Admin Server that a node manager exists at the specified IP Address and port, and that it should be referred to by the specified display name.
      Specified by:
      addNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • changeNM

      public void changeNM(String inIPAddress, String inName, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Tell the Admin Server to change the display name associated with the node manager at the specified IP Address and port to the specified value.
      Specified by:
      changeNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • changeNM

      public void changeNM(String id, String inName) throws com.nt.common.exceptions.APIException
      This function is used to change the name of existing Node Manager
      Specified by:
      changeNM in interface AdminServerAPIInterface
      Parameters:
      id - The id of the Node Manager to be changed
      inName - The new name of the node manager
      Throws:
      com.nt.common.exceptions.APIException

    • removeNM

      public void removeNM(String inIPAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Tell the Admin Server to remove the node manager at the specified IP Address/Port.
      Specified by:
      removeNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeNM

      public void removeNM(String id) throws com.nt.common.exceptions.APIException
      This function is used to delete an existing Node Manager using node Manager ID
      Specified by:
      removeNM in interface AdminServerAPIInterface
      Parameters:
      id - The id of the Node Manager to be removed/deleted
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeList

      public Vector getNodeList() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns a vector of NodeInfo objects which represents all nodes known to the Admin Server.
      Specified by:
      getNodeList in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeList

      public Vector getNodeList(String inIPAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns a vector of NodeInfo objects which represents all nodes controlled by the node manager at the specified IP Address/Port.
      Specified by:
      getNodeList in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeItemList

      public Vector getNodeItemList() throws com.nt.common.exceptions.APIException
      This function returns a Vector of NodeItem objects
      Specified by:
      getNodeItemList in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • addNode

      public String addNode(String inIPAddress, int port, com.nt.udc.admin.NodeInfo nodeInfo) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Add a new node (represented by the NodeInfo object) to the node manager residing at the specified IP Address and port.
      Specified by:
      addNode in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • addNode

      public String addNode(String inIPAddress, int port, com.nt.udc.admin.NodeInfo nodeInfo, boolean regNodeId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • removeNodes

      public void removeNodes(Vector inNodeIds) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Expects a vector of nodeID (string) objects. Remove the specified nodes from the system.
      Specified by:
      removeNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getOutputNodes

      public Vector getOutputNodes(String inNodeId) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns a vector of ChannelInfo objects which represents all nodes that receive output from the specified node.
      Specified by:
      getOutputNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getInputNodes

      public Vector getInputNodes(String inNodeId) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns a vector of ChannelInfo objects which represents all nodes that sends input to the specified node.
      Specified by:
      getInputNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setNodeOutputs

      public void setNodeOutputs(String inNodeId, Vector inOutputNodes) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Expects a nodeID (string) and a vector of nodeID (string) objects. Set the output nodes for the specified node to be the specified set of nodes.
      Specified by:
      setNodeOutputs in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeOutputNodes

      public void removeOutputNodes(String inNodeId, Vector inOutputNodes) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Expects a nodeID (string) and a vector of nodeID (string) objects. Remove the specified output nodes from the specified node.
      Specified by:
      removeOutputNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getTemplate

      public com.nt.udc.admin.Template getTemplate(String templateId) throws com.nt.common.exceptions.APIException
      Specified by:
      getTemplate in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getTemplateTree

      public com.nt.udc.admin.TemplateTreeRoot getTemplateTree() throws com.nt.common.exceptions.APIException
      Specified by:
      getTemplateTree in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getSiteInfo

      public Map getSiteInfo() throws com.nt.common.exceptions.APIException
      Specified by:
      getSiteInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getLicenses

      public List getLicenses() throws com.nt.common.exceptions.APIException
      Specified by:
      getLicenses in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getLicensedSet

      public Set getLicensedSet(Set allTemplates) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getRuleFileContent

      public byte[] getRuleFileContent(com.nt.udc.admin.NodeInfo info, String inFileName) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Get the content of the RulesFile with the passed-in name.
      Specified by:
      getRuleFileContent in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • updateRuleFileContent

      public void updateRuleFileContent(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inRuleFileName, byte[] ruleFileContent) throws com.nt.common.exceptions.APIException
      Specified by:
      updateRuleFileContent in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • isSystemRuleFile

      public boolean isSystemRuleFile(com.nt.udc.admin.NodeInfo info, String inFileName) throws com.nt.common.exceptions.APIException
      Specified by:
      isSystemRuleFile in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • deleteRuleFile

      public boolean deleteRuleFile(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inFileName) throws com.nt.common.exceptions.APIException
      Specified by:
      deleteRuleFile in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • nplChanged

      public boolean nplChanged(com.nt.udc.admin.NodeInfo info) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Indicates whether the NPL file indicated in the given NodeInfo object has changed since the AdminServer was started.
      Specified by:
      nplChanged in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • compileNPL

      public void compileNPL(byte[] nplContent) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Compiles given npl content for testing if there are any compilation errors
      Specified by:
      compileNPL in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • reloadNPL

      public void reloadNPL(com.nt.udc.admin.NodeInfo info) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Instructs the AdminServer to recompile the NPL file indicated in the given NodeInfo object.
      Specified by:
      reloadNPL in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • performConfigAction

      public void performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo ni) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Config Action specific to node
      Specified by:
      performConfigAction in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • performConfigAction

      public void performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo ni, String ipAddr, int port) throws com.nt.common.exceptions.APIException
      Specified by:
      performConfigAction in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getOutputFields

      public ArrayList getOutputFields(DCNodeTypeIfc inNodeType, String inRuleFileName) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Get the output fields in the specified rule file. The ArrayList returned contains other ArrayList objects, one for each output record defined in the rules file. The elements of these ArrayLists are FieldDescriptor objects, one for each field in that output record.
      Specified by:
      getOutputFields in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • copyNPL

      public void copyNPL(DCNodeTypeIfc inNodeType, String inRuleFileName) throws com.nt.common.exceptions.APIException
      Specified by:
      copyNPL in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getExposedFields

      public ArrayList getExposedFields(DCNodeTypeIfc inNodeType, String inRuleFileName, String inReason) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Get the exposed fields from an expose clause of the specified rule file. The ArrayList returned contains FieldDescriptor objects, one for each field in the expose clause matching the reason provided.
      Specified by:
      getExposedFields in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getASLog

      public byte[] getASLog() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return the contents of the log for the Admin Server
      Specified by:
      getASLog in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNMLog

      public byte[] getNMLog(String inIPAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return the contents of the log for the node manager at the specified IP Address/Port.
      Specified by:
      getNMLog in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeLog

      public byte[] getNodeLog(String inNodeId) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return the contents of the log for the specified node.
      Specified by:
      getNodeLog in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setRefreshInterval

      public void setRefreshInterval(long inRefInt) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Sets the interval (in seconds) at which the statuses of all Node Managers and Nodes are refreshed
      Specified by:
      setRefreshInterval in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • startNodes

      public void startNodes(Vector inNodeIds) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Expects a vector of nodeID (string) objects. Start the specified nodes.
      Specified by:
      startNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • stopNodes

      public void stopNodes(Vector inNodeIds) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Expects a vector of nodeID (string) objects. Stop the specified nodes.
      Specified by:
      stopNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • startAllNodes

      public void startAllNodes(String inIPAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Start all nodes on the node manager at the specified IP Address/Port.
      Specified by:
      startAllNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • stopAllNodes

      public void stopAllNodes(String inIPAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Stop all nodes on the node manager at the specified IP Address.
      Specified by:
      stopAllNodes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeInfo

      public com.nt.udc.admin.NodeInfo getNodeInfo(String inNodeId) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Get a NodeInfo object describing the specified node.
      Specified by:
      getNodeInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setNodeDescription

      public void setNodeDescription(com.nt.udc.admin.NodeInfo nodeInfo) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Modify the parameters of the specified node to be in accordance with the passed-in NodeInfo object. This only updates the NodeInfo object in the table and does not save the node's configuration file(s), or cause the node to be reconfigured.
      Specified by:
      setNodeDescription in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setNodeInfo

      public void setNodeInfo(com.nt.udc.admin.NodeInfo nodeInfo) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Modify the parameters of the specified node to be in accordance with the passed-in NodeInfo object.
      Specified by:
      setNodeInfo in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • reMapWalletPassword

      public boolean reMapWalletPassword(String nodeId, List<int[]> indicesList) throws com.nt.common.exceptions.APIException
      Specified by:
      reMapWalletPassword in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • clearNMAlarm

      public void clearNMAlarm(String ipAddress, int inPort) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Clears the alarm on a Node Manager
      Specified by:
      clearNMAlarm in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • clearNodeAlarm

      public void clearNodeAlarm(String nodeId) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      clears the alarm on a specific node
      Specified by:
      clearNodeAlarm in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getCurrentPerformanceMetrics

      public Vector getCurrentPerformanceMetrics(String ip, int port) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Return a vector of performance objects
      Specified by:
      getCurrentPerformanceMetrics in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • replace

      public static void replace(AdminServerAPI api)

    • getRole

      public int getRole(com.nt.udc.admin.User user) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Returns the role of the user passed as argument
      Specified by:
      getRole in interface AdminServerAPIInterface
      Parameters:
      user -
      Returns:
      role
      Throws:
      com.nt.common.exceptions.APIException
      AuthenticationException

    • login

      public void login(com.nt.udc.admin.User user) throws com.nt.common.exceptions.APIException, AuthenticationException
      Description copied from interface: AdminServerAPIInterface
      Attempts to authenticate the given user with the Admin Server
      Specified by:
      login in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException
      AuthenticationException

    • logout

      public void logout() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Logs out the current user
      Specified by:
      logout in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getCurrentUserId

      public String getCurrentUserId()
      Description copied from interface: AdminServerAPIInterface
      Returns the ID of the user currently accessing the Admin Server through this AdminServerAPI Object
      Specified by:
      getCurrentUserId in interface AdminServerAPIInterface

    • hasAdminPriv

      public boolean hasAdminPriv() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Indicates whether the current user has Administrative privileges
      Specified by:
      hasAdminPriv in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setCurrentUser

      public void setCurrentUser(com.nt.udc.admin.User user)
      Sets the current User

    • getCurrentUser

      public com.nt.udc.admin.User getCurrentUser()
      Return the User object representing current logged in user

    • getUserList

      public Vector getUserList() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Retrieves the current list of valid user ids known to the Admin Server.
      Specified by:
      getUserList in interface AdminServerAPIInterface
      Returns:
      Vector of User Objects representing the users
      Throws:
      com.nt.common.exceptions.APIException

    • modifyUser

      public boolean modifyUser(com.nt.udc.admin.User user, Boolean changePassword) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Modifies attributes associated with the given User
      Specified by:
      modifyUser in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • addUser

      public boolean addUser(com.nt.udc.admin.User user) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Adds a new User to the current list of valid users
      Specified by:
      addUser in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeUsers

      public boolean removeUsers(Vector userList) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Removes the given Users from the current list of valid users
      Specified by:
      removeUsers in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getTrapHostList

      public com.nt.udc.admin.TrapHostList getTrapHostList() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Gets list of known SNMP Trap Hosts
      Specified by:
      getTrapHostList in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • addTrapHost

      public void addTrapHost(com.nt.udc.admin.TrapHost host) throws com.nt.common.exceptions.APIException
      Adds a new host to the list of SNMP Trap Hosts
      Specified by:
      addTrapHost in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeTrapHost

      public void removeTrapHost(com.nt.udc.admin.TrapHost host) throws com.nt.common.exceptions.APIException
      Removes a host from the list of SNMP Trap Hosts
      Specified by:
      removeTrapHost in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeTrapHosts

      public void removeTrapHosts(Vector hosts) throws com.nt.common.exceptions.APIException
      Removes a host from the list of SNMP Trap Hosts
      Specified by:
      removeTrapHosts in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • modifyTrapHost

      public void modifyTrapHost(com.nt.udc.admin.TrapHost oldhost, com.nt.udc.admin.TrapHost newhost) throws com.nt.common.exceptions.APIException
      Modifies a host in the list of SNMP Trap Hosts
      Specified by:
      modifyTrapHost in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getDSHost

      public String getDSHost() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Gets Data Server host name
      Specified by:
      getDSHost in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getDSPort

      public String getDSPort() throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Gets Data Server port
      Specified by:
      getDSPort in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • showServerCommFailureDialog

      protected void showServerCommFailureDialog()
      Overrides:
      showServerCommFailureDialog in class com.nt.common.util.ServerAPI

    • getASConfig

      public Hashtable getASConfig() throws com.nt.common.exceptions.APIException
      Get a copy of the current Admin Server Config object. Currently contains only Mediation Assurance (CDR Count) parameters.
      Specified by:
      getASConfig in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • setASConfig

      public void setASConfig(Hashtable asConfig) throws com.nt.common.exceptions.APIException
      Description copied from interface: AdminServerAPIInterface
      Sets the Admin Server Config object. All original attributes should be present, even if they haven't been changed.
      Specified by:
      setASConfig in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • exportWithCustomization

      public byte[] exportWithCustomization(Vector nmListToExport, String exportName) throws com.nt.common.exceptions.APIException
      makes call to exportWithCustomization() method of Admin Server and returns the byte array which it received from the call.
      Specified by:
      exportWithCustomization in interface AdminServerAPIInterface
      Parameters:
      nmListToExport - list of node managers for which export should be done.
      exportName - the name of configuration xml which will be created during export
      Returns:
      byte[] returns the customization content received from the call to exportWithCustomization of admin server.
      Throws:
      com.nt.common.exceptions.APIException

    • exportWithCustomization

      public byte[] exportWithCustomization(Vector nmList, Vector nodesToExport, String exportName) throws com.nt.common.exceptions.APIException
      makes call to exportWithCustomization() method of Admin Server and returns the byte array which it received from the call.
      Specified by:
      exportWithCustomization in interface AdminServerAPIInterface
      Parameters:
      exportName - the name of configuration xml which will be created during export
      nmListToExport - list of node managers for which export should be done.
      Returns:
      byte[] returns the customization content received from the call to exportWithCustomization of admin server.
      Throws:
      com.nt.common.exceptions.APIException

    • importCustomization

      public boolean importCustomization(ArrayList nmMaps, byte[] contents) throws com.nt.common.exceptions.APIException
      makes call to importCustomization() method of Admin Server and returns the boolean value which it has received from the call.
      Specified by:
      importCustomization in interface AdminServerAPIInterface
      Parameters:
      nmMaps -
      contents -
      Returns:
      boolean
      Throws:
      com.nt.common.exceptions.APIException

    • getImportCustomLog

      public String getImportCustomLog() throws com.nt.common.exceptions.APIException
      makes call to getImportCustomLog() of Admin Server and returns the String which it has received from the call.
      Specified by:
      getImportCustomLog in interface AdminServerAPIInterface
      Returns:
      String the log created during importCustomization()
      Throws:
      com.nt.common.exceptions.APIException

    • getResetPwdInfo

      public boolean getResetPwdInfo(com.nt.udc.admin.User user) throws com.nt.common.exceptions.APIException
      makes call to getResetPwdInfo() of Admin Server and returns the password reset information
      Parameters:
      user -
      Returns:
      the boolean value indicating password is reset or not
      Throws:
      com.nt.common.exceptions.APIException

    • getSecondsToPasswordExpiration

      public int getSecondsToPasswordExpiration(com.nt.udc.admin.User user) throws com.nt.common.exceptions.APIException
      makes call to getSecondsToPasswordExpiration() of Admin Server and returns the seconds until password expiration
      Parameters:
      user - information of user
      Returns:
      number of seconds until password expiration
      Throws:
      com.nt.common.exceptions.APIException

    • getTimeoutValueMiliSec

      public long getTimeoutValueMiliSec() throws com.nt.common.exceptions.APIException
      returns the time out value for session expiry
      Returns:
      Throws:
      RemoteException
      com.nt.common.exceptions.APIException

    • getAuthUsers

      public boolean getAuthUsers() throws com.nt.common.exceptions.APIException
      returns true if authentication is enabled
      Specified by:
      getAuthUsers in interface AdminServerAPIInterface
      Returns:
      Throws:
      com.nt.common.exceptions.APIException

    • setImportExportProperty

      public void setImportExportProperty(String[][] newNmMap) throws com.nt.common.exceptions.APIException
      Specified by:
      setImportExportProperty in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • isHostBasedEnv

      public boolean isHostBasedEnv() throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • addRRNodeDestination

      public void addRRNodeDestination(String sourceNodeId, String destNodeId) throws com.nt.common.exceptions.APIException
      Specified by:
      addRRNodeDestination in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • removeRoute

      public String removeRoute(String sourceNodeId, String destNodeId) throws com.nt.common.exceptions.APIException
      Specified by:
      removeRoute in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • addRoute

      public String addRoute(String sourceNodeId, String destNodeId, String routeFunc, String rField, Vector rCondition) throws com.nt.common.exceptions.APIException
      Specified by:
      addRoute in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getDestNodesInNM

      public Vector getDestNodesInNM(String srcNode, String host, Integer port) throws com.nt.common.exceptions.APIException
      Specified by:
      getDestNodesInNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • validateNMForNodeTypes

      public boolean validateNMForNodeTypes(String inclusionExclusion, String majMin, String host, Integer port) throws com.nt.common.exceptions.APIException
      Specified by:
      validateNMForNodeTypes in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • changeRoutingToRR

      public void changeRoutingToRR(String srcNodeid, String destNodeId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • clearNodeIdCorrelationsMap

      public boolean clearNodeIdCorrelationsMap() throws com.nt.common.exceptions.APIException
      Specified by:
      clearNodeIdCorrelationsMap in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • integrateRoutingCCNMScaleUp

      public boolean integrateRoutingCCNMScaleUp(String ccHost, Integer ccPort) throws com.nt.common.exceptions.APIException
      Specified by:
      integrateRoutingCCNMScaleUp in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • integrateRouting

      public void integrateRouting(String parentHost, Integer parentPort) throws com.nt.common.exceptions.APIException
      Specified by:
      integrateRouting in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getOsaHome

      public String getOsaHome() throws com.nt.common.exceptions.APIException
      Specified by:
      getOsaHome in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • integrateScalingDownForSegregatedNM

      public void integrateScalingDownForSegregatedNM(String nmList) throws com.nt.common.exceptions.APIException
      Specified by:
      integrateScalingDownForSegregatedNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • integrateScalingDownForNonSegregatedNM

      public void integrateScalingDownForNonSegregatedNM(String nmlist) throws com.nt.common.exceptions.APIException
      Specified by:
      integrateScalingDownForNonSegregatedNM in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • updateRoute

      public String updateRoute(String sourceNodeId, String destNodeId, String routeFunc, String rField, Vector rCondition) throws com.nt.common.exceptions.APIException
      Specified by:
      updateRoute in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • updateRouteParameters

      public String updateRouteParameters(String sourceNodeId, String destNodeId, String rField, Vector rCondition) throws com.nt.common.exceptions.APIException
      Specified by:
      updateRouteParameters in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • uploadNodeChainTestInputFile

      public void uploadNodeChainTestInputFile(byte[] data, String nodeId, String fileName) throws com.nt.common.exceptions.APIException
      Specified by:
      uploadNodeChainTestInputFile in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • runNodeChainTest

      public void runNodeChainTest(String uploadId, NodeChainTestCfgItem cfgItem) throws com.nt.common.exceptions.APIException
      Specified by:
      runNodeChainTest in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getOutputNodeChainTest

      public List<NodeChainOutputRecords> getOutputNodeChainTest(String nodeId) throws com.nt.common.exceptions.APIException
      Specified by:
      getOutputNodeChainTest in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • completeNodeChainTest

      public void completeNodeChainTest(String testId) throws com.nt.common.exceptions.APIException
      Specified by:
      completeNodeChainTest in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getConfigValue

      public String getConfigValue(DCNodeTypeIfc inNodeType, String inRuleFileName, String inKey) throws com.nt.common.exceptions.APIException
      Specified by:
      getConfigValue in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getDetailsAboutTest

      public TNCDetails getDetailsAboutTest(String testId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • onNodeStatisticsChange

      public void onNodeStatisticsChange(List<NodeUpdateEvent> nodeData)
      Description copied from interface: TNCEventReceiverIfc
      Handles changes in node statistics.
      Specified by:
      onNodeStatisticsChange in interface TNCEventReceiverIfc
      Parameters:
      nodeData - A List of NodeUpdateEvent objects representing the updated node statistics.

    • onNodeStatusChange

      public void onNodeStatusChange(NodeStatusUpdateEventIfc nodeData)
      Description copied from interface: TNCEventReceiverIfc
      Handles changes in node status.
      Specified by:
      onNodeStatusChange in interface TNCEventReceiverIfc
      Parameters:
      nodeData - The NodeStatusUpdateEventIfc object representing the updated node status.

    • onTestStatusChange

      public void onTestStatusChange(TestStatusChangeEventIfc testStatus)
      Description copied from interface: TNCEventReceiverIfc
      Handles changes in test status.
      Specified by:
      onTestStatusChange in interface TNCEventReceiverIfc

    • onNodeOutputFileAvailable

      public void onNodeOutputFileAvailable(NodeOutputFileAvailableEvent nodeOutputFileAvailable)
      Description copied from interface: TNCEventReceiverIfc
      Handles changes in output file availability
      Specified by:
      onNodeOutputFileAvailable in interface TNCEventReceiverIfc
      Parameters:
      nodeOutputFileAvailable - The NodeOutputFileAvailableEvent object containing the output files data

    • onBulkEvents

      public void onBulkEvents(List<BaseEventIfc> events)
      Description copied from interface: TNCEventReceiverIfc
      Handles bulk events.
      Specified by:
      onBulkEvents in interface TNCEventReceiverIfc
      Parameters:
      events - A List of BaseEventIfc objects representing the bulk events to be processed.

    • onTestAboutToTimeout

      public void onTestAboutToTimeout(TestTimeoutReminderEvent event) throws RemoteException
      Description copied from interface: TNCEventReceiverIfc
      Handles the event when a test is about to timeout.
      Specified by:
      onTestAboutToTimeout in interface TNCEventReceiverIfc
      Parameters:
      event - The TestTimeoutReminderEvent containing information about the test about to timeout.
      Throws:
      RemoteException - If a remote exception occurs during the handling of node status changes.

    • onFreeUpTestResources

      public void onFreeUpTestResources(String testId) throws RemoteException
      Description copied from interface: TNCEventReceiverIfc
      Will be called when the sender is cleaning up the resources allocated for this test.
      Specified by:
      onFreeUpTestResources in interface TNCEventReceiverIfc
      Parameters:
      testId - The identifier of the test being cleaned up.
      Throws:
      RemoteException - If there is a communication-related exception.

    • onRemoveTestListener

      public void onRemoveTestListener(String testId) throws RemoteException
      Description copied from interface: TNCEventReceiverIfc
      Will be called when the sender is removing this listener from test mapping.
      Specified by:
      onRemoveTestListener in interface TNCEventReceiverIfc
      Parameters:
      testId - The identifier of the test being cleaned up.
      Throws:
      RemoteException - If there is a communication-related exception.

    • onRemoveReceiver

      public void onRemoveReceiver(String receiverId) throws RemoteException
      Description copied from interface: TNCEventReceiverIfc
      Will be called when the sender is removing this listener enttirely
      Specified by:
      onRemoveReceiver in interface TNCEventReceiverIfc
      Throws:
      RemoteException - If there is a communication-related exception.

    • addReceiver

      public void addReceiver(String id, TNCEventReceiverIfc recv, String testID)
      Adds a receiver with the specified identifier for a given test. This method handles the subscription with the admin-server, loads the local buffer with events, and then propagates them to the registered receiver. If the local buffer is already populated due to previous registrations for the same test, the local events are propagated without making a call to the admin-server. The local buffer should always contain the latest events, as it is the responsibility of the callback method implementations in this class to populate it upon receiving.
      Parameters:
      id - The unique identifier for the receiver.
      recv - The TNCEventReceiverIfc implementation to be added.
      testID - The unique identifier of the test for which the receiver is added.

    • removeReceiver

      public void removeReceiver(String receiverID)

    • getSol42DescriptorFiles

      public List<String> getSol42DescriptorFiles(String nmID) throws com.nt.common.exceptions.APIException
      Specified by:
      getSol42DescriptorFiles in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • getRuleFileDisplayName

      public String getRuleFileDisplayName(String nodeContext, String ruleFileName) throws com.nt.common.exceptions.APIException
      Specified by:
      getRuleFileDisplayName in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • extendTestTimeout

      public boolean extendTestTimeout(String testId) throws com.nt.common.exceptions.APIException
      Specified by:
      extendTestTimeout in interface AdminServerAPIInterface
      Throws:
      com.nt.common.exceptions.APIException

    • uploadImport

      public ImportMetadata uploadImport(String configuration, byte[] customization) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • updateImportMetadata

      public ImportMetadata updateImportMetadata(String importId, ImportMetadata newMetadata) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • runImport

      public ImportTaskItem runImport(String importId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getCurrentImport

      public ImportLock getCurrentImport() throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getImportTask

      public ImportTaskProgressResponse getImportTask(String importId, String importTaskId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • replicateNode

      public String replicateNode(String sourceNodeId, String destNodeManagerId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • replicateNodeManager

      public boolean replicateNodeManager(NodeManagerReplicateRequest request) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • isNodePartOfRunningTNC

      public boolean isNodePartOfRunningTNC(String nodeId) throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getNodeChainTestCfg

      public NodeChainTestCfg getNodeChainTestCfg() throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • getAllLockedAndRunningTestNodes

      public Set<String> getAllLockedAndRunningTestNodes() throws com.nt.common.exceptions.APIException
      Throws:
      com.nt.common.exceptions.APIException

    • isReceiverValid

      public boolean isReceiverValid()

    • scaleDownNodeManager

      public boolean scaleDownNodeManager(String nmId, boolean isPreBackupCleanup) throws com.nt.common.exceptions.APIException
      make call to scaleDownNodeManager API in adminServer
      Parameters:
      nmId - - nodeManager Id
      isPreBackupCleanup - - if true then all the preBackUp task will be done
      Returns:
      true if scaledown API finishes successfully, else false
      Throws:
      com.nt.common.exceptions.APIException