Package com.nt.udc.admin.server

Interface AdminServerAPIInterface

All Known Implementing Classes:

AdminServerAPI, ASProxy

public interface AdminServerAPIInterface

Method Summary

Modifier and Type	Method	Description
void	addNM(String inIPAddress, String inName, int inPort)	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.
String	addNode(String inIPAddress, int inPort, com.nt.udc.admin.NodeInfo nodeInfo)	Add a new node (represented by the NodeInfo object) to the node manager residing at the specified IP Address and port.
String	addRoute(String sourceNodeId, String destNodeId, String routeFunc, 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 Hosts
boolean	addUser(com.nt.udc.admin.User user)	Adds a new User to the current list of valid users
void	changeNM(String id, String inName)
void	changeNM(String inIPAddress, String inName, int inPort)	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.
List	checkImportStatus()
void	clearNMAlarm(String ipAddress, int inPort)	Clears the alarm on a Node Manager
void	clearNodeAlarm(String nodeId)	clears the alarm on a specific node
boolean	clearNodeIdCorrelationsMap()
void	compileNPL(byte[] nplContent)	Compiles given npl content for testing if there are any compilation errors
void	completeNodeChainTest(String testId)
void	copyNPL(DCNodeTypeIfc inNodeType, String inRuleFileName)
boolean	deleteRuleFile(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inFileName)
void	doBackUp(List nodeManagerMap)
byte[]	exportWithCustomization(Vector nmListToExport, String exportName)	returns customization contents of all node managers and adminserver in a byte array
byte[]	exportWithCustomization(Vector nmList, Vector nodesToExport, String exportName)
String	exportXMLSystemModel()
String	exportXMLSystemModel(Vector vctNMItemsToExport)
String	exportXMLSystemModel(Vector vctNMItems, Vector nodesToExport)
String	exportXMLSystemModelOfNodeChain(Vector nodesToExport)
boolean	extendTestTimeout(String testId)
boolean	getAdminSvrAuth(String adminIP, String nodeIp, int nodePort)
Hashtable	getASConfig()	Gets the Admin Server Config object (really just a Hashtable).
byte[]	getASLog()	Return the contents of the log for the Admin Server
boolean	getAuthUsers()	returns true if authentication is enabled
Map	getCartridgeVersionInfo(String ip, int port)	Return a Map containing cartridge name.
String	getConfigValue(DCNodeTypeIfc inNodeType, String inRuleFileName, String inKey)
Vector	getCurrentPerformanceMetrics(String ip, int port)	Return a vector of performance objects
String	getCurrentUserId()	Returns the ID of the user currently accessing the Admin Server through this AdminServerAPI Object
Vector	getDestNodesInNM(String srcNode, String host, Integer port)
String	getDSHost()	Gets Data Server host name
String	getDSPort()	Gets Data Server port
ArrayList	getExposedFields(DCNodeTypeIfc inNodeType, String inRuleFileName, String inReason)	Get the exposed fields from an expose clause of the specified rule file.
String	getImportCustomLog()	returns the log created during import customization.
Vector	getInputNodes(String inNodeId)	Returns a vector of ChannelInfo objects which represents all nodes that sends input to the specified node.
List	getLicenses()
com.nt.udc.admin.NMItem	getNM(String id)
Vector	getNMList()	Returns a vector of NMItem objects which represents all node managers known to the Admin Server.
byte[]	getNMLog(String inIPAddress, int inPort)	Return the contents of the log for the node manager at the specified IP Address/Port.
VersionInfo	getNMVersionInfo(String ip, int port)	Return a String containing info about the java environment and packages on each Node Manager.
com.nt.udc.admin.NodeInfo	getNodeInfo(String inNodeId)	Get a NodeInfo object describing the specified node.
Vector	getNodeItemList()	Returns a vector of NodeItem objects which represents all nodes known to the Admin Server.
Vector	getNodeList()	Returns a vector of NodeInfo objects which represents all nodes known to the Admin Server.
Vector	getNodeList(String inIPAddress, int inPort)	Returns a vector of NodeInfo objects which represents all nodes controlled by the node manager at the specified IP Address/Port.
byte[]	getNodeLog(String nodeId)	Return the contents of the log for the specified node.
String	getOsaHome()
ArrayList	getOutputFields(DCNodeTypeIfc inNodeType, String inRuleFileName)	Get the output fields in the specified rule file.
List<NodeChainOutputRecords>	getOutputNodeChainTest(String nodeId)
Vector	getOutputNodes(String inNodeId)	Returns a vector of ChannelInfo objects which represents all nodes that receive output from the specified node.
int	getRole(com.nt.udc.admin.User user)	Returns the role of the user passed as argument
byte[]	getRuleFileContent(com.nt.udc.admin.NodeInfo info, String inFileName)	Get the content of the RulesFile with the passed-in name.
String	getRuleFileDisplayName(String nodeContext, String ruleFileName)
Map	getSiteInfo()
List<String>	getSol42DescriptorFiles(String nmID)
StatusMessage	getStatus()	Return status of AS
SystemModel	getSystemModel()
com.nt.udc.admin.Template	getTemplate(String templateId)
com.nt.udc.admin.TemplateTreeRoot	getTemplateTree()
com.nt.udc.admin.TrapHostList	getTrapHostList()	Gets list of known SNMP Trap Hosts
Vector	getUserList()	Retrieves the current list of valid user ids known to the Admin Server.
VersionInfo	getVersionInfo()	Return a String containing info about the java environment and packages on the Admin Server.
List	getXMLNodeManagerMap()
boolean	hasAdminPriv()	Indicates whether the current user has Administrative privileges
boolean	importCustomization(ArrayList nmMaps, byte[] contents)	distributes the customization contents to all node managers and adminserver
void	importSystemModel(List nodeManagerMap, boolean corrIdMap, boolean isNodeChainImport)
void	integrateRouting(String parentHost, Integer parentPort)
boolean	integrateRoutingCCNMScaleUp(String ccHost, Integer ccPort)
void	integrateScalingDownForNonSegregatedNM(String nmlist)
void	integrateScalingDownForSegregatedNM(String nmlist)
boolean	isSystemRuleFile(com.nt.udc.admin.NodeInfo info, String inFileName)
void	loadXMLSystemModel(String xmlSystemModel)
void	login(com.nt.udc.admin.User user)	Attempts to authenticate the given user with the Admin Server
void	logout()	Logs out the current user
void	modifyTrapHost(com.nt.udc.admin.TrapHost oldhost, com.nt.udc.admin.TrapHost newhost)	Modifies a host in the list of SNMP Trap Hosts
boolean	modifyUser(com.nt.udc.admin.User user, Boolean changePassword)	Modifies attributes associated with the given User
boolean	nplChanged(com.nt.udc.admin.NodeInfo info)	Indicates whether the NPL file indicated in the given NodeInfo object has changed since the AdminServer was started.
void	performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo ni)	Config Action specific to node
void	performConfigAction(ConfigActionIfc configActionObject, com.nt.udc.admin.NodeInfo ni, String ipAddress, int port)
void	reloadNPL(com.nt.udc.admin.NodeInfo info)	Instructs the AdminServer to recompile the NPL file indicated in the given NodeInfo object.
boolean	reMapWalletPassword(String nodeId, List<int[]> indicesList)
void	removeNM(String id)
void	removeNM(String inIPAddress, int inPort)	Tell the Admin Server to remove the node manager at the specified IP Address/Port.
void	removeNodes(Vector inNodeIds)	Expects a vector of nodeID (string) objects.
void	removeOutputNodes(String inNodeId, Vector inOutputNodes)	Expects a nodeID (string) and a vector of nodeID (string) objects.
String	removeRoute(String sourceNodeId, String destNodeId)
void	removeTrapHost(com.nt.udc.admin.TrapHost host)	Removes a host from the list of SNMP Trap Hosts
void	removeTrapHosts(Vector hosts)	Remove multiple hosts from the list of SNMP Trap Hosts
boolean	removeUsers(Vector userList)	Removes the given Users from the current list of valid users
void	runNodeChainTest(String uploadId, NodeChainTestCfgItem cfgItem)
void	setASConfig(Hashtable asConfig)	Sets the Admin Server Config object.
void	setImportExportProperty(String[][] newNmMap)
void	setNodeDescription(com.nt.udc.admin.NodeInfo nodeInfo)	Modify the parameters of the specified node to be in accordance with the passed-in NodeInfo object.
void	setNodeInfo(com.nt.udc.admin.NodeInfo nodeInfo)	Modify the parameters of the specified node to be in accordance with the passed-in NodeInfo object.
void	setNodeOutputs(String inNodeId, Vector inNodeOutputs)	Expects a nodeID (string) and a vector of nodeID (string) objects.
void	setRefreshInterval(long inRefInt)	Sets the interval (in seconds) at which the statuses of all Node Managers and Nodes are refreshed
void	startAllNodes(String inIPAddress, int inPort)	Start all nodes on the node manager at the specified IP Address/Port.
void	startNodes(Vector inNodeIds)	Expects a vector of nodeID (string) objects.
void	stopAllNodes(String inIPAddress, int inPort)	Stop all nodes on the node manager at the specified IP Address.
void	stopNodes(Vector inNodeIds)	Expects a vector of nodeID (string) objects.
String	updateRoute(String sourceNodeId, String destNodeId, String routeFunc, String rField, Vector rCondition)
String	updateRouteParameters(String sourceNodeId, String destNodeId, String rField, Vector rCondition)
void	updateRuleFileContent(com.nt.udc.admin.NodeInfo info, String inRuleFileDisplayName, String inRuleFileName, byte[] ruleFileContent)
void	uploadNodeChainTestInputFile(byte[] data, String nodeId, String fileName)
boolean	validateNMForNodeTypes(String inclusionExclusion, String majMin, String host, Integer port)
void	validateNmMaps(ArrayList<com.nt.udc.upgrade.NodeManagerMap> nmMaps)

Method Details

getStatus

StatusMessage getStatus()
                 throws com.nt.common.exceptions.APIException

Return status of AS

Throws:

com.nt.common.exceptions.APIException

getVersionInfo

VersionInfo getVersionInfo()
                    throws com.nt.common.exceptions.APIException

Return a String containing info about the java environment and packages on the Admin Server.

Throws:

com.nt.common.exceptions.APIException

getNMVersionInfo

VersionInfo getNMVersionInfo(String ip,
 int port)
                      throws com.nt.common.exceptions.APIException

Return a String containing info about the java environment and packages on each Node Manager.

Throws:

com.nt.common.exceptions.APIException

getCartridgeVersionInfo

Map getCartridgeVersionInfo(String ip,
 int port)
                     throws com.nt.common.exceptions.APIException

Return a Map containing cartridge name. InputSteam pairs.

Throws:

com.nt.common.exceptions.APIException

getNMList

Vector getNMList()
          throws com.nt.common.exceptions.APIException

Returns a vector of NMItem objects which represents all node managers known to the Admin Server.

Throws:

com.nt.common.exceptions.APIException

getAdminSvrAuth

boolean getAdminSvrAuth(String adminIP,
 String nodeIp,
 int nodePort)
                 throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getNodeList

Vector getNodeList()
            throws com.nt.common.exceptions.APIException

Returns a vector of NodeInfo objects which represents all nodes known to the Admin Server.

Throws:

com.nt.common.exceptions.APIException

getNodeList

Vector getNodeList(String inIPAddress,
 int inPort)
            throws com.nt.common.exceptions.APIException

Returns a vector of NodeInfo objects which represents all nodes controlled by the node manager at the specified IP Address/Port.

Throws:

com.nt.common.exceptions.APIException

getNodeItemList

Vector getNodeItemList()
                throws com.nt.common.exceptions.APIException

Returns a vector of NodeItem objects which represents all nodes known to the Admin Server.

Throws:

com.nt.common.exceptions.APIException

getOutputNodes

Vector getOutputNodes(String inNodeId)
               throws com.nt.common.exceptions.APIException

Returns a vector of ChannelInfo objects which represents all nodes that receive output from the specified node.

Throws:

com.nt.common.exceptions.APIException

getInputNodes

Vector getInputNodes(String inNodeId)
              throws com.nt.common.exceptions.APIException

Returns a vector of ChannelInfo objects which represents all nodes that sends input to the specified node.

Throws:

com.nt.common.exceptions.APIException

setNodeOutputs

void setNodeOutputs(String inNodeId,
 Vector inNodeOutputs)
             throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

removeOutputNodes

void removeOutputNodes(String inNodeId,
 Vector inOutputNodes)
                throws com.nt.common.exceptions.APIException

Expects a nodeID (string) and a vector of nodeID (string) objects. Remove the specified output nodes from the specified node.

Throws:

com.nt.common.exceptions.APIException

validateNmMaps

void validateNmMaps(ArrayList<com.nt.udc.upgrade.NodeManagerMap> nmMaps)
             throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getTemplate

com.nt.udc.admin.Template getTemplate(String templateId)
                               throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getTemplateTree

com.nt.udc.admin.TemplateTreeRoot getTemplateTree()
                                           throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getSiteInfo

Map getSiteInfo()
         throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getLicenses

List getLicenses()
          throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getRuleFileContent

byte[] getRuleFileContent(com.nt.udc.admin.NodeInfo info,
 String inFileName)
                   throws com.nt.common.exceptions.APIException

Get the content of the RulesFile with the passed-in name.

Throws:

com.nt.common.exceptions.APIException

updateRuleFileContent

void updateRuleFileContent(com.nt.udc.admin.NodeInfo info,
 String inRuleFileDisplayName,
 String inRuleFileName,
 byte[] ruleFileContent)
                    throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

isSystemRuleFile

boolean isSystemRuleFile(com.nt.udc.admin.NodeInfo info,
 String inFileName)
                  throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

deleteRuleFile

boolean deleteRuleFile(com.nt.udc.admin.NodeInfo info,
 String inRuleFileDisplayName,
 String inFileName)
                throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

performConfigAction

void performConfigAction(ConfigActionIfc configActionObject,
 com.nt.udc.admin.NodeInfo ni)
                  throws com.nt.common.exceptions.APIException

Config Action specific to node

Throws:

com.nt.common.exceptions.APIException

performConfigAction

void performConfigAction(ConfigActionIfc configActionObject,
 com.nt.udc.admin.NodeInfo ni,
 String ipAddress,
 int port)
                  throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getOutputFields

ArrayList getOutputFields(DCNodeTypeIfc inNodeType,
 String inRuleFileName)
                   throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

getExposedFields

ArrayList getExposedFields(DCNodeTypeIfc inNodeType,
 String inRuleFileName,
 String inReason)
                    throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

nplChanged

boolean nplChanged(com.nt.udc.admin.NodeInfo info)
            throws com.nt.common.exceptions.APIException

Indicates whether the NPL file indicated in the given NodeInfo object has changed since the AdminServer was started.

Throws:

com.nt.common.exceptions.APIException

compileNPL

void compileNPL(byte[] nplContent)
         throws com.nt.common.exceptions.APIException

Compiles given npl content for testing if there are any compilation errors

Throws:

com.nt.common.exceptions.APIException

reloadNPL

void reloadNPL(com.nt.udc.admin.NodeInfo info)
        throws com.nt.common.exceptions.APIException

Instructs the AdminServer to recompile the NPL file indicated in the given NodeInfo object.

Throws:

com.nt.common.exceptions.APIException

getSystemModel

SystemModel getSystemModel()
                    throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

loadXMLSystemModel

void loadXMLSystemModel(String xmlSystemModel)
                 throws com.nt.udc.upgrade.ImportException

Throws:

com.nt.udc.upgrade.ImportException

importSystemModel

void importSystemModel(List nodeManagerMap,
 boolean corrIdMap,
 boolean isNodeChainImport)
                throws com.nt.udc.upgrade.ImportException

Throws:

com.nt.udc.upgrade.ImportException

doBackUp

void doBackUp(List nodeManagerMap)
       throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

checkImportStatus

List checkImportStatus()
                throws RemoteException

Throws:

RemoteException

getXMLNodeManagerMap

List getXMLNodeManagerMap()
                   throws com.nt.udc.upgrade.ImportException

Throws:

com.nt.udc.upgrade.ImportException

exportXMLSystemModel

String exportXMLSystemModel()
                     throws com.nt.udc.upgrade.ExportException

Throws:

com.nt.udc.upgrade.ExportException

exportXMLSystemModel

String exportXMLSystemModel(Vector vctNMItemsToExport)
                     throws com.nt.udc.upgrade.ExportException

Throws:

com.nt.udc.upgrade.ExportException

exportXMLSystemModel

String exportXMLSystemModel(Vector vctNMItems,
 Vector nodesToExport)
                     throws com.nt.udc.upgrade.ExportException

Throws:

com.nt.udc.upgrade.ExportException

exportXMLSystemModelOfNodeChain

String exportXMLSystemModelOfNodeChain(Vector nodesToExport)
                                throws com.nt.udc.upgrade.ExportException

Throws:

com.nt.udc.upgrade.ExportException

addNM

void addNM(String inIPAddress,
 String inName,
 int inPort)
    throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

changeNM

void changeNM(String inIPAddress,
 String inName,
 int inPort)
       throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

removeNM

void removeNM(String inIPAddress,
 int inPort)
       throws com.nt.common.exceptions.APIException

Tell the Admin Server to remove the node manager at the specified IP Address/Port.

Throws:

com.nt.common.exceptions.APIException

addNode

String addNode(String inIPAddress,
 int inPort,
 com.nt.udc.admin.NodeInfo nodeInfo)
        throws com.nt.common.exceptions.APIException

Add a new node (represented by the NodeInfo object) to the node manager residing at the specified IP Address and port.

Throws:

com.nt.common.exceptions.APIException

removeNodes

void removeNodes(Vector inNodeIds)
          throws com.nt.common.exceptions.APIException

Expects a vector of nodeID (string) objects. Remove the specified nodes from the system.

Throws:

com.nt.common.exceptions.APIException

startNodes

void startNodes(Vector inNodeIds)
         throws com.nt.common.exceptions.APIException

Expects a vector of nodeID (string) objects. Start the specified nodes.

Throws:

com.nt.common.exceptions.APIException

stopNodes

void stopNodes(Vector inNodeIds)
        throws com.nt.common.exceptions.APIException

Expects a vector of nodeID (string) objects. Stop the specified nodes.

Throws:

com.nt.common.exceptions.APIException

startAllNodes

void startAllNodes(String inIPAddress,
 int inPort)
            throws com.nt.common.exceptions.APIException

Start all nodes on the node manager at the specified IP Address/Port.

Throws:

com.nt.common.exceptions.APIException

stopAllNodes

void stopAllNodes(String inIPAddress,
 int inPort)
           throws com.nt.common.exceptions.APIException

Stop all nodes on the node manager at the specified IP Address.

Throws:

com.nt.common.exceptions.APIException

setImportExportProperty

void setImportExportProperty(String[][] newNmMap)
                      throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

setNodeDescription

void setNodeDescription(com.nt.udc.admin.NodeInfo nodeInfo)
                 throws com.nt.common.exceptions.APIException

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.

Throws:

com.nt.common.exceptions.APIException

setNodeInfo

void setNodeInfo(com.nt.udc.admin.NodeInfo nodeInfo)
          throws com.nt.common.exceptions.APIException

Modify the parameters of the specified node to be in accordance with the passed-in NodeInfo object.

Throws:

com.nt.common.exceptions.APIException

reMapWalletPassword

boolean reMapWalletPassword(String nodeId,
 List<int[]> indicesList)
                     throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getNodeInfo

com.nt.udc.admin.NodeInfo getNodeInfo(String inNodeId)
                               throws com.nt.common.exceptions.APIException

Get a NodeInfo object describing the specified node.

Throws:

com.nt.common.exceptions.APIException

getASLog

byte[] getASLog()
         throws com.nt.common.exceptions.APIException

Return the contents of the log for the Admin Server

Throws:

com.nt.common.exceptions.APIException

getNMLog

byte[] getNMLog(String inIPAddress,
 int inPort)
         throws com.nt.common.exceptions.APIException

Return the contents of the log for the node manager at the specified IP Address/Port.

Throws:

com.nt.common.exceptions.APIException

getNodeLog

byte[] getNodeLog(String nodeId)
           throws com.nt.common.exceptions.APIException

Return the contents of the log for the specified node.

Throws:

com.nt.common.exceptions.APIException

getCurrentPerformanceMetrics

Vector getCurrentPerformanceMetrics(String ip,
 int port)
                             throws com.nt.common.exceptions.APIException

Return a vector of performance objects

Throws:

com.nt.common.exceptions.APIException

setRefreshInterval

void setRefreshInterval(long inRefInt)
                 throws com.nt.common.exceptions.APIException

Sets the interval (in seconds) at which the statuses of all Node Managers and Nodes are refreshed

Throws:

com.nt.common.exceptions.APIException

clearNMAlarm

void clearNMAlarm(String ipAddress,
 int inPort)
           throws com.nt.common.exceptions.APIException

Clears the alarm on a Node Manager

Throws:

com.nt.common.exceptions.APIException

clearNodeAlarm

void clearNodeAlarm(String nodeId)
             throws com.nt.common.exceptions.APIException

clears the alarm on a specific node

Throws:

com.nt.common.exceptions.APIException

login

void login(com.nt.udc.admin.User user)
    throws com.nt.common.exceptions.APIException,
AuthenticationException

Attempts to authenticate the given user with the Admin Server

Throws:

com.nt.common.exceptions.APIException

AuthenticationException

logout

void logout()
     throws com.nt.common.exceptions.APIException

Logs out the current user

Throws:

com.nt.common.exceptions.APIException

hasAdminPriv

boolean hasAdminPriv()
              throws com.nt.common.exceptions.APIException

Indicates whether the current user has Administrative privileges

Throws:

com.nt.common.exceptions.APIException

getRole

int getRole(com.nt.udc.admin.User user)
     throws com.nt.common.exceptions.APIException

Returns the role of the user passed as argument

Returns:

the role of the user passed as argument

Throws:

com.nt.common.exceptions.APIException

getUserList

Vector getUserList()
            throws com.nt.common.exceptions.APIException

Retrieves the current list of valid user ids known to the Admin Server.

Returns:

Vector of User Objects representing the users

Throws:

com.nt.common.exceptions.APIException

getCurrentUserId

String getCurrentUserId()

Returns the ID of the user currently accessing the Admin Server through this AdminServerAPI Object

modifyUser

boolean modifyUser(com.nt.udc.admin.User user,
 Boolean changePassword)
            throws AuthenticationException,
com.nt.common.exceptions.APIException

Modifies attributes associated with the given User

Throws:

AuthenticationException

com.nt.common.exceptions.APIException

addUser

boolean addUser(com.nt.udc.admin.User user)
         throws AuthenticationException,
com.nt.common.exceptions.APIException

Adds a new User to the current list of valid users

Throws:

AuthenticationException

com.nt.common.exceptions.APIException

removeUsers

boolean removeUsers(Vector userList)
             throws AuthenticationException,
com.nt.common.exceptions.APIException

Removes the given Users from the current list of valid users

Throws:

AuthenticationException

com.nt.common.exceptions.APIException

getTrapHostList

com.nt.udc.admin.TrapHostList getTrapHostList()
                                       throws com.nt.common.exceptions.APIException

Gets list of known SNMP Trap Hosts

Throws:

com.nt.common.exceptions.APIException

addTrapHost

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

Throws:

com.nt.common.exceptions.APIException

removeTrapHost

void removeTrapHost(com.nt.udc.admin.TrapHost host)
             throws com.nt.common.exceptions.APIException

Removes a host from the list of SNMP Trap Hosts

Throws:

com.nt.common.exceptions.APIException

removeTrapHosts

void removeTrapHosts(Vector hosts)
              throws com.nt.common.exceptions.APIException

Remove multiple hosts from the list of SNMP Trap Hosts

Throws:

com.nt.common.exceptions.APIException

modifyTrapHost

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

Throws:

com.nt.common.exceptions.APIException

getDSHost

String getDSHost()
          throws com.nt.common.exceptions.APIException

Gets Data Server host name

Throws:

com.nt.common.exceptions.APIException

getDSPort

String getDSPort()
          throws com.nt.common.exceptions.APIException

Gets Data Server port

Throws:

com.nt.common.exceptions.APIException

getASConfig

Hashtable getASConfig()
               throws com.nt.common.exceptions.APIException

Gets the Admin Server Config object (really just a Hashtable).

Throws:

com.nt.common.exceptions.APIException

setASConfig

void setASConfig(Hashtable asConfig)
          throws com.nt.common.exceptions.APIException

Sets the Admin Server Config object. All original attributes should be present, even if they haven't been changed.

Throws:

com.nt.common.exceptions.APIException

exportWithCustomization

byte[] exportWithCustomization(Vector nmListToExport,
 String exportName)
                        throws com.nt.common.exceptions.APIException

returns customization contents of all node managers and adminserver in a byte array

Throws:

com.nt.common.exceptions.APIException

exportWithCustomization

byte[] exportWithCustomization(Vector nmList,
 Vector nodesToExport,
 String exportName)
                        throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

importCustomization

boolean importCustomization(ArrayList nmMaps,
 byte[] contents)
                     throws com.nt.common.exceptions.APIException

distributes the customization contents to all node managers and adminserver

Throws:

com.nt.common.exceptions.APIException

getImportCustomLog

String getImportCustomLog()
                   throws com.nt.common.exceptions.APIException

returns the log created during import customization.

Throws:

com.nt.common.exceptions.APIException

copyNPL

void copyNPL(DCNodeTypeIfc inNodeType,
 String inRuleFileName)
      throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getAuthUsers

boolean getAuthUsers()
              throws com.nt.common.exceptions.APIException

returns true if authentication is enabled

Returns:

Throws:

com.nt.common.exceptions.APIException

addRRNodeDestination

void addRRNodeDestination(String sourceNodeId,
 String destNodeId)
                   throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

removeRoute

String removeRoute(String sourceNodeId,
 String destNodeId)
            throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getDestNodesInNM

Vector getDestNodesInNM(String srcNode,
 String host,
 Integer port)
                 throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

validateNMForNodeTypes

boolean validateNMForNodeTypes(String inclusionExclusion,
 String majMin,
 String host,
 Integer port)
                        throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

integrateRouting

void integrateRouting(String parentHost,
 Integer parentPort)
               throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

clearNodeIdCorrelationsMap

boolean clearNodeIdCorrelationsMap()
                            throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

integrateRoutingCCNMScaleUp

boolean integrateRoutingCCNMScaleUp(String ccHost,
 Integer ccPort)
                             throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getOsaHome

String getOsaHome()
           throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

integrateScalingDownForSegregatedNM

void integrateScalingDownForSegregatedNM(String nmlist)
                                  throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

integrateScalingDownForNonSegregatedNM

void integrateScalingDownForNonSegregatedNM(String nmlist)
                                     throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

addRoute

String addRoute(String sourceNodeId,
 String destNodeId,
 String routeFunc,
 String rField,
 Vector rCondition)
         throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

updateRoute

String updateRoute(String sourceNodeId,
 String destNodeId,
 String routeFunc,
 String rField,
 Vector rCondition)
            throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

updateRouteParameters

String updateRouteParameters(String sourceNodeId,
 String destNodeId,
 String rField,
 Vector rCondition)
                      throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

removeNM

void removeNM(String id)
       throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

changeNM

void changeNM(String id,
 String inName)
       throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getNM

com.nt.udc.admin.NMItem getNM(String id)
                       throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

uploadNodeChainTestInputFile

void uploadNodeChainTestInputFile(byte[] data,
 String nodeId,
 String fileName)
                           throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

runNodeChainTest

void runNodeChainTest(String uploadId,
 NodeChainTestCfgItem cfgItem)
               throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getOutputNodeChainTest

List<NodeChainOutputRecords> getOutputNodeChainTest(String nodeId)
                                             throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

completeNodeChainTest

void completeNodeChainTest(String testId)
                    throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getConfigValue

String getConfigValue(DCNodeTypeIfc inNodeType,
 String inRuleFileName,
 String inKey)
               throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getSol42DescriptorFiles

List<String> getSol42DescriptorFiles(String nmID)
                              throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

getRuleFileDisplayName

String getRuleFileDisplayName(String nodeContext,
 String ruleFileName)
                       throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException

extendTestTimeout

boolean extendTestTimeout(String testId)
                   throws com.nt.common.exceptions.APIException

Throws:

com.nt.common.exceptions.APIException