Package com.nt.udc.admin.server
Class AdminServerImpl
java.lang.Object
java.rmi.server.RemoteObject
java.rmi.server.RemoteServer
java.rmi.server.UnicastRemoteObject
com.nt.udc.admin.server.AdminServerImpl
- All Implemented Interfaces:
AdminServer
,AcctEventListener
,Serializable
,Remote
,EventListener
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class java.rmi.server.RemoteObject
ref
Fields inherited from interface com.nt.udc.admin.server.AdminServer
ADMIN_API_FACTORY_NAME, NODE_API_FACTORY_NAME, SNMP_ADMIN_API_NAME
-
Constructor Summary
ConstructorsConstructorDescriptionAdminServerImpl
(String inOSAHome, int port, int adminSvrRMIPortNum, int aPIMetaFactoryRMIPortNo) constructor without SSLAdminServerImpl
(String inOSAHome, int port, int adminSvrRMIPortNum, int aPIMetaFactoryRMIPortNo, boolean withSSL) constructor for enabling SSL -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addRoute
(String sourceNodeId, String destNodeId, String routeFunction, String rField, Vector rCondition) void
addRRNodeDestination
(String sourceNodeId, String destNodeId) void
addTrapHost
(com.nt.udc.admin.TrapHost host) Adds a new host to the list of SNMP Trap Hostsprotected void
addTrapHostList
(com.nt.udc.admin.TrapHostList hosts, String nmIP, int nmPort) This is a method used by the AdminServerImple to push a complete TrapHostList down to a specific Node Hosts that it is managing.void
addUser
(com.nt.udc.admin.User userToAdd, com.nt.udc.admin.User authUser) Attempts to adduserToAdd
to the list of users for this Admin Server.void
Indicates that the properties of an Admin Server have changed.void
areNodesDeletable
(Vector nodeIds) void
backUpNode
(String nodeId) void
void
void
void
changeRoutingToRR
(String sourceNodeId, String destNodeId) void
cleanOutputBackupNodeChainTest
(String testId) This method cleans output backed up as part of a Node Chain Test.void
clearNMAlarm
(String inIPAddress, int inPort) void
clearNodeAlarm
(String nodeId) void
void
compileNPL
(byte[] nplContent) This method takes nplContent as input and checks for any compilation errorsvoid
completeNodeChainTest
(String testId) This method completes all the tasks required to conclude a Node Chain Test.void
completeNodeChainTest
(String testId, boolean isStale) This method completes all the tasks required to conclude a Node Chain Test.void
copyNPL
(DCNodeTypeIfc inNodeType, String inRuleFileName) boolean
deleteRuleFile
(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inFileName) void
byte[]
exportWithCustomization
(Vector nmListToExport, String exportName) Returns a byte array of Customization content which includes 1.byte[]
exportWithCustomization
(Vector nmList, Vector nodesToExport, String exportName) exportXMLSystemModel
(Vector vctNMItemsToExport) exportXMLSystemModel
(Vector nMItems, Vector nodesToExport) exportXMLSystemModelOfNodeChain
(Vector nodesToExport) boolean
extendTestTimeout
(String testId) Extends the timeout duration for a test by the default timeout value, identified by the given testId.void
fileChanged
(com.nt.udc.admin.FileItem file) Indicates that a system file changed.static String
Returns the LDAP DN for the Admin user of the system.boolean
getAdminSvrAuth
(String adminIp, String nodeIp, int nodePort) getAllLockedAndRunningTestNodesSharingRuleFile
(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName) This method return Set of nodeIds which are using same RuleFile which are under Test.Gets the Admin Server Config object (really just a Hashtable).byte[]
getASLog()
boolean
returns true if authentication is enabledgetCartridgeVersionInfo
(String ip, int port) getConfigValue
(DCNodeTypeIfc inNodeType, String inRuleFileName, String inKey) Retrieves the lock information for the current import, if any.getCurrentPerformanceMetrics
(String ip, int port) getDestNodesInNM
(String srcNode, String host, Integer port) getDetailsAboutTest
(String testId) Retrieves details about a specific test.static String
Returns the LDAP domain currently being used by the system.Returns the Host name of the Data Server.Returns the Port of the Data Server.getExposedFields
(DCNodeTypeIfc inNodeType, String inRuleFileName, String inReason) static String
Returns the LDAP group which indicates the group that users belong to in the directory.The import customization log will be returned.getImportTask
(String importId, String importTaskId) Retrieves information about a specific import task associated with the given import ID and task ID.getInputFields
(DCNodeTypeIfc inNodeType, String inRuleFileName) getInputNodes
(String nodeId) static String
Returns the URL of the LDAP directory that this AdminServer is using for user authentication.getLicensedSet
(Set allTemplates) static String
com.nt.udc.admin.NMItem
getNMInvolvedInTestNodeChain
(NodeChainTestCfgItemReadOnlyIfc testNodeChainConfig) Retrieves a mapping of Node Managers involved in the test node chain.byte[]
getNMVersionInfo
(String ip, int port) This method returns NodeChainTestCfg object.getNodeContext
(String nodeId) com.nt.udc.admin.NodeInfo
getNodeInfo
(String inNodeId) Returns a Vector of NodeItem objectsReturns a Vector of NodeInfo objectsgetNodeList
(String inIPAddress, int inPort) byte[]
getNodeLog
(String inNodeId) boolean
getNodeMgrInfo
(String inIPAddress, int inPort, boolean lastTryFailed) Refreshes the node list and node manager status of the NMItem object stored in the SystemModel.getOutputFields
(DCNodeTypeIfc inNodeType, String inRuleFileName) getOutputNodeChainTest
(String nodeId) This method returns data from output file/s for a node, as part of Node Chain Test.getOutputNodes
(String inNodeId) int
getPort()
boolean
getResetPwdInfo
(com.nt.udc.admin.User user) This method receives the reset password information for given userint
getRole
(com.nt.udc.admin.User user, com.nt.udc.admin.User authUser) Returns the role of the user passed as argumentgetRoleFromDN
(String dnName) byte[]
getRuleFileContent
(com.nt.udc.admin.NodeInfo info, String inFileName) getRuleFileDisplayName
(String nodeContext, String ruleFileName) This methods returns the ruleFileDisplayName for a given rule file.int
getSecondsToPasswordExpiration
(com.nt.udc.admin.User user) This method receives the seconds for password expiration of given userThis method returns the list of names of available descriptor files.com.nt.udc.admin.Template
getTemplate
(String templateId) getTemplateDef
(String templateId) com.nt.udc.admin.TemplateTreeRoot
static long
long
returns the time out value for session expirycom.nt.udc.admin.TrapHostList
Gets list of known SNMP Trap HostsgetUserList
(com.nt.udc.admin.User authUser) Retrieves the list of users that may access this Admin ServergroupNodesBasedOnNM
(ArrayList<String> nodesIds) This function groups nodes managed by the same NM together.boolean
hasAdminPriv
(com.nt.udc.admin.User user) Indicates whether the given User has Administrative privileges for this Admin Serverboolean
importCustomization
(ArrayList nmMaps, byte[] contents) This method receives the content of nmx file from admin client and extracts customization archives of individual node managers and distributes them to appropriate node managers based on node manager map.void
importSystemModel
(List nodeManagerMap, boolean corrIdMap, boolean isNodeChainImport) void
initRegistry
(int rmiPort, int aPIMetaFactoryRMIPortNo) void
integrateRouting
(String epdcHost, Integer epdcPort) void
integrateRoutingCCNMScaleUp
(String ccHost, Integer ccPort) void
void
boolean
boolean
isLicensed
(String templateId) boolean
isNodePartOfRunningTNC
(String nodeId) This method validates whether a node is under test or not.boolean
isReceiverValid
(String reciverId) boolean
isSystemRuleFile
(com.nt.udc.admin.NodeInfo info, String inFileName) boolean
loadRuleClass
(String className) Attempts to load the given class name.void
loadXMLSystemModel
(String xmlSystemModel) login
(com.nt.udc.admin.User user) Authenticates the given uservoid
logout
(com.nt.udc.admin.User user) Removes the userId from the AS's current list of usersstatic void
void
modifyTrapHost
(com.nt.udc.admin.TrapHost oldhost, com.nt.udc.admin.TrapHost newhost) Modifies a host in the list of SNMP Trap Hostsvoid
modifyUser
(com.nt.udc.admin.User userToAdd, com.nt.udc.admin.User authUser, Boolean changePassword) Attempts to modify attributes foruserToMod
void
nodeChanged
(com.nt.udc.admin.NMItem nmItem) Indicates that the properties of a Node have changed.void
nodeManagerChanged
(com.nt.udc.admin.NMItem nmItem) Indicates that the properties of a Node Manager have changed.void
nodeManagersAdded
(Vector nmList) Indicates that one or more NodeManagers were added.void
nodeManagersRemoved
(Vector nmList) Indicates that one or more NodeManagers were removed.void
nodePerformanceUpdate
(Vector perfs) Indicates that node performance information was updated.void
nodesAdded
(com.nt.udc.admin.NMItem nmItem) Indicates that a Node has been added to a particular Node Manager.void
nodesRemoved
(com.nt.udc.admin.NMItem nmItem) Indicates that a Node has been removed from a particular Node Manager.boolean
nplChanged
(com.nt.udc.admin.NodeInfo nodeInfo) Always returns true.void
performConfigAction
(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo nodeInfo) void
performConfigAction
(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo nodeInfo, String ipAddr, int port) void
void
void
registerTNCEventReceiver
(String id, TNCEventReceiverIfc tncRec, boolean registerForAllTests) Registers a TNC event receiver with optional registration for all tests.void
reloadNPL
(com.nt.udc.admin.NodeInfo nodeInfo) boolean
reMapWalletPassword
(String nodeId, List<int[]> indicesList) This method is used to map wallet passwords from old index to new index.void
void
removeNM
(com.nt.udc.admin.NMItem nmItem) void
void
void
removeNodes
(Vector inNodeIds) void
removeOutputNodes
(String inNodeId, Vector inNodeOutputs) removeRoute
(String sourceNodeId, String destNodeId) void
removeRRNodeDestination
(String destNodeId) void
removeTrapHost
(com.nt.udc.admin.TrapHost host) Removes a host from the list of SNMP Trap Hostsvoid
removeTrapHosts
(Vector hosts) Removes a list of hosts from the SNMP Trap Hosts objectvoid
removeUsers
(Vector userList, com.nt.udc.admin.User authUser) Attempts to remove the Users contained inuserList
from the list of users for this Admin Server.replicateNode
(String sourceNodeId, String destNodeManagerId) Replicates a node to with the given nodeId to a destination node manager.boolean
Replicates the node manager based on the provided request.Initiates the execution of an import operation with the specified import ID.void
runNodeChainTest
(String uploadId, NodeChainTestCfgItem cfgItem) This method writes test cfg item to nodeChainTest.cfg file and runs all the nodes which are part of node chain under test.boolean
scaleDownNodeManager
(String nmId, boolean isPreBackupCleanup) scaleDown node manager based on the provided flag.static void
setAdminDN
(String newDN) Sets the LDAP DN for the Admin user of the system.void
setASConfig
(Hashtable asConfig) Sets the Admin Server Config object.void
setDirConnection
(DirectoryConnection dirconn) static void
Sets the LDAP domain to be used by the system.static void
setGroupInfo
(String newGroup) Sets the LDAP group which indicates the group that users should belong to in the directory.void
setImportExportProperty
(String[][] newNmMap) static void
setLdapURL
(String newURL) Sets the URL of the LDAP directory that this AdminServer is using for user authentication.static void
setMemberInfo
(String info) static void
this method is used for unit testsvoid
setNodeDescription
(com.nt.udc.admin.NodeInfo nInfo) Replaces the NodeInfo object withnodeInfo
for the given Node contained innodeInfo
.void
setNodeInfo
(com.nt.udc.admin.NodeInfo nodeInfo) Locates the reference to nodeManager for the given nodeId, and invokes the setNodeInfo() method of the nodeManager located, with the given nodeInfo.void
setOutputNodes
(String inNodeId, Vector inNodeOutputs) void
setRefreshInterval
(long inRefInt) static void
setTimeoutValue
(long value) void
shutdown()
shutdown the admin servervoid
shutdown
(int exitCode) void
startAllNodes
(String inIPAddress, int inPort) void
startNodes
(Vector inNodeIds) void
startNodesInternal
(Vector inNodeIds) void
stopAllNodes
(String inIPAddress, int inPort) void
void
stopNodesInternal
(Vector inNodeIds) void
subscribeReceiverForTest
(String receiverID, String testID) Subscribes a receiver to receive events for a specific test.void
systemUpdate
(SystemModel model) Indicates that the system has substantially changed.updateImportMetadata
(String importId, ImportMetadata newMetadata) Updates the metadata associated with a specific import.updateRoute
(String sourceNodeId, String destNodeId, String routeFunction) updateRoute
(String sourceNodeId, String destNodeId, String routeFunction, String rField, Vector rCondition) updateRouteParameters
(String sourceNodeId, String destNodeId, String rField, Vector rCondition) void
updateRuleFileContent
(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inRuleFileName, byte[] ruleFileContent) uploadImport
(String configuration, byte[] customization) Uploads an import with the provided configuration and customization data.void
uploadNodeChainTestInputFile
(byte[] data, String nodeId, String fileName) This method backs up input directory for a node if backup flag is set to true, and uploads the input file to the upload location provided.boolean
validateNMForNodeTypes
(String includeExclude, String majMin, String host, Integer port) void
validateNmMaps
(List<com.nt.udc.upgrade.NodeManagerMap> nmMaps) void
validateNMName
(String inName) void
writeImportNodeCorrelationMap
(String parent, String replicated) Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
-
Field Details
-
SERVER_NAME
-
IS_CNE_ENV
- See Also:
-
OCOMC_AS_EVENT_SENDER_THREAD_COUNT_ENV
- See Also:
-
OCOMC_AS_EVENT_SENDER_THREAD_COUNT_PROP
- See Also:
-
OCOMC_AS_EVENT_SENDER_FORCE_SYNC_PROP
- See Also:
-
OCOMC_AS_EVENT_SENDER_FORCE_SYNC_ENV
- See Also:
-
-
Constructor Details
-
AdminServerImpl
public AdminServerImpl(String inOSAHome, int port, int adminSvrRMIPortNum, int aPIMetaFactoryRMIPortNo, boolean withSSL) throws RemoteException constructor for enabling SSL- Parameters:
inOSAHome
- OSAHome is the installation directory for Network Mediationport
- Admin Server portadminSvrRMIPortNum
- RMI port for Admin ServeraPIMetaFactoryRMIPortNo
-withSSL
- indicates Admin Server should run in SSL mode or not- Throws:
RemoteException
-
AdminServerImpl
public AdminServerImpl(String inOSAHome, int port, int adminSvrRMIPortNum, int aPIMetaFactoryRMIPortNo) throws RemoteException constructor without SSL- Parameters:
inOSAHome
- OSAHome is the installation directory for Network Mediationport
- Admin Server PortadminSvrRMIPortNum
- RMI port for Admin serveraPIMetaFactoryRMIPortNo
-- Throws:
RemoteException
-
-
Method Details
-
getPort
public int getPort() -
getOsaHome
- Specified by:
getOsaHome
in interfaceAdminServer
-
getLogger
-
isHostBasedEnv
- Specified by:
isHostBasedEnv
in interfaceAdminServer
- Throws:
RemoteException
-
getEventSender
- Specified by:
getEventSender
in interfaceAdminServer
- Throws:
RemoteException
-
addAcctEventListener
- Specified by:
addAcctEventListener
in interfaceAdminServer
- Throws:
RemoteException
-
registerTNCEventReceiver
public void registerTNCEventReceiver(String id, TNCEventReceiverIfc tncRec, boolean registerForAllTests) throws RemoteException Registers a TNC event receiver with optional registration for all tests. This method registers a TNCEventReceiverIfc implementation with the provided identifier, allowing an option to register for events across all tests.- Specified by:
registerTNCEventReceiver
in interfaceAdminServer
- Parameters:
id
- The unique identifier for the TNC event receiver.tncRec
- The TNCEventReceiverIfc implementation to be registered.registerForAllTests
- A boolean flag indicating whether to register for events across all tests.- Throws:
RemoteException
- If a remote exception occurs during the registration process.
-
subscribeReceiverForTest
Subscribes a receiver to receive events for a specific test. This method subscribes a receiver identified by receiverID to receive events associated with the specified testID.- Specified by:
subscribeReceiverForTest
in interfaceAdminServer
- Parameters:
testID
- The unique identifier of the test for which the receiver is subscribing.recieverID
- The unique identifier of the receiver to be subscribed.- Throws:
RemoteException
- If a remote exception occurs during the subscription process.
-
removeAcctEventListener
- Specified by:
removeAcctEventListener
in interfaceAdminServer
- Throws:
RemoteException
-
getSystemModel
- Specified by:
getSystemModel
in interfaceAdminServer
- Throws:
RemoteException
-
checkImportStatus
- Specified by:
checkImportStatus
in interfaceAdminServer
-
importSystemModel
public void importSystemModel(List nodeManagerMap, boolean corrIdMap, boolean isNodeChainImport) throws com.nt.udc.upgrade.ImportException - Specified by:
importSystemModel
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ImportException
-
doBackUp
- Specified by:
doBackUp
in interfaceAdminServer
- Throws:
BulkOpException
RemoteException
-
validateNmMaps
- Specified by:
validateNmMaps
in interfaceAdminServer
- Throws:
RemoteException
-
loadXMLSystemModel
- Specified by:
loadXMLSystemModel
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ImportException
-
getImportedNodeManagerMap
- Specified by:
getImportedNodeManagerMap
in interfaceAdminServer
-
exportXMLSystemModel
public String exportXMLSystemModel(Vector vctNMItemsToExport) throws com.nt.udc.upgrade.ExportException - Specified by:
exportXMLSystemModel
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ExportException
-
exportXMLSystemModel
public String exportXMLSystemModel(Vector nMItems, Vector nodesToExport) throws com.nt.udc.upgrade.ExportException - Specified by:
exportXMLSystemModel
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ExportException
-
exportXMLSystemModelOfNodeChain
public String exportXMLSystemModelOfNodeChain(Vector nodesToExport) throws com.nt.udc.upgrade.ExportException - Specified by:
exportXMLSystemModelOfNodeChain
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ExportException
-
exportXMLSystemModel
- Specified by:
exportXMLSystemModel
in interfaceAdminServer
- Throws:
com.nt.udc.upgrade.ExportException
-
shutdown
shutdown the admin server- Specified by:
shutdown
in interfaceAdminServer
- Throws:
RemoteException
-
shutdown
- Throws:
RemoteException
-
setDirConnection
- Specified by:
setDirConnection
in interfaceAdminServer
- Throws:
RemoteException
-
getNodeMgrInfo
public boolean getNodeMgrInfo(String inIPAddress, int inPort, boolean lastTryFailed) throws RemoteException Refreshes the node list and node manager status of the NMItem object stored in the SystemModel. This method is called from the NMConnector thread during AdminServer startup.- Parameters:
inIPAddress
- IP address of the node managerinPort
- RMI port of the node manager- Returns:
- true or false, indicating successful/unsuccessful connection
- Throws:
RemoteException
-
getAdminSvrAuth
- Specified by:
getAdminSvrAuth
in interfaceAdminServer
- Throws:
RemoteException
-
getNMList
- Specified by:
getNMList
in interfaceAdminServer
- Throws:
RemoteException
-
getNM
- Specified by:
getNM
in interfaceAdminServer
- Throws:
RemoteException
-
validateNMName
- Throws:
NodeMgrAddException
-
addNM
public void addNM(String inIPAddress, String inName, int inPort) throws NodeMgrAddException, FileAccessException, RemoteException - Specified by:
addNM
in interfaceAdminServer
- Throws:
NodeMgrAddException
FileAccessException
RemoteException
-
changeNM
public void changeNM(String inIPAddress, String inName, int inPort) throws RemoteException, NodeMgrAddException - Specified by:
changeNM
in interfaceAdminServer
- Throws:
RemoteException
NodeMgrAddException
-
changeNM
- Specified by:
changeNM
in interfaceAdminServer
- Throws:
RemoteException
NodeMgrAddException
-
changeNM
public void changeNM(com.nt.udc.admin.NMItem nmItem, String inName) throws RemoteException, NodeMgrAddException - Throws:
RemoteException
NodeMgrAddException
-
removeNM
public void removeNM(String inIPAddress, int inPort) throws FileAccessException, NodeMgrRemoveException, RemoteException - Specified by:
removeNM
in interfaceAdminServer
- Throws:
FileAccessException
NodeMgrRemoveException
RemoteException
-
removeNM
- Specified by:
removeNM
in interfaceAdminServer
- Throws:
FileAccessException
NodeMgrRemoveException
RemoteException
-
removeNM
public void removeNM(com.nt.udc.admin.NMItem nmItem) throws FileAccessException, NodeMgrRemoveException, RemoteException -
getNodeList
Returns a Vector of NodeInfo objects- Specified by:
getNodeList
in interfaceAdminServer
- Throws:
RemoteException
-
getNodeList
- Specified by:
getNodeList
in interfaceAdminServer
- Throws:
RemoteException
-
getNodeItemList
Returns a Vector of NodeItem objects- Specified by:
getNodeItemList
in interfaceAdminServer
- Throws:
RemoteException
-
addNode
public String addNode(String inIPAddress, int Port, com.nt.udc.admin.NodeInfo nodeInfo, boolean regNodeId) throws FileAccessException, NodeAddException, RemoteException - Specified by:
addNode
in interfaceAdminServer
- Throws:
FileAccessException
NodeAddException
RemoteException
-
addNode
public String addNode(String inIPAddress, int Port, com.nt.udc.admin.NodeInfo nodeInfo) throws FileAccessException, NodeAddException, RemoteException - Specified by:
addNode
in interfaceAdminServer
- Throws:
FileAccessException
NodeAddException
RemoteException
-
setImportExportProperty
- Specified by:
setImportExportProperty
in interfaceAdminServer
- Throws:
RemoteException
-
nplChanged
Always returns true.- Specified by:
nplChanged
in interfaceAdminServer
- Throws:
RemoteException
-
loadRuleClass
Attempts to load the given class name. -
backUpNode
- Specified by:
backUpNode
in interfaceAdminServer
- Throws:
RemoteException
-
removeNodes
- Specified by:
removeNodes
in interfaceAdminServer
- Throws:
BulkOpException
RemoteException
-
areNodesDeletable
- Specified by:
areNodesDeletable
in interfaceAdminServer
- Throws:
BulkOpException
-
getOutputNodes
- Specified by:
getOutputNodes
in interfaceAdminServer
- Throws:
RemoteException
NodeNotFoundException
-
setOutputNodes
public void setOutputNodes(String inNodeId, Vector inNodeOutputs) throws FileAccessException, RemoteException, NodeNotFoundException - Specified by:
setOutputNodes
in interfaceAdminServer
- Throws:
FileAccessException
RemoteException
NodeNotFoundException
-
removeOutputNodes
- Specified by:
removeOutputNodes
in interfaceAdminServer
- Throws:
RemoteException
-
getTemplateTree
public com.nt.udc.admin.TemplateTreeRoot getTemplateTree()- Specified by:
getTemplateTree
in interfaceAdminServer
-
getTemplate
- Specified by:
getTemplate
in interfaceAdminServer
-
getTemplateDef
-
isLicensed
- Throws:
RemoteException
-
getLicensedSet
- Specified by:
getLicensedSet
in interfaceAdminServer
- Throws:
RemoteException
-
getSiteInfo
- Specified by:
getSiteInfo
in interfaceAdminServer
-
getLicenses
- Specified by:
getLicenses
in interfaceAdminServer
-
getRuleFileContent
public byte[] getRuleFileContent(com.nt.udc.admin.NodeInfo info, String inFileName) throws RemoteException - Specified by:
getRuleFileContent
in interfaceAdminServer
- Throws:
RemoteException
-
updateRuleFileContent
public void updateRuleFileContent(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inRuleFileName, byte[] ruleFileContent) throws RemoteException - Specified by:
updateRuleFileContent
in interfaceAdminServer
- Throws:
RemoteException
-
isSystemRuleFile
public boolean isSystemRuleFile(com.nt.udc.admin.NodeInfo info, String inFileName) throws RemoteException - Specified by:
isSystemRuleFile
in interfaceAdminServer
- Throws:
RemoteException
-
deleteRuleFile
public boolean deleteRuleFile(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inFileName) throws RemoteException - Specified by:
deleteRuleFile
in interfaceAdminServer
- Throws:
RemoteException
-
getInputFields
public ArrayList getInputFields(DCNodeTypeIfc inNodeType, String inRuleFileName) throws RemoteException - Throws:
RemoteException
-
getOutputFields
public ArrayList getOutputFields(DCNodeTypeIfc inNodeType, String inRuleFileName) throws RemoteException - Specified by:
getOutputFields
in interfaceAdminServer
- Throws:
RemoteException
-
getExposedFields
public ArrayList getExposedFields(DCNodeTypeIfc inNodeType, String inRuleFileName, String inReason) throws RemoteException - Specified by:
getExposedFields
in interfaceAdminServer
- Throws:
RemoteException
-
getConfigValue
public String getConfigValue(DCNodeTypeIfc inNodeType, String inRuleFileName, String inKey) throws RemoteException - Specified by:
getConfigValue
in interfaceAdminServer
- Throws:
RemoteException
-
copyNPL
- Specified by:
copyNPL
in interfaceAdminServer
- Throws:
RemoteException
-
getASLog
- Specified by:
getASLog
in interfaceAdminServer
- Throws:
FileAccessException
RemoteException
-
getNMLog
- Specified by:
getNMLog
in interfaceAdminServer
- Throws:
RemoteException
-
getNodeLog
- Specified by:
getNodeLog
in interfaceAdminServer
- Throws:
RemoteException
-
getStatus
- Specified by:
getStatus
in interfaceAdminServer
-
startNodes
- Specified by:
startNodes
in interfaceAdminServer
- Throws:
BulkOpException
RemoteException
-
startNodesInternal
- Throws:
BulkOpException
RemoteException
-
stopNodes
- Specified by:
stopNodes
in interfaceAdminServer
- Throws:
BulkOpException
RemoteException
-
stopNodesInternal
- Throws:
BulkOpException
RemoteException
-
startAllNodes
- Specified by:
startAllNodes
in interfaceAdminServer
- Throws:
RemoteException
-
stopAllNodes
- Specified by:
stopAllNodes
in interfaceAdminServer
- Throws:
RemoteException
-
getCurrentPerformanceMetrics
- Specified by:
getCurrentPerformanceMetrics
in interfaceAdminServer
- Throws:
RemoteException
-
compileNPL
This method takes nplContent as input and checks for any compilation errors- Specified by:
compileNPL
in interfaceAdminServer
- Parameters:
nplContent
- content of the npl to be compiled- Throws:
RemoteException
- in case of any error during the compilation
-
reloadNPL
- Specified by:
reloadNPL
in interfaceAdminServer
- Throws:
RemoteException
-
setNodeDescription
Description copied from interface:AdminServer
Replaces the NodeInfo object withnodeInfo
for the given Node contained innodeInfo
. This only updates the NodeInfo object in the table and does not save the node's configuration file(s), or cause node reconfiguration.- Specified by:
setNodeDescription
in interfaceAdminServer
- Parameters:
nInfo
- NodeInfo object for node.- Throws:
RemoteException
-
setNodeInfo
Locates the reference to nodeManager for the given nodeId, and invokes the setNodeInfo() method of the nodeManager located, with the given nodeInfo.- Specified by:
setNodeInfo
in interfaceAdminServer
- Throws:
RemoteException
-
reMapWalletPassword
This method is used to map wallet passwords from old index to new index.- Specified by:
reMapWalletPassword
in interfaceAdminServer
- Parameters:
nodeId
- Node's identifierindicesList
- List of int array, where each int array will have 2 indices, 0th index denotes old row index,and 1st index denotes new row index- Throws:
RemoteException
- RemoteException
-
getNodeInfo
- Specified by:
getNodeInfo
in interfaceAdminServer
- Throws:
RemoteException
-
clearNMAlarm
- Specified by:
clearNMAlarm
in interfaceAdminServer
- Throws:
RemoteException
-
clearNodeAlarm
- Specified by:
clearNodeAlarm
in interfaceAdminServer
- Throws:
RemoteException
-
refreshStatuses
- Specified by:
refreshStatuses
in interfaceAdminServer
- Throws:
RemoteException
-
getVersionInfo
- Specified by:
getVersionInfo
in interfaceAdminServer
- Throws:
RemoteException
-
getCartridgeVersionInfo
- Specified by:
getCartridgeVersionInfo
in interfaceAdminServer
- Throws:
RemoteException
-
getNMVersionInfo
- Specified by:
getNMVersionInfo
in interfaceAdminServer
- Throws:
RemoteException
-
login
Description copied from interface:AdminServer
Authenticates the given user- Specified by:
login
in interfaceAdminServer
- Throws:
RemoteException
AuthenticationException
-
logout
Description copied from interface:AdminServer
Removes the userId from the AS's current list of users- Specified by:
logout
in interfaceAdminServer
- Throws:
RemoteException
-
hasAdminPriv
public boolean hasAdminPriv(com.nt.udc.admin.User user) throws RemoteException, AuthenticationException Description copied from interface:AdminServer
Indicates whether the given User has Administrative privileges for this Admin Server- Specified by:
hasAdminPriv
in interfaceAdminServer
- Throws:
RemoteException
AuthenticationException
-
getRole
public int getRole(com.nt.udc.admin.User user, com.nt.udc.admin.User authUser) throws AuthenticationException Description copied from interface:AdminServer
Returns the role of the user passed as argument- Specified by:
getRole
in interfaceAdminServer
- Throws:
AuthenticationException
-
getUserList
public Vector getUserList(com.nt.udc.admin.User authUser) throws RemoteException, AuthenticationException Description copied from interface:AdminServer
Retrieves the list of users that may access this Admin Server- Specified by:
getUserList
in interfaceAdminServer
- Returns:
- Vector of User objects
- Throws:
RemoteException
AuthenticationException
-
getRoleFromDN
-
addUser
public void addUser(com.nt.udc.admin.User userToAdd, com.nt.udc.admin.User authUser) throws AuthenticationException, RemoteException Description copied from interface:AdminServer
Attempts to adduserToAdd
to the list of users for this Admin Server.- Specified by:
addUser
in interfaceAdminServer
- Throws:
AuthenticationException
- ifauthUser
does not have Administrative privilegesRemoteException
-
modifyUser
public void modifyUser(com.nt.udc.admin.User userToAdd, com.nt.udc.admin.User authUser, Boolean changePassword) throws AuthenticationException, RemoteException Description copied from interface:AdminServer
Attempts to modify attributes foruserToMod
- Specified by:
modifyUser
in interfaceAdminServer
- Throws:
AuthenticationException
- ifauthUser
does not have Administrative privileges foruserToMod
RemoteException
-
removeUsers
public void removeUsers(Vector userList, com.nt.udc.admin.User authUser) throws AuthenticationException, RemoteException Description copied from interface:AdminServer
Attempts to remove the Users contained inuserList
from the list of users for this Admin Server.- Specified by:
removeUsers
in interfaceAdminServer
- Parameters:
userList
- Vector of User objects- Throws:
AuthenticationException
- ifauthUser
does not have Administrative privilegesRemoteException
-
getDSHost
Returns the Host name of the Data Server.- Specified by:
getDSHost
in interfaceAdminServer
- Throws:
RemoteException
-
getDSPort
Returns the Port of the Data Server.- Specified by:
getDSPort
in interfaceAdminServer
- Throws:
RemoteException
-
getLdapURL
Returns the URL of the LDAP directory that this AdminServer is using for user authentication. -
setLdapURL
Sets the URL of the LDAP directory that this AdminServer is using for user authentication. -
getAdminDN
Returns the LDAP DN for the Admin user of the system. -
setAdminDN
Sets the LDAP DN for the Admin user of the system. -
getDomain
Returns the LDAP domain currently being used by the system. -
setDomain
Sets the LDAP domain to be used by the system. -
getGroupInfo
Returns the LDAP group which indicates the group that users belong to in the directory. -
setGroupInfo
Sets the LDAP group which indicates the group that users should belong to in the directory. -
getMemberInfo
-
setMemberInfo
-
getTimeoutValue
public static long getTimeoutValue() -
setTimeoutValue
public static void setTimeoutValue(long value) -
nodeManagersAdded
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 interfaceAcctEventListener
- Throws:
RemoteException
-
nodeManagersRemoved
Description copied from interface:AcctEventListener
Indicates that one or more NodeManagers were removed.- Specified by:
nodeManagersRemoved
in interfaceAcctEventListener
- Parameters:
nmList
- Vector of NMItem objects representing the Node Managers that were removed.- Throws:
RemoteException
-
nodeManagerChanged
Description copied from interface:AcctEventListener
Indicates that the properties of a Node Manager have changed.- Specified by:
nodeManagerChanged
in interfaceAcctEventListener
- Parameters:
nmItem
- NMItem object representing the Node Manager that changed.- Throws:
RemoteException
-
nodesAdded
Description copied from interface:AcctEventListener
Indicates that a Node has been added to a particular Node Manager.- Specified by:
nodesAdded
in interfaceAcctEventListener
- Parameters:
nmItem
- NMItem object which represents the Node Manager managing the node that was added. The Vector associated withnodeManager
will contain only the node that was added.- Throws:
RemoteException
-
nodesRemoved
Description copied from interface:AcctEventListener
Indicates that a Node has been removed from a particular Node Manager.- Specified by:
nodesRemoved
in interfaceAcctEventListener
- Parameters:
nmItem
- NMItem object which represents the Node Manager managing the node that was removed. The Vector associated withnodeManager
will contain only the node(s) that was(were) removed.- Throws:
RemoteException
-
nodeChanged
Description copied from interface:AcctEventListener
Indicates that the properties of a Node have changed.- Specified by:
nodeChanged
in interfaceAcctEventListener
- Parameters:
nmItem
- NMItem object which represents the Node Manager whose node changed. The Vector associated withnodeManager
will contain the node that changed.- Throws:
RemoteException
-
nodePerformanceUpdate
Description copied from interface:AcctEventListener
Indicates that node performance information was updated.- Specified by:
nodePerformanceUpdate
in interfaceAcctEventListener
- Parameters:
perfs
- Vector of node performance objects
-
fileChanged
Description copied from interface:AcctEventListener
Indicates that a system file changed.- Specified by:
fileChanged
in interfaceAcctEventListener
- Parameters:
file
- FileItem object representing the system file that changed.- Throws:
RemoteException
-
adminServerChanged
Description copied from interface:AcctEventListener
Indicates that the properties of an Admin Server have changed.- Specified by:
adminServerChanged
in interfaceAcctEventListener
- Parameters:
sm
- StatusMessage object representing the change in the AdminServer.- Throws:
RemoteException
-
systemUpdate
Description copied from interface:AcctEventListener
Indicates that the system has substantially changed.- Specified by:
systemUpdate
in interfaceAcctEventListener
- Parameters:
model
- SystemModel representing the current state of the system.- Throws:
RemoteException
-
setRefreshInterval
- Specified by:
setRefreshInterval
in interfaceAdminServer
- Throws:
RemoteException
-
initRegistry
public void initRegistry(int rmiPort, int aPIMetaFactoryRMIPortNo) -
getTrapHostList
Description copied from interface:AdminServer
Gets list of known SNMP Trap Hosts- Specified by:
getTrapHostList
in interfaceAdminServer
- Throws:
RemoteException
-
addTrapHost
Description copied from interface:AdminServer
Adds a new host to the list of SNMP Trap Hosts- Specified by:
addTrapHost
in interfaceAdminServer
- Throws:
RemoteException
-
addTrapHostList
This is a method used by the AdminServerImple to push a complete TrapHostList down to a specific Node Hosts that it is managing. -
removeTrapHost
Description copied from interface:AdminServer
Removes a host from the list of SNMP Trap Hosts- Specified by:
removeTrapHost
in interfaceAdminServer
- Throws:
RemoteException
-
removeTrapHosts
Description copied from interface:AdminServer
Removes a list of hosts from the SNMP Trap Hosts object- Specified by:
removeTrapHosts
in interfaceAdminServer
- Throws:
RemoteException
-
modifyTrapHost
public void modifyTrapHost(com.nt.udc.admin.TrapHost oldhost, com.nt.udc.admin.TrapHost newhost) throws RemoteException Description copied from interface:AdminServer
Modifies a host in the list of SNMP Trap Hosts- Specified by:
modifyTrapHost
in interfaceAdminServer
- Throws:
RemoteException
-
pollRecordCounts
public void pollRecordCounts() -
getConfig
-
getASConfig
Description copied from interface:AdminServer
Gets the Admin Server Config object (really just a Hashtable).- Specified by:
getASConfig
in interfaceAdminServer
- Throws:
RemoteException
-
setASConfig
Description copied from interface:AdminServer
Sets the Admin Server Config object. All original attributes should be present, even if they haven't been changed.- Specified by:
setASConfig
in interfaceAdminServer
- Throws:
RemoteException
-
exportWithCustomization
public byte[] exportWithCustomization(Vector nmListToExport, String exportName) throws RemoteException Returns a byte array of Customization content which includes 1. archives of cartridges and customization folder from all running nodemanagers 2. archive of cartridges and customization folder of admin server 3. VersionInfo.xml which contains version information 4. Configuration xml 5. Export Log.- Specified by:
exportWithCustomization
in interfaceAdminServer
- Parameters:
nmListToExport
- list of node managers for which export should be done.exportName
- exportName is the file name used for writing configuration xml- Returns:
- byte[] the content of complete archive will be returned as a byte array.
- Throws:
RemoteException
-
exportWithCustomization
public byte[] exportWithCustomization(Vector nmList, Vector nodesToExport, String exportName) throws RemoteException - Specified by:
exportWithCustomization
in interfaceAdminServer
- Throws:
RemoteException
-
getImportCustomLog
The import customization log will be returned.- Specified by:
getImportCustomLog
in interfaceAdminServer
- Returns:
- String the contents of import customization log buffer will returned as a String.
-
importCustomization
This method receives the content of nmx file from admin client and extracts customization archives of individual node managers and distributes them to appropriate node managers based on node manager map.- Specified by:
importCustomization
in interfaceAdminServer
- Parameters:
nmMaps
- contains mapping information from old node manager ip:port to new node manager ip:portcontents
- the contents of nmx file as byte array.- Returns:
- boolean returns true if the entire operation is successful. otherwise returns false.
-
getAuthUsers
returns true if authentication is enabled- Specified by:
getAuthUsers
in interfaceAdminServer
- Returns:
- Throws:
RemoteException
-
integrateRoutingCCNMScaleUp
- Specified by:
integrateRoutingCCNMScaleUp
in interfaceAdminServer
-
getDestNodesInNM
- Specified by:
getDestNodesInNM
in interfaceAdminServer
-
clearNodeIdCorrelationsMap
public void clearNodeIdCorrelationsMap()- Specified by:
clearNodeIdCorrelationsMap
in interfaceAdminServer
-
integrateRouting
- Specified by:
integrateRouting
in interfaceAdminServer
-
changeRoutingToRR
- Specified by:
changeRoutingToRR
in interfaceAdminServer
-
integrateScalingDownForNonSegregatedNM
- Specified by:
integrateScalingDownForNonSegregatedNM
in interfaceAdminServer
-
integrateScalingDownForSegregatedNM
- Specified by:
integrateScalingDownForSegregatedNM
in interfaceAdminServer
-
removeRRNodeDestination
-
addRRNodeDestination
- Specified by:
addRRNodeDestination
in interfaceAdminServer
-
removeRoute
- Specified by:
removeRoute
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The destNodeId- Throws:
RemoteException
-
updateRoute
public String updateRoute(String sourceNodeId, String destNodeId, String routeFunction) throws RemoteException - Specified by:
updateRoute
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The sourceNodeIDrouteFunction
- The routingFunction to use, this function just accepts Round Robin and Multicast- Throws:
RemoteException
-
updateRoute
public String updateRoute(String sourceNodeId, String destNodeId, String routeFunction, String rField, Vector rCondition) throws RemoteException - Specified by:
updateRoute
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The sourceNodeIDrouteFunction
- The routingFunction to use, this function should be used only for Directed and ModulusrField
- The routing attribute that should be used (must be present in NPL)rCondition
- For Directed routing, this must be a vector of invalid input: '<'operator,operand1,operands2> where operands1 and operands2 are comma seperated string. Operand2 can be empty string if operator just requres one operand.- Throws:
RemoteException
-
updateRouteParameters
public String updateRouteParameters(String sourceNodeId, String destNodeId, String rField, Vector rCondition) throws RemoteException - Specified by:
updateRouteParameters
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The sourceNodeIDrField
- The routing attribute that should be used (must be present in NPL)rCondition
- For Directed routing, this must be a vector of invalid input: '<'operator,operand1,operands2> where operands1 and operands2 are comma seperated string. Operand2 can be empty string if operator just requres one operand.- Throws:
RemoteException
-
addRoute
public String addRoute(String sourceNodeId, String destNodeId, String routeFunction) throws RemoteException - Specified by:
addRoute
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The sourceNodeIDrouteFunction
- The routingFunction to use, this function just accepts Round Robin and Multicast- Throws:
RemoteException
-
addRoute
public String addRoute(String sourceNodeId, String destNodeId, String routeFunction, String rField, Vector rCondition) throws RemoteException - Specified by:
addRoute
in interfaceAdminServer
- Parameters:
sourceNodeId
- The sourceNodeIDdestNodeId
- The sourceNodeIDrouteFunction
- The routingFunction to use, this function should be used only for Directed and ModulusrField
- The routing attribute that should be used (must be present in NPL)rCondition
- For Directed routing, this must be a vector of invalid input: '<'operator,operand1,operands2> where operands1 and operands2 are comma seperated string. Operand2 can be empty string if operator just requres one operand.- Throws:
RemoteException
-
main
-
getResetPwdInfo
public boolean getResetPwdInfo(com.nt.udc.admin.User user) throws AuthenticationException, RemoteException This method receives the reset password information for given user- Specified by:
getResetPwdInfo
in interfaceAdminServer
- Parameters:
user
- user information for which we want to get the information- Returns:
- boolean returns true if the password is reset by Administrator. otherwise returns false.
- Throws:
AuthenticationException
RemoteException
-
getSecondsToPasswordExpiration
public int getSecondsToPasswordExpiration(com.nt.udc.admin.User user) throws AuthenticationException, RemoteException This method receives the seconds for password expiration of given user- Specified by:
getSecondsToPasswordExpiration
in interfaceAdminServer
- Parameters:
user
- user information for which we want to get the information- Returns:
- boolean returns number of seconds until password expiration
- Throws:
AuthenticationException
RemoteException
-
getTimeoutValueMiliSec
returns the time out value for session expiry- Specified by:
getTimeoutValueMiliSec
in interfaceAdminServer
- Returns:
- Throws:
RemoteException
-
setNoAuthentication
public static void setNoAuthentication()this method is used for unit tests -
performConfigAction
public void performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo nodeInfo) throws RemoteException - Specified by:
performConfigAction
in interfaceAdminServer
- Throws:
RemoteException
-
performConfigAction
public void performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo nodeInfo, String ipAddr, int port) throws RemoteException - Specified by:
performConfigAction
in interfaceAdminServer
- Throws:
RemoteException
-
getInputNodes
- Specified by:
getInputNodes
in interfaceAdminServer
- Throws:
RemoteException
-
writeImportNodeCorrelationMap
- Specified by:
writeImportNodeCorrelationMap
in interfaceAdminServer
- Throws:
RemoteException
-
validateNMForNodeTypes
public boolean validateNMForNodeTypes(String includeExclude, String majMin, String host, Integer port) - Specified by:
validateNMForNodeTypes
in interfaceAdminServer
-
uploadNodeChainTestInputFile
public void uploadNodeChainTestInputFile(byte[] data, String nodeId, String fileName) throws RemoteException This method backs up input directory for a node if backup flag is set to true, and uploads the input file to the upload location provided.- Specified by:
uploadNodeChainTestInputFile
in interfaceAdminServer
- Parameters:
data
- File's datanodeId
- Node's identifierfileName
- File's name, prefixed with test ID.- Throws:
RemoteException
- Exception thrown during a remote call
-
getNodeChainTestCfg
This method returns NodeChainTestCfg object.- Specified by:
getNodeChainTestCfg
in interfaceAdminServer
-
getNMInvolvedInTestNodeChain
public Map<String,List<String>> getNMInvolvedInTestNodeChain(NodeChainTestCfgItemReadOnlyIfc testNodeChainConfig) Retrieves a mapping of Node Managers involved in the test node chain. This method returns a Map where keys represent Node Manager identifiers, and values are Lists of nodeID associated with each Node Manager involved in the specified test node chain configuration.- Parameters:
testNodeChainConfig
- The configuration item for the test node chain.- Returns:
- A Map of Node Managers and associated nodeID participating in the test node chain.
-
getNodeContext
-
groupNodesBasedOnNM
This function groups nodes managed by the same NM together.- Parameters:
nodeIds
- List of identifiers of nodes spread accross 1 or more NMs- Returns:
- Map containing node manager's identifier to list of identifiers of the nodes managed by that NM mapping
-
runNodeChainTest
This method writes test cfg item to nodeChainTest.cfg file and runs all the nodes which are part of node chain under test.- Specified by:
runNodeChainTest
in interfaceAdminServer
- Parameters:
uploadId
- Upload ID of the file uploadedcfgItem
- NodeChainTestCfgItem object- Throws:
RemoteException
- Exception thrown during a remote call
-
getDetailsAboutTest
Retrieves details about a specific test. This method returns information about test and nodes in the test for the provided testId.- Specified by:
getDetailsAboutTest
in interfaceAdminServer
- Parameters:
testId
- The unique identifier of the test for which details are to be retrieved.- Returns:
- A TNCDetails object containing information about the specified test.
- Throws:
RemoteException
- If a communication-related issue occurs during the remote method invocation.
-
getOutputNodeChainTest
This method returns data from output file/s for a node, as part of Node Chain Test.- Specified by:
getOutputNodeChainTest
in interfaceAdminServer
- Parameters:
nodeId
- Node's identifier- Throws:
RemoteException
- Exception thrown during a remote call
-
completeNodeChainTest
This method completes all the tasks required to conclude a Node Chain Test.- Specified by:
completeNodeChainTest
in interfaceAdminServer
- Parameters:
testId
- Identifier of the test- Throws:
RemoteException
- Exception thrown during a remote call
-
completeNodeChainTest
This method completes all the tasks required to conclude a Node Chain Test. This API is internally used, and should not be invoked by clients.- Parameters:
testId
- Identifier of the testisStale
- True if test to be completed is in stale state, else false.
-
cleanOutputBackupNodeChainTest
This method cleans output backed up as part of a Node Chain Test.- Parameters:
testId
- Identifier of the test- Throws:
NodeChainTestException
- Exception thrown if something goes wrong while cleaning output backup
-
getSol42DescriptorFiles
This method returns the list of names of available descriptor files.- Specified by:
getSol42DescriptorFiles
in interfaceAdminServer
- Parameters:
nmId
- Node Manager idendifier- Throws:
RemoteException
- Exception thrown during a remote call
-
getRuleFileDisplayName
public String getRuleFileDisplayName(String nodeContext, String ruleFileName) throws RemoteException This methods returns the ruleFileDisplayName for a given rule file.- Specified by:
getRuleFileDisplayName
in interfaceAdminServer
- Parameters:
nodeContext
- The node context.ruleFileName
- The rule file name to retrieve the display name.- Returns:
- The ruleFileDisplayName of the rule file.
- Throws:
RemoteException
- If an error occurs during the process.
-
extendTestTimeout
Extends the timeout duration for a test by the default timeout value, identified by the given testId.- Specified by:
extendTestTimeout
in interfaceAdminServer
- Parameters:
testId
- The unique identifier of the test to extend the timeout. throws NodeChainTestException- Throws:
RemoteException
-
uploadImport
public ImportMetadata uploadImport(String configuration, byte[] customization) throws ImportUploadException Uploads an import with the provided configuration and customization data.- Specified by:
uploadImport
in interfaceAdminServer
- Parameters:
configuration
- The configuration data for the import.customization
- The customization data for the import, provided as a byte array.- Returns:
- The metadata generated for the uploaded import files.
- Throws:
ImportUploadException
- If an error occurs during the upload process.
-
updateImportMetadata
public ImportMetadata updateImportMetadata(String importId, ImportMetadata newMetadata) throws ImportMetadataUpdateException Updates the metadata associated with a specific import.- Specified by:
updateImportMetadata
in interfaceAdminServer
- Parameters:
importId
- The ID of the import whose metadata is to be updated.newMetadata
- The new metadata to be associated with the import.- Returns:
- The updated metadata for the import.
- Throws:
ImportMetadataUpdateException
- If an error occurs while updating the import metadata.
-
getCurrentImport
Retrieves the lock information for the current import, if any.- Specified by:
getCurrentImport
in interfaceAdminServer
- Returns:
- The ImportLock object representing the lock information for the current import, or null if there is no current import lock.
- Throws:
RemoteException
- If an error occurs while fetching the current import lock.
-
runImport
public ImportTaskItem runImport(String importId) throws ImportStartException, ConcurrentImportException, LongProcessInProgressException Initiates the execution of an import operation with the specified import ID.- Specified by:
runImport
in interfaceAdminServer
- Parameters:
importId
- The ID of the import operation to be initiated.- Returns:
- A taskID, that can be used to track the progress of the import execution.
- Throws:
ImportStartException
- If an error occurs during the initiation of the import operation.ConcurrentImportException
- if another import is in progressLongProcessInProgressException
- If another long process in progress (Currently only TNC and import)
-
getImportTask
public ImportTaskProgressResponse getImportTask(String importId, String importTaskId) throws RemoteException Retrieves information about a specific import task associated with the given import ID and task ID.- Specified by:
getImportTask
in interfaceAdminServer
- Parameters:
importId
- The ID of the import operation.importTaskId
- The ID of the import task to retrieve.- Returns:
- The ImportTaskItem representing information about the specified import task.
- Throws:
RemoteException
- If an error occurs during the retrieval of the import task.ImportTaskNotFoundException
- If the specified import task cannot be found.
-
getAllLockedAndRunningTestNodes
- Specified by:
getAllLockedAndRunningTestNodes
in interfaceAdminServer
- Throws:
RemoteException
-
isNodePartOfRunningTNC
This method validates whether a node is under test or not.- Specified by:
isNodePartOfRunningTNC
in interfaceAdminServer
- Parameters:
nodeId
- The ID of the node.- Throws:
RemoteException
- If an error occurs during the validation for node under test or not.
-
getAllLockedAndRunningTestNodesSharingRuleFile
public Set<String> getAllLockedAndRunningTestNodesSharingRuleFile(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName) throws RemoteException This method return Set of nodeIds which are using same RuleFile which are under Test.- Parameters:
info
- NodeInfo objectinRuleFileDisplayName
- ruleFileDisplay name to match- Returns:
- It returns Set of nodeIds which are under test and belongs to same marketSegment and uses same rulefile
- Throws:
RemoteException
- If an error occurs during the validation for node under test or not.
-
replicateNode
Replicates a node to with the given nodeId to a destination node manager.- Specified by:
replicateNode
in interfaceAdminServer
- Parameters:
sourceNodeId
- the ID of the source node to be replicateddestNodeManagerId
- the ID of the destination node manager where the node will be replicated- Returns:
- Node ID of the replicated node
- Throws:
RemoteException
- if a remote communication error occurs during the replication
-
replicateNodeManager
Replicates the node manager based on the provided request.- Specified by:
replicateNodeManager
in interfaceAdminServer
- Parameters:
request
- the request object containing the details for the node manager replication- Returns:
true
if the replication was successful,false
otherwise- Throws:
RemoteException
- if any exception occurs during the replication
-
isReceiverValid
- Specified by:
isReceiverValid
in interfaceAdminServer
- Throws:
RemoteException
-
scaleDownNodeManager
scaleDown node manager based on the provided flag.- Specified by:
scaleDownNodeManager
in interfaceAdminServer
- Parameters:
nmId
- - NodeManager IdisPreBackupCleanup
- - if true then all the preBackUp tasks will be done- Returns:
true
if the scaleDown was successful,false
otherwise- Throws:
RemoteException
- if any exception occurs during the scaleDown
-