NXCSession (NetXMS Client Library 2.0-M5 API)

java.lang.Object
- org.netxms.client.NXCSession

```
public class NXCSession
extends Object
```
Communication session with NetXMS server.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class NXCSession.MessageSubscription
Message subscription class

Nested Classes
Modifier and Type	Class and Description
`protected class`	`NXCSession.MessageSubscription` Message subscription class

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_LIST_DISCOVERY_FILTER`
`static int`	`ADDRESS_LIST_DISCOVERY_TARGETS`
`static int`	`APPLICATION_CLIENT`
`static int`	`CFG_IMPORT_REPLACE_EVENT_BY_CODE`
`static int`	`CFG_IMPORT_REPLACE_EVENT_BY_NAME`
`static int`	`CHANNEL_ALARMS`
`static int`	`CHANNEL_AUDIT_LOG`
`static int`	`CHANNEL_EVENTS`
`static int`	`CHANNEL_OBJECTS`
`static int`	`CHANNEL_SITUATIONS`
`static int`	`CHANNEL_SNMP_TRAPS`
`static int`	`CHANNEL_SYSLOG`
`static int`	`DEFAULT_CONN_PORT`
`static int`	`DESKTOP_CLIENT`
`static int`	`MOBILE_CLIENT`
`static int`	`OBJECT_SYNC_NOTIFY`
`static int`	`OBJECT_SYNC_WAIT`
`static int`	`SERVER_COMPONENT_DISCOVERY_MANAGER`
`static int`	`TABLET_CLIENT`
`static int`	`WEB_CLIENT`

Constructor Summary

Constructors
Constructor and Description
`NXCSession(String connAddress)`
`NXCSession(String connAddress, int connPort)`
`NXCSession(String connAddress, int connPort, boolean connUseEncryption)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acknowledgeAlarm(long alarmId)` Acknowledge alarm.
`void`	`acknowledgeAlarm(long alarmId, boolean sticky, int time)` Acknowledge alarm.
`void`	`acknowledgeAlarm(String helpdeskReference)` Acknowledge alarm by helpdesk reference.
`void`	`addClusterNode(long clusterId, long nodeId)` Add node to cluster.
`void`	`addConsoleListener(ServerConsoleListener listener)` Add server console listener
`void`	`addListener(SessionListener listener)` Add notification listener
`void`	`addMessageSubscription(int messageCode, long messageId, MessageHandler handler)` Subscribe to specific messages
`void`	`applyTemplate(long templateId, long nodeId)` Apply data collection template to node.
`void`	`bindObject(long parentId, long childId)` Bind object.
`void`	`cancelFileMonitoring(long nodeId, String remoteFileName)` Cancel file monitoring
`void`	`cancelServerJob(long jobId)` Cancel server job
`void`	`changeObjecToolDisableStatuss(long toolId, boolean enable)` Delete object tool.
`void`	`changeObjectZone(long objectId, long zoneId)` Move object to different zone.
`boolean`	`checkConnection()` Send KEEPALIVE message.
`void`	`clearCollectedData(long nodeId, long dciId)` Clear collected data for given DCI
`void`	`closeConsole()` Close server console.
`void`	`closeEventProcessingPolicy()` Close event processing policy.
`void`	`connect()` Connect to NetMS server.
`void`	`connect(int[] componentVersions)` Connect to NetMS server.
`long`	`createAction(String name)` Create new server action.
`void`	`createAlarmComment(long alarmId, String text)` Create alarm comment.
`void`	`createAlarmComment(String helpdeskReference, String text)` Create alarm comment by helpdesk reference.
`protected void`	`createCustomObject(NXCObjectCreationData data, Object userData, org.netxms.base.NXCPMessage msg)` Hook method to allow adding of custom object creation data to NXCP message.
`protected AbstractObject`	`createCustomObjectFromMessage(int objectClass, org.netxms.base.NXCPMessage msg)` Create custom object from NXCP message.
`void`	`createFolderOnAgent(String folder, long nodeId)` Upload local file to server's file store
`LibraryImage`	`createImage(LibraryImage image, ProgressListener listener)`
`int`	`createMappingTable(String name, String description, int flags)` Create new mapping table.
`void`	`createNewCertificate(byte[] data, String comments)` Create new certificate
`long`	`createObject(NXCObjectCreationData data)` Create new NetXMS object.
`long`	`createObject(NXCObjectCreationData data, Object userData)` Create new NetXMS object.
`long`	`createSituation(String name, String comments)` Create new situation object.
`long`	`createSnmpTrapConfiguration()` Create new trap configuration record.
`long`	`createUser(String name)` Create user on server
`long`	`createUserGroup(String name)` Create user group on server
`void`	`deleteAction(long actionId)` Delete server action
`void`	`deleteAgentConfig(long id)` Delete config with given id.
`void`	`deleteAgentFile(long nodeId, String fileName)` Delete file from agent
`void`	`deleteAlarm(long alarmId)` Delete alarm.
`void`	`deleteAlarmComment(long alarmId, long commentId)` Delete alarm comment.
`void`	`deleteCertificate(long id)` Delete certificate
`void`	`deleteDciSummaryTable(int id)` Delete DCI summary table.
`void`	`deleteEventTemplate(long eventCode)` Delete event template.
`void`	`deleteImage(LibraryImage image)`
`void`	`deleteMappingTable(int id)` Delete mapping table
`void`	`deleteObject(long objectId)` Delete object
`void`	`deleteObjectTool(long toolId)` Delete object tool.
`void`	`deletePredefinedGraph(long graphId)` Delete predefined graph.
`void`	`deleteReportResult(UUID reportId, UUID jobId)`
`void`	`deleteReportSchedule(UUID reportId, UUID jobId)`
`void`	`deleteScript(long scriptId)` Delete script from library
`void`	`deleteServerFile(String serverFileName)` Delete file from server's file store
`void`	`deleteServerVariable(String name)` Delete server configuration variable
`void`	`deleteSituation(long id)` Delete situation object
`void`	`deleteSituationInstance(long id, String instance)` Delete situation instance
`void`	`deleteSnmpTrapConfiguration(long trapId)` Delete SNMP trap configuration record from server.
`void`	`deleteUserDBObject(long id)` Delete user or group on server
`void`	`deployAgentPolicy(long policyId, long nodeId)` Deploy policy on agent
`void`	`deployPackage(long packageId, Long[] nodeList, PackageDeploymentListener listener)` Deploy agent packages onto given nodes
`void`	`disconnect()` Disconnect from server.
`AgentFile`	`downloadFileFromAgent(long nodeId, String remoteFileName, long maxFileSize, boolean follow)` Download file from remote host via agent.
`File`	`downloadFileFromServer(String remoteFileName)` Download file from server file storage.
`File`	`downloadMibFile()` Download MIB file from server.
`void`	`executeAction(long nodeId, String action)` Execute action on remote agent
`void`	`executeAction(long nodeId, String action, boolean receiveOutput, TextOutputListener listener, Writer writer)` Execute action on remote agent
`UUID`	`executeReport(UUID reportId, Map<String,String> parameters)`
`void`	`executeScript(long nodeId, String script, TextOutputListener listener)` Execute script.
`void`	`executeServerCommand(long objectId, String command)` Execute server command related to given object (usually defined as object tool)
`protected void`	`executeSimpleCommand(int command)` Execute simple commands (without arguments and only returning RCC)
`Table`	`executeTableTool(long toolId, long nodeId)` Execute object tool of "table" type against given node.
`String`	`exportConfiguration(String description, long[] events, long[] traps, long[] templates, UUID[] rules, long[] scripts, long[] objectTools, long[] dciSummaryTables)` Export server configuration.
`protected void`	`finalize()`
`ConnectionPoint`	`findConnectionPoint(int zoneId, InetAddress ipAddr)` Find connection point (either directly connected or most close known interface on a switch) for given IP address.
`ConnectionPoint`	`findConnectionPoint(long objectId)` Find connection point (either directly connected or most close known interface on a switch) for given node or interface object.
`ConnectionPoint`	`findConnectionPoint(MacAddress macAddr)` Find connection point (either directly connected or most close known interface on a switch) for given MAC address.
`EventTemplate`	`findEventTemplateByCode(long code)` Find event template by code in event template database internally maintained by session object.
`EventTemplate`	`findEventTemplateByName(String name)` Find event template by name in event template database internally maintained by session object.
`List<EventTemplate>`	`findMultipleEventTemplates(long[] codes)` Find multiple event templates by event codes in event template database internally maintained by session object.
`List<EventTemplate>`	`findMultipleEventTemplates(Long[] codes)` Find multiple event templates by event codes in event template database internally maintained by session object.
`List<AbstractObject>`	`findMultipleObjects(long[] idList, boolean returnUnknown)` Find multiple NetXMS objects by identifiers
`List<AbstractObject>`	`findMultipleObjects(Long[] idList, boolean returnUnknown)` Find multiple NetXMS objects by identifiers
`List<AbstractObject>`	`findMultipleObjects(long[] idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown)` Find multiple NetXMS objects by identifiers
`List<AbstractObject>`	`findMultipleObjects(Long[] idList, Class<? extends AbstractObject> classFilter, boolean returnUnknown)` Find multiple NetXMS objects by identifiers
`AbstractObject`	`findObjectById(long id)` Find NetXMS object by it's identifier.
`<T extends AbstractObject> T`	`findObjectById(long id, Class<T> requiredClass)` Find NetXMS object by it's identifier with additional class checking.
`AbstractObject`	`findObjectByName(String name)` Find object by name.
`AbstractObject`	`findObjectByNamePattern(String pattern)` Find object by name using regular expression.
`AbstractUserObject`	`findUserDBObjectById(long id)` Find user by ID
`Zone`	`findZone(long zoneId)` Find zone object by zone ID.
`void`	`forceDCIPoll(long nodeId, long dciId)` Force DCI poll for given DCI
`long`	`generateEventCode()` Generate code for new event template.
`long`	`generateObjectToolId()` Generate unique ID for new object tool.
`List<ServerAction>`	`getActions()` Get list of configured actions from server
`List<IpAddressListElement>`	`getAddressList(int listId)` Get address list.
`String`	`getAgentConfig(long nodeId)` Get agent's master configuration file.
`Alarm`	`getAlarm(long alarmId)` Get information about single active alarm.
`List<AlarmComment>`	`getAlarmComments(long alarmId)` Get list of comments for given alarm.
`List<EventInfo>`	`getAlarmEvents(long alarmId)` Get information about events related to single active alarm.
`int`	`getAlarmListDisplayLimit()` Get maximum number of records allowed to be displayed in alarm list
`HashMap<Long,Alarm>`	`getAlarms()` Get list of active alarms.
`AbstractObject[]`	`getAllObjects()` Get list of all objects
`String`	`getAttributeForCurrentUser(String name)` Get custom attribute for currently logged in user.
`AuthenticationType`	`getAuthenticationMethod()`
`EventTemplate[]`	`getCachedEventTemplates()` Get cached list event templates
`List<AuthCertificate>`	`getCertificateList()` Get list of certificates
`String`	`getClientInfo()` Get client information string
`String`	`getClientLanguage()`
`int`	`getClientType()`
`DciData`	`getCollectedData(long nodeId, long dciId, Date from, Date to, int maxRows)` Get collected DCI data from server.
`DciData`	`getCollectedTableData(long nodeId, long dciId, String instance, String dataColumn, Date from, Date to, int maxRows)` Get collected table DCI data from server.
`ConfigContent`	`getConfigContent(long id)` Saves existing config
`List<ConfigListElement>`	`getConfigList()` Gets the list of configuration files.(Config id, name and sequence number)
`long[]`	`getDataCollectionEvents(long objectId)` Get all events used in data collection by given node, cluster, or template object.
`List<Script>`	`getDataCollectionScripts(long objectId)` Get names of all scripts used in data collection by given node, cluster, or template object.
`String`	`getDateFormat()` Get default date format provided by server
`DciSummaryTable`	`getDciSummaryTable(int id)` Get DCI summary table configuration.
`int`	`getDefaultDciPollingInterval()`
`int`	`getDefaultDciRetentionTime()`
`int`	`getDefaultRecvBufferSize()` Get default receiver buffer size.
`int`	`getEffectiveRights(long objectId)` Get effective rights of currently logged in user to given object.
`EventProcessingPolicy`	`getEventProcessingPolicy()` Get read-only copy of ebent processing policy.
`List<EventTemplate>`	`getEventTemplates()` Get event templates from server
`String`	`getHelpdeskIssueUrl(long alarmId)` Get URL for helpdesk issue associated with given alarm
`LibraryImage`	`getImage(UUID guid)`
`List<LibraryImage>`	`getImageLibrary()`
`List<LibraryImage>`	`getImageLibrary(String category)`
`List<PackageInfo>`	`getInstalledPackages()` Get list of installed packages
`DciValue[]`	`getLastValues(long nodeId)` Get last DCI values for given node
`DciValue[]`	`getLastValues(long nodeId, boolean objectTooltipOnly, boolean overviewOnly, boolean includeNoValueObjects)` Get last DCI values for given node
`DciValue[]`	`getLastValues(Set<MapDCIInstance> dciIDList)` Get last DCI values for given DCI id list(list can contain simple DCIss and table DCIs)
`List<org.netxms.base.GeoLocation>`	`getLocationHistory(long objectId, Date from, Date to)` Get location history for given object.
`MappingTable`	`getMappingTable(int id)`
`int`	`getMaxRecvBufferSize()` Get max receiver buffer size.
`Date`	`getMibFileTimestamp()` Get timestamp of server's MIB file.
`int`	`getMinViewRefreshInterval()`
`NetworkPath`	`getNetworkPath(long node1, long node2)` Get IPv4 network path between two nodes.
`PhysicalComponent`	`getNodePhysicalComponents(long nodeId)` Get node's physical components (obtained from ENTITY-MIB).
`List<SoftwarePackage>`	`getNodeSoftwarePackages(long nodeId)` Get list of software packages installed on node.
`List<WinPerfObject>`	`getNodeWinPerfObjects(long nodeId)` Get list of available Windows performance objects.
`String`	`getObjectName(long objectId)` Get object name by ID.
`ObjectToolDetails`	`getObjectToolDetails(long toolId)` Get object tool details
`List<ObjectTool>`	`getObjectTools()` Get list of configured object tools
`PerfTabDci[]`	`getPerfTabItems(long nodeId)` Get list of DCIs configured to be shown on performance tab in console for given node.
`List<GraphSettings>`	`getPredefinedGraphs()` Get list of predefined graphs.
`ReportDefinition`	`getReportDefinition(UUID reportId)`
`List<Route>`	`getRoutingTable(long nodeId)` Get routing table from node
`Script`	`getScript(long scriptId)` Get script from library
`List<Script>`	`getScriptLibrary()` Get list of all scripts in script library.
`String`	`getServerAddress()` Get server address
`byte[]`	`getServerChallenge()`
`String`	`getServerConfigClob(String name)` Get server config CLOB
`long`	`getServerId()` Get NetXMS server UID.
`ServerJob[]`	`getServerJobList()` Get list of server jobs
`Map<String,Object>`	`getServerStats()` Get server stats.
`long`	`getServerTime()` Get server time
`String`	`getServerTimeZone()` Get server time zone.
`Map<String,ServerVariable>`	`getServerVariables()` Get server configuration variables
`String`	`getServerVersion()` Get NetXMS server version.
`int`	`getSessionId()` Get this session's ID on server.
`String`	`getShortTimeFormat()` Get time format for short form (usually without seconds).
`List<Situation>`	`getSituations()` Get list of all configured situations
`List<String>`	`getSnmpCommunities()` Get list of well-known SNMP communities configured on server.
`List<SnmpTrap>`	`getSnmpTrapsConfiguration()` Get list of configured SNMP traps
`List<SnmpTrap>`	`getSnmpTrapsConfigurationSummary()` Get summary of SNMP trap mapping.
`List<SnmpUsmCredential>`	`getSnmpUsmCredentials()` Get list of well-known SNMP USM (user security model) credentials configured on server.
`long[]`	`getSubnetAddressMap(long subnetId)` Get address map for subnet.
`List<AgentParameter>`	`getSupportedParameters(long nodeId)` Get list of parameters supported by agent running on given node.
`List<AgentTable>`	`getSupportedTables(long nodeId)` Get list of tables supported by agent running on given node.
`List<FdbEntry>`	`getSwitchForwardingDatabase(long nodeId)` Get switch forwarding database (MAC address table) from node
`Table`	`getTableLastValues(long nodeId, long dciId)` Get last values for given table DCI on given node
`Threshold[]`	`getThresholds(long nodeId, long dciId)` Get list of thresholds configured for given DCI
`List<ThresholdViolationSummary>`	`getThresholdSummary(long objectId)` Get threshold violation summary for all nodes under given parent object.
`String`	`getTileServerURL()`
`String`	`getTimeFormat()` Get default time format provided by server
`AbstractObject[]`	`getTopLevelObjects()` Get list of top-level objects.
`AbstractObject[]`	`getTopLevelObjects(Set<Integer> classFilter)` Get list of top-level objects matching given class filter.
`AbstractUserObject[]`	`getUserDatabaseObjects()` Get list of all user database objects
`int`	`getUserId()` Get identifier of logged in user.
`String`	`getUserName()`
`long`	`getUserSystemRights()` Get system-wide rights of currently logged in user.
`List<VlanInfo>`	`getVlans(long nodeId)` Get list of VLANs configured on given node
`List<WirelessStation>`	`getWirelessStations(long nodeId)` Get list of wireless stations registered at given wireless controller.
`void`	`handover(NXCSession target)` Handover object cache to new session.
`void`	`holdServerJob(long jobId)` Put server job on hold
`void`	`importConfiguration(String config, int flags)` Import server configuration (events, traps, thresholds) from XML
`long`	`installPackage(PackageInfo info, File pkgFile, ProgressListener listener)` Install (upload) package on server
`boolean`	`isConnected()` Get connection state
`boolean`	`isEncrypted()` Get encryption state for current session.
`boolean`	`isHelpdeskLinkActive()` Get status of helpdesk integration module on server.
`boolean`	`isIgnoreProtocolVersion()`
`boolean`	`isObjectsSynchronized()`
`boolean`	`isPasswordExpired()` Check if password is expired for currently logged in user.
`boolean`	`isServerConsoleConnected()`
`boolean`	`isStrictAlarmStatusFlow()`
`boolean`	`isTimedAlarmAckEnabled()`
`boolean`	`isZoningEnabled()`
`ServerFile[]`	`listAgentFiles(ServerFile file, String fullPath, long objectId)` List files on agent file store.
`List<DciSummaryTableDescriptor>`	`listDciSummaryTables()` Get list of all configured DCI summary tables
`List<MappingTableDescriptor>`	`listMappingTables()` Get list of all configured mapping tables.
`List<ReportResult>`	`listReportResults(UUID reportId)`
`List<UUID>`	`listReports()`
`List<ReportingJob>`	`listScheduledJobs(UUID reportId)`
`ServerFile[]`	`listServerFiles()` List files in server's file store.
`ServerFile[]`	`listServerFiles(String[] filter)` List files in server's file store.
`void`	`lockPackageDatabase()` Lock package database
`void`	`lockUserDatabase()` Lock user database
`void`	`login(AuthenticationType authType, String login, String password, Certificate certificate, Signature signature)` Login to server.
`void`	`login(String login, Certificate certificate, Signature signature)` Login to server using certificate.
`void`	`login(String login, String password)` Login to server using login name and password.
`void`	`modifyAction(ServerAction action)` Modify server action
`protected void`	`modifyCustomObject(NXCObjectModificationData data, Object userData, org.netxms.base.NXCPMessage msg)` Hook method to populate NXCP message with custom object's data on object modification.
`int`	`modifyDciSummaryTable(DciSummaryTable table)` Modify DCI summary table configuration.
`void`	`modifyEventTemplate(EventTemplate evt)` Modify event template.
`void`	`modifyImage(LibraryImage image, ProgressListener listener)`
`void`	`modifyObject(NXCObjectModificationData data)` Modify object (generic interface, in most cases wrapper functions should be used instead).
`void`	`modifyObject(NXCObjectModificationData data, Object userData)` Modify object (generic interface, in most cases wrapper functions should be used instead).
`void`	`modifyObjectTool(ObjectToolDetails tool)` Modify object tool.
`long`	`modifyScript(long scriptId, String name, String source)` Modify script.
`void`	`modifySituation(long id, String name, String comments)` Modify situation object.
`void`	`modifySnmpTrapConfiguration(SnmpTrap trap)` Modify SNMP trap configuration record.
`void`	`modifyUserDBObject(AbstractUserObject object)` Modify user database object
`void`	`modifyUserDBObject(AbstractUserObject object, int fields)` Modify user database object
`void`	`moveAgentFile(long nodeId, String oldName, String newFileName)` Move file from agent
`org.netxms.base.NXCPMessage`	`newMessage(int code)` Create new NXCP message with unique id
`void`	`openConsole()` Open server console.
`DataCollectionConfiguration`	`openDataCollectionConfiguration(long nodeId)` Open data collection configuration for given node.
`EventProcessingPolicy`	`openEventProcessingPolicy()` Open event processing policy for editing.
`String`	`openHelpdeskIssue(long alarmId)` Open issue in helpdesk system from given alarm
`Log`	`openServerLog(String logName)` Open server log by name.
`void`	`pollNode(long nodeId, NodePollType pollType, TextOutputListener listener)` Perform a forced node poll.
`boolean`	`processConsoleCommand(String command)` Process console command on server.
`void`	`pushDciData(DciPushData[] data)` Push data to server.
`void`	`pushDciData(long nodeId, long dciId, String value)` Push value for single DCI.
`void`	`pushDciData(String nodeName, String dciName, String value)` Push value for single DCI.
`Table`	`queryAdHocDciSummaryTable(long baseObjectId, List<DciSummaryTableColumn> columns, AggregationFunction function, Date periodStart, Date periodEnd, boolean multiInstance)` Query ad-hoc DCI summary table.
`Table`	`queryAgentTable(long nodeId, String name)` Query agent's table immediately.
`Table`	`queryDciSummaryTable(int tableId, long baseObjectId)` Query DCI summary table.
`NetworkMapPage`	`queryLayer2Topology(long nodeId)` Query layer 2 topology for node
`String`	`queryParameter(long nodeId, int origin, String name)` Query parameter immediately.
`Table`	`receiveTable(long requestId, int msgCode)` Receive table from server.
`void`	`removeClusterNode(long clusterId, long nodeId)` Remove node from cluster.
`void`	`removeConsoleListener(ServerConsoleListener listener)` Remove server console listener
`void`	`removeListener(SessionListener listener)` Remove notification listener
`void`	`removeMessageSubscription(int messageCode, long messageId)`
`void`	`removePackage(long packageId)` Remove agent package from server
`void`	`removeTemplate(long templateId, long nodeId, boolean removeDci)` Remove data collection template from node.
`void`	`renameAgentFile(long nodeId, String oldName, String newFileName)` Rename file from agent
`void`	`renameScript(long scriptId, String name)` Rename script in script library.
`File`	`renderReport(UUID reportId, UUID jobId, ReportRenderFormat format)`
`void`	`resetServerComponent(int component)` Reset server's internal component (defined by SERVER_COMPONENT_xxx)
`void`	`resolveAlarm(long alarmId)` Resolve alarm.
`void`	`resolveAlarm(String helpdeskReference)` Resolve alarm by helpdesk reference.
`String[]`	`resolveDciNames(Collection<ConditionDciInfo> dciList)` Resolve names of given DCIs
`String[]`	`resolveDciNames(long[] nodeIds, long[] dciIds)` Resolve names of given DCIs
`void`	`saveAgentConfig(ConfigContent conf)` Saves or creates new agent's config
`void`	`saveEventProcessingPolicy(EventProcessingPolicy epp)` Save event processing policy.
`long`	`saveGraph(GraphSettings graph, boolean overwrite)` Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB.
`void`	`scheduleReport(ReportingJob job, Map<String,String> parameters)`
`void`	`sendEvent(long eventCode, String[] parameters)` Convenience wrapper for sendEvent interface.
`void`	`sendEvent(long eventCode, String eventName, long objectId, String[] parameters, String userTag)` Send event to server.
`void`	`sendEvent(String eventName, String[] parameters)` Convenience wrapper for sendEvent interface.
`protected void`	`sendFile(long requestId, byte[] data, ProgressListener listener)` Send block of data as binary message
`protected void`	`sendFile(long requestId, File file, ProgressListener listener)` Send file over CSCP
`void`	`sendMessage(org.netxms.base.NXCPMessage msg)` Send message to server
`protected void`	`sendNotification(SessionNotification n)` Call notification handlers on all registered listeners
`void`	`sendSMS(String phoneNumber, String message)` Send SMS via server.
`void`	`setAddressList(int listId, List<IpAddressListElement> list)` Set content of address list.
`void`	`setAlarmFlowState(int state)` Changes state of alarm status flow.
`void`	`setAttributeForCurrentUser(String name, String value)` Set custom attribute for currently logged in user.
`void`	`setClientAddress(String clientAddress)`
`void`	`setClientInfo(String connClientInfo)` Set client information string
`void`	`setClientLanguage(String clientLanguage)`
`void`	`setClientType(int clientType)` Set client type.
`void`	`setCommandTimeout(int commandTimeout)` Set command execution timeout.
`void`	`setIgnoreProtocolVersion(boolean ignoreProtocolVersion)` If set to true, protocol version is not checked at connect.
`void`	`setObjectACL(long objectId, AccessListElement[] acl, boolean inheritAccessRights)` Change object's ACL (wrapper for modifyObject())
`void`	`setObjectCustomAttributes(long objectId, Map<String,String> attrList)` Change object's custom attributes (wrapper for modifyObject())
`void`	`setObjectManaged(long objectId, boolean isManaged)` Set object's managed status.
`void`	`setObjectName(long objectId, String name)` Change object's name (wrapper for modifyObject())
`void`	`setRecvBufferSize(int defaultBufferSize, int maxBufferSize)` Set receiver buffer size.
`void`	`setServerConfigClob(String name, String value)` Set server config CLOB
`void`	`setServerVariable(String name, String value)` Set server configuration variable
`void`	`setUserPassword(long id, String newPassword, String oldPassword)` Set password for user
`void`	`snmpWalk(long nodeId, String rootOid, SnmpWalkListener listener)` Do SNMP walk.
`void`	`subscribe(int channels)` Subscribe to notification channel(s)
`void`	`swapAgentConfigs(long id1, long id2)` Swaps 2 configs sequence numbers
`void`	`syncEventTemplates()` Synchronize event templates configuration.
`void`	`syncMissingObjects(long[] objects, boolean syncComments)` Synchronize only those objects from given set which are not synchronized yet.
`void`	`syncMissingObjects(long[] objects, boolean syncComments, int options)` Synchronize only those objects from given set which are not synchronized yet.
`void`	`syncObjects()` Synchronizes NetXMS objects between server and client.
`void`	`syncObjectSet(long[] objects, boolean syncComments)` Synchronizes selected object set with the server.
`void`	`syncObjectSet(long[] objects, boolean syncComments, int options)` Synchronizes selected object set with the server.
`void`	`syncUserDatabase()` Synchronize user database
`byte[]`	`takeScreenshot(long nodeId, String sessionName)` Take screenshot from given node.
`void`	`terminateAlarm(long alarmId)` Terminate alarm.
`void`	`terminateAlarm(String helpdeskReference)` Terminate alarm by helpdesk reference.
`TransformationTestResult`	`testTransformationScript(long nodeId, String script, String inputValue)` Test DCI transformation script.
`void`	`unbindObject(long parentId, long childId)` Unbind object.
`void`	`unholdServerJob(long jobId)` Put server on hold job to pending state
`void`	`uninstallAgentPolicy(long policyId, long nodeId)` Uninstall policy from agent
`void`	`unlinkHelpdeskIssue(long alarmId)` Unlink helpdesk issue from alarm.
`void`	`unlinkHelpdeskIssue(String helpdeskReference)` Unlink helpdesk issue from alarm.
`void`	`unlockPackageDatabase()` Unlock package database
`void`	`unlockUserDatabase()` Unlock user database
`void`	`unsubscribe(int channels)` Unsubscribe from notification channel(s)
`void`	`updateAgentConfig(long nodeId, String config, boolean apply)` Update agent's master configuration file.
`void`	`updateAlarmComment(long alarmId, long commentId, String text)` Update alarm comment.
`void`	`updateCertificate(long id, String comment)` Update certificate
`int`	`updateMappingTable(MappingTable table)` Create or update mapping table.
`void`	`updateObjectComments(long objectId, String comments)` Change object's comments.
`void`	`updateSnmpCommunities(List<String> list)` Update list of well-known SNMP community strings on server.
`void`	`updateSnmpUsmCredentials(List<SnmpUsmCredential> list)` Update list of well-known SNMP USM credentials on server.
`long`	`uploadFileToAgent(long nodeId, String serverFileName, String remoteFileName, boolean jobOnHold)` Start file upload from server's file store to agent.
`void`	`uploadFileToServer(File localFile, String serverFileName, ProgressListener listener)` Upload local file to server's file store
`void`	`uploadLocalFileToAgent(File localFile, String agentFileName, long nodeId, ProgressListener listener)` Upload local file to server's file store
`boolean`	`validateProtocolVersions(int[] versions)` Validate protocol versions
`File`	`waitForFile(long id, int timeout)` Wait for specific file to arrive
`String`	`waitForFileTail(String fileName, int timeout)` Wait for specific file tail to arrive
`org.netxms.base.NXCPMessage`	`waitForMessage(int code, long id)` Wait for message with specific code and id.
`org.netxms.base.NXCPMessage`	`waitForMessage(int code, long id, int timeout)` Wait for message with specific code and id.
`org.netxms.base.NXCPMessage`	`waitForRCC(long id)` Wait for CMD_REQUEST_COMPLETED message with given id using default timeout
`org.netxms.base.NXCPMessage`	`waitForRCC(long id, int timeout)` Wait for CMD_REQUEST_COMPLETED message with given id
`void`	`wakeupNode(long objectId)` Wakeup node by sending wake-on-LAN magic packet.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CONN_PORT
```
public static final int DEFAULT_CONN_PORT
```
    See Also:
    Constant Field Values
  - CHANNEL_EVENTS
```
public static final int CHANNEL_EVENTS
```
    See Also:
    Constant Field Values
  - CHANNEL_SYSLOG
```
public static final int CHANNEL_SYSLOG
```
    See Also:
    Constant Field Values
  - CHANNEL_ALARMS
```
public static final int CHANNEL_ALARMS
```
    See Also:
    Constant Field Values
  - CHANNEL_OBJECTS
```
public static final int CHANNEL_OBJECTS
```
    See Also:
    Constant Field Values
  - CHANNEL_SNMP_TRAPS
```
public static final int CHANNEL_SNMP_TRAPS
```
    See Also:
    Constant Field Values
  - CHANNEL_AUDIT_LOG
```
public static final int CHANNEL_AUDIT_LOG
```
    See Also:
    Constant Field Values
  - CHANNEL_SITUATIONS
```
public static final int CHANNEL_SITUATIONS
```
    See Also:
    Constant Field Values
  - OBJECT_SYNC_NOTIFY
```
public static final int OBJECT_SYNC_NOTIFY
```
    See Also:
    Constant Field Values
  - OBJECT_SYNC_WAIT
```
public static final int OBJECT_SYNC_WAIT
```
    See Also:
    Constant Field Values
  - CFG_IMPORT_REPLACE_EVENT_BY_CODE
```
public static final int CFG_IMPORT_REPLACE_EVENT_BY_CODE
```
    See Also:
    Constant Field Values
  - CFG_IMPORT_REPLACE_EVENT_BY_NAME
```
public static final int CFG_IMPORT_REPLACE_EVENT_BY_NAME
```
    See Also:
    Constant Field Values
  - ADDRESS_LIST_DISCOVERY_TARGETS
```
public static final int ADDRESS_LIST_DISCOVERY_TARGETS
```
    See Also:
    Constant Field Values
  - ADDRESS_LIST_DISCOVERY_FILTER
```
public static final int ADDRESS_LIST_DISCOVERY_FILTER
```
    See Also:
    Constant Field Values
  - SERVER_COMPONENT_DISCOVERY_MANAGER
```
public static final int SERVER_COMPONENT_DISCOVERY_MANAGER
```
    See Also:
    Constant Field Values
  - DESKTOP_CLIENT
```
public static final int DESKTOP_CLIENT
```
    See Also:
    Constant Field Values
  - WEB_CLIENT
```
public static final int WEB_CLIENT
```
    See Also:
    Constant Field Values
  - MOBILE_CLIENT
```
public static final int MOBILE_CLIENT
```
    See Also:
    Constant Field Values
  - TABLET_CLIENT
```
public static final int TABLET_CLIENT
```
    See Also:
    Constant Field Values
  - APPLICATION_CLIENT
```
public static final int APPLICATION_CLIENT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - NXCSession
```
public NXCSession(String connAddress)
```
    Parameters:
    connAddress -
    connLoginName -
    connPassword -
  - NXCSession
```
public NXCSession(String connAddress,
          int connPort)
```
    Parameters:
    connAddress -
    connPort -
    connLoginName -
    connPassword -
  - NXCSession
```
public NXCSession(String connAddress,
          int connPort,
          boolean connUseEncryption)
```
    Parameters:
    connAddress -
    connPort -
    connLoginName -
    connPassword -
    connUseEncryption -
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - createCustomObjectFromMessage
```
protected AbstractObject createCustomObjectFromMessage(int objectClass,
                                           org.netxms.base.NXCPMessage msg)
```
    Create custom object from NXCP message. May be overridden by derived classes to create custom NetXMS objects. This method called before standard object creation, so it can be used for overriding standard object classes. If this method returns null, standard object creation mechanism will be used. Default implementation will always return null.
    
    Parameters:
    objectClass - NetXMS object class ID
    msg - Source NXCP message
    
    Returns:
    NetXMS object or null if object cannot be created
  - addListener
```
public void addListener(SessionListener listener)
```
    Add notification listener
    
    Parameters:
    listener - Listener to add
  - removeListener
```
public void removeListener(SessionListener listener)
```
    Remove notification listener
    
    Parameters:
    listener - Listener to remove
  - addConsoleListener
```
public void addConsoleListener(ServerConsoleListener listener)
```
    Add server console listener
    
    Parameters:
    listener -
  - removeConsoleListener
```
public void removeConsoleListener(ServerConsoleListener listener)
```
    Remove server console listener
    
    Parameters:
    listener -
  - addMessageSubscription
```
public void addMessageSubscription(int messageCode,
                          long messageId,
                          MessageHandler handler)
```
    Subscribe to specific messages
    
    Parameters:
    messageCode -
    messageId -
    handler -
  - removeMessageSubscription
```
public void removeMessageSubscription(int messageCode,
                             long messageId)
```
    Parameters:
    messageCode -
    messageId -
  - sendNotification
```
protected void sendNotification(SessionNotification n)
```
    Call notification handlers on all registered listeners
    
    Parameters:
    n - Notification object
  - sendMessage
```
public void sendMessage(org.netxms.base.NXCPMessage msg)
                 throws IOException,
                        NXCException
```
    Send message to server
    
    Parameters:
    msg - Message to sent
    
    Throws:
    
    IOException - in case of socket communication failure
    
    NXCException - in case of encryption error
  - sendFile
```
protected void sendFile(long requestId,
            File file,
            ProgressListener listener)
                 throws IOException,
                        NXCException
```
    Send file over CSCP
    
    Parameters:
    requestId -
    file - source file to be sent
    
    Throws:
    
    IOException
    
    NXCException
  - sendFile
```
protected void sendFile(long requestId,
            byte[] data,
            ProgressListener listener)
                 throws IOException,
                        NXCException
```
    Send block of data as binary message
    
    Parameters:
    requestId -
    data -
    
    Throws:
    
    IOException
    
    NXCException
  - waitForMessage
```
public org.netxms.base.NXCPMessage waitForMessage(int code,
                                         long id,
                                         int timeout)
                                           throws NXCException
```
    Wait for message with specific code and id.
    
    Parameters:
    code - Message code
    id - Message id
    timeout - Wait timeout in milliseconds
    
    Returns:
    Message object
    
    Throws:
    
    NXCException - if message was not arrived within timeout interval
  - waitForMessage
```
public org.netxms.base.NXCPMessage waitForMessage(int code,
                                         long id)
                                           throws NXCException
```
    Wait for message with specific code and id.
    
    Parameters:
    code - Message code
    id - Message id
    
    Returns:
    Message object
    
    Throws:
    
    NXCException - if message was not arrived within timeout interval
  - waitForRCC
```
public org.netxms.base.NXCPMessage waitForRCC(long id)
                                       throws NXCException
```
    Wait for CMD_REQUEST_COMPLETED message with given id using default timeout
    
    Parameters:
    id - Message id
    
    Returns:
    received message
    
    Throws:
    
    NXCException - if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS
  - waitForRCC
```
public org.netxms.base.NXCPMessage waitForRCC(long id,
                                     int timeout)
                                       throws NXCException
```
    Wait for CMD_REQUEST_COMPLETED message with given id
    
    Parameters:
    id - Message id
    timeout - Timeout in milliseconds
    
    Returns:
    received message
    
    Throws:
    
    NXCException - if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS
  - newMessage
```
public final org.netxms.base.NXCPMessage newMessage(int code)
```
    Create new NXCP message with unique id
    
    Parameters:
    code - Message code
    
    Returns:
    New message object
  - waitForFile
```
public File waitForFile(long id,
               int timeout)
```
    Wait for specific file to arrive
    
    Parameters:
    id - Message ID
    timeout - Wait timeout in milliseconds
    
    Returns:
    Received file or null in case of failure
  - waitForFileTail
```
public String waitForFileTail(String fileName,
                     int timeout)
```
    Wait for specific file tail to arrive
    
    Parameters:
    fileName - Waiting file name
    timeout - Wait timeout in milliseconds
    
    Returns:
    Received tail string or null in case of failure
  - executeSimpleCommand
```
protected void executeSimpleCommand(int command)
                             throws IOException,
                                    NXCException
```
    Execute simple commands (without arguments and only returning RCC)
    
    Parameters:
    command - Command code
    
    Throws:
    
    IOException
    
    NXCException
  - receiveTable
```
public Table receiveTable(long requestId,
                 int msgCode)
                   throws NXCException
```
    Receive table from server.
    
    Parameters:
    requestId - request ID
    msgCode - Message code
    
    Returns:
    Received table
    
    Throws:
    
    NXCException - if operation was timed out
  - connect
```
public void connect()
             throws IOException,
                    UnknownHostException,
                    NXCException,
                    IllegalStateException
```
    Connect to NetMS server. Establish connection with the server and set up encryption if required. Only base protocol version check will be performed. Login must be performed before using session after successful connect.
    
    Throws:
    
    IOException
    
    UnknownHostException
    
    NXCException
    
    IllegalStateException
  - connect
```
public void connect(int[] componentVersions)
             throws IOException,
                    UnknownHostException,
                    NXCException,
                    IllegalStateException
```
    Connect to NetMS server. Establish connection with the server and set up encryption if required. Versions of protocol components given in *componentVersions* will be validated. Login must be performed before using session after successful connect.
    
    Parameters:
    componentVersions -
    
    Throws:
    
    IOException
    
    UnknownHostException
    
    NXCException
    
    IllegalStateException
  - login
```
public void login(String login,
         String password)
           throws NXCException,
                  IOException,
                  IllegalStateException
```
    Login to server using login name and password.
    
    Parameters:
    login - login name
    password - password
    
    Throws:
    
    NXCException
    
    IOException
    
    IllegalStateException
  - login
```
public void login(String login,
         Certificate certificate,
         Signature signature)
           throws NXCException,
                  IOException,
                  IllegalStateException
```
    Login to server using certificate.
    
    Parameters:
    authType - authentication type
    login - login name
    certificate - user's certificate
    signature - user's digital signature
    
    Throws:
    
    NXCException
    
    IOException
    
    IllegalStateException
  - login
```
public void login(AuthenticationType authType,
         String login,
         String password,
         Certificate certificate,
         Signature signature)
           throws NXCException,
                  IOException,
                  IllegalStateException
```
    Login to server.
    
    Parameters:
    authType - authentication type
    login - login name
    password - password
    certificate - user's certificate
    signature - user's digital signature
    
    Throws:
    
    NXCException
    
    IOException
    
    IllegalStateException
  - disconnect
```
public void disconnect()
```
    Disconnect from server.
  - isConnected
```
public boolean isConnected()
```
    Get connection state
    
    Returns:
    connection state
  - isEncrypted
```
public boolean isEncrypted()
```
    Get encryption state for current session.
    
    Returns:
    true if session is encrypted
  - isIgnoreProtocolVersion
```
public boolean isIgnoreProtocolVersion()
```
    Returns:
  - setIgnoreProtocolVersion
```
public void setIgnoreProtocolVersion(boolean ignoreProtocolVersion)
```
    If set to true, protocol version is not checked at connect.
    
    Parameters:
    ignoreProtocolVersion -
  - validateProtocolVersions
```
public boolean validateProtocolVersions(int[] versions)
```
    Validate protocol versions
    
    Parameters:
    versions -
    
    Returns:
  - getDefaultRecvBufferSize
```
public int getDefaultRecvBufferSize()
```
    Get default receiver buffer size.
    
    Returns:
    Default receiver buffer size in bytes.
  - getMaxRecvBufferSize
```
public int getMaxRecvBufferSize()
```
    Get max receiver buffer size.
    
    Returns:
    Max receiver buffer size in bytes.
  - setRecvBufferSize
```
public void setRecvBufferSize(int defaultBufferSize,
                     int maxBufferSize)
```
    Set receiver buffer size. This method should be called before connect(). It will not have any effect after connect().
    
    Parameters:
    defaultBufferSize - default size of receiver buffer in bytes.
    maxBufferSize - max size of receiver buffer in bytes.
  - getServerAddress
```
public String getServerAddress()
```
    Get server address
    
    Returns:
    Server address
  - getServerVersion
```
public String getServerVersion()
```
    Get NetXMS server version.
    
    Returns:
    Server version
  - getServerId
```
public long getServerId()
```
    Get NetXMS server UID.
    
    Returns:
    Server UID
  - getServerTimeZone
```
public String getServerTimeZone()
```
    Get server time zone.
    
    Returns:
    server's time zone string
  - getServerTime
```
public long getServerTime()
```
    Get server time
    
    Returns:
    the serverTime
  - getServerChallenge
```
public byte[] getServerChallenge()
```
    Returns:
    the serverChallenge
  - getTileServerURL
```
public String getTileServerURL()
```
    Returns:
    the tileServerURL
  - isZoningEnabled
```
public boolean isZoningEnabled()
```
    Returns:
    the zoningEnabled
  - isHelpdeskLinkActive
```
public boolean isHelpdeskLinkActive()
```
    Get status of helpdesk integration module on server.
    
    Returns:
    true if helpdesk integration module loaded on server
  - getClientInfo
```
public String getClientInfo()
```
    Get client information string
    
    Returns:
  - setClientInfo
```
public void setClientInfo(String connClientInfo)
```
    Set client information string
    
    Parameters:
    connClientInfo -
  - setCommandTimeout
```
public void setCommandTimeout(int commandTimeout)
```
    Set command execution timeout.
    
    Parameters:
    commandTimeout - New command timeout
  - getUserId
```
public int getUserId()
```
    Get identifier of logged in user.
    
    Returns:
    Identifier of logged in user
  - getUserName
```
public String getUserName()
```
    Returns:
    the userName
  - getAuthenticationMethod
```
public AuthenticationType getAuthenticationMethod()
```
    Returns:
    the authenticationMethod
  - getUserSystemRights
```
public long getUserSystemRights()
```
    Get system-wide rights of currently logged in user.
    
    Returns:
    System-wide rights of currently logged in user
  - isPasswordExpired
```
public boolean isPasswordExpired()
```
    Check if password is expired for currently logged in user.
    
    Returns:
    true if password is expired
  - getAlarmListDisplayLimit
```
public int getAlarmListDisplayLimit()
```
    Get maximum number of records allowed to be displayed in alarm list
  - syncObjects
```
public void syncObjects()
                 throws IOException,
                        NXCException
```
    Synchronizes NetXMS objects between server and client. After successful sync, subscribe client to object change notifications.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncObjectSet
```
public void syncObjectSet(long[] objects,
                 boolean syncComments)
                   throws IOException,
                          NXCException
```
    Synchronizes selected object set with the server.
    
    Parameters:
    objects - identifiers of objects need to be synchronized
    syncComments - if true, comments for objects will be synchronized as well
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncObjectSet
```
public void syncObjectSet(long[] objects,
                 boolean syncComments,
                 int options)
                   throws IOException,
                          NXCException
```
    Synchronizes selected object set with the server. The following options are accepted: OBJECT_SYNC_NOTIFY - send object update notification for each received object OBJECT_SYNC_WAIT - wait until all requested objects received
    
    Parameters:
    objects - identifiers of objects need to be synchronized
    syncComments - if true, comments for objects will be synchronized as well
    options - sync options (see above)
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncMissingObjects
```
public void syncMissingObjects(long[] objects,
                      boolean syncComments)
                        throws IOException,
                               NXCException
```
    Synchronize only those objects from given set which are not synchronized yet.
    
    Parameters:
    objects - identifiers of objects need to be synchronized
    syncComments - if true, comments for objects will be synchronized as well
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncMissingObjects
```
public void syncMissingObjects(long[] objects,
                      boolean syncComments,
                      int options)
                        throws IOException,
                               NXCException
```
    Synchronize only those objects from given set which are not synchronized yet. Accepts all options which are valid for syncObjectSet.
    
    Parameters:
    objects - identifiers of objects need to be synchronized
    syncComments - if true, comments for objects will be synchronized as well
    options - sync options (see comments for syncObjectSet)
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - findObjectById
```
public AbstractObject findObjectById(long id)
```
    Find NetXMS object by it's identifier.
    
    Parameters:
    id - Object identifier
    
    Returns:
    Object with given ID or null if object cannot be found
  - findObjectById
```
public <T extends AbstractObject> T findObjectById(long id,
                                          Class<T> requiredClass)
```
    Find NetXMS object by it's identifier with additional class checking.
    
    Parameters:
    id - object identifier
    requiredClass - required object class
    
    Returns:
    Object with given ID or null if object cannot be found or is not an instance of required class
  - findMultipleObjects
```
public List<AbstractObject> findMultipleObjects(long[] idList,
                                       boolean returnUnknown)
```
    Find multiple NetXMS objects by identifiers
    
    Parameters:
    idList - array of object identifiers
    returnUnknown - if true, this method will return UnknownObject placeholders for unknown object identifiers
    
    Returns:
    list of found objects
  - findMultipleObjects
```
public List<AbstractObject> findMultipleObjects(long[] idList,
                                       Class<? extends AbstractObject> classFilter,
                                       boolean returnUnknown)
```
    Find multiple NetXMS objects by identifiers
    
    Parameters:
    idList - array of object identifiers
    classFilter - class filter for objects, or null to disable filtering
    returnUnknown - if true, this method will return UnknownObject placeholders for unknown object identifiers
    
    Returns:
    list of found objects
  - findMultipleObjects
```
public List<AbstractObject> findMultipleObjects(Long[] idList,
                                       boolean returnUnknown)
```
    Find multiple NetXMS objects by identifiers
    
    Parameters:
    idList - array of object identifiers
    returnUnknown - if true, this method will return UnknownObject placeholders for unknown object identifiers
    
    Returns:
    array of found objects
  - findMultipleObjects
```
public List<AbstractObject> findMultipleObjects(Long[] idList,
                                       Class<? extends AbstractObject> classFilter,
                                       boolean returnUnknown)
```
    Find multiple NetXMS objects by identifiers
    
    Parameters:
    idList - array of object identifiers
    classFilter - class filter for objects, or null to disable filtering
    returnUnknown - if true, this method will return UnknownObject placeholders for unknown object identifiers
    
    Returns:
    array of found objects
  - findZone
```
public Zone findZone(long zoneId)
```
    Find zone object by zone ID.
    
    Parameters:
    zoneId - zone ID to find
    
    Returns:
    zone object or null
  - findObjectByName
```
public AbstractObject findObjectByName(String name)
```
    Find object by name. If multiple objects with same name exist, it is not determined what object will be returned. Name comparison is case-insensitive.
    
    Parameters:
    name - object name to find
    
    Returns:
    object with matching name or null
  - findObjectByNamePattern
```
public AbstractObject findObjectByNamePattern(String pattern)
```
    Find object by name using regular expression. If multiple objects with same name exist, it is not determined what object will be returned. Name comparison is case-insensitive.
    
    Parameters:
    pattern - regular expression for matching object name
    
    Returns:
    object with matching name or null
  - getTopLevelObjects
```
public AbstractObject[] getTopLevelObjects(Set<Integer> classFilter)
```
    Get list of top-level objects matching given class filter. Class filter may be null to ignore object class.
    
    Returns:
    List of all top matching level objects (either without parents or with inaccessible parents)
  - getTopLevelObjects
```
public AbstractObject[] getTopLevelObjects()
```
    Get list of top-level objects.
    
    Returns:
    List of all top level objects (either without parents or with inaccessible parents)
  - getAllObjects
```
public AbstractObject[] getAllObjects()
```
    Get list of all objects
    
    Returns:
    List of all objects
  - getObjectName
```
public String getObjectName(long objectId)
```
    Get object name by ID.
    
    Parameters:
    objectId - object ID
    
    Returns:
    object name if object is known, or string in form [] for unknown objects
  - getAlarms
```
public HashMap<Long,Alarm> getAlarms()
                              throws IOException,
                                     NXCException
```
    Get list of active alarms. For accessing terminated alarms log view API should be used.
    
    Returns:
    Hash map containing alarms
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getAlarm
```
public Alarm getAlarm(long alarmId)
               throws IOException,
                      NXCException
```
    Get information about single active alarm. Terminated alarms cannot be accessed with this call.
    
    Parameters:
    alarmId - alarm ID
    
    Returns:
    alarm object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getAlarmEvents
```
public List<EventInfo> getAlarmEvents(long alarmId)
                               throws IOException,
                                      NXCException
```
    Get information about events related to single active alarm. Information for terminated alarms cannot be accessed with this call. User must have "view alarms" permission on alarm's source node and "view event log" system-wide access.
    
    Parameters:
    alarmId - alarm ID
    
    Returns:
    list of related events
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - acknowledgeAlarm
```
public void acknowledgeAlarm(long alarmId,
                    boolean sticky,
                    int time)
                      throws IOException,
                             NXCException
```
    Acknowledge alarm.
    
    Parameters:
    alarmId - Identifier of alarm to be acknowledged.
    sticky - if set to true, acknowledged state will be made "sticky" (duplicate alarms with same key will not revert it back to outstanding)
    time - timeout for sticky acknowledge in seconds (0 for infinite)
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - acknowledgeAlarm
```
public void acknowledgeAlarm(long alarmId)
                      throws IOException,
                             NXCException
```
    Acknowledge alarm.
    
    Parameters:
    alarmId - Identifier of alarm to be acknowledged.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - acknowledgeAlarm
```
public void acknowledgeAlarm(String helpdeskReference)
                      throws IOException,
                             NXCException
```
    Acknowledge alarm by helpdesk reference.
    
    Parameters:
    helpdeskReference - Helpdesk issue reference (e.g. JIRA issue key)
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - resolveAlarm
```
public void resolveAlarm(long alarmId)
                  throws IOException,
                         NXCException
```
    Resolve alarm.
    
    Parameters:
    alarmId - Identifier of alarm to be resolved.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - resolveAlarm
```
public void resolveAlarm(String helpdeskReference)
                  throws IOException,
                         NXCException
```
    Resolve alarm by helpdesk reference.
    
    Parameters:
    helpdeskReference - Identifier of alarm to be resolved.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - terminateAlarm
```
public void terminateAlarm(long alarmId)
                    throws IOException,
                           NXCException
```
    Terminate alarm.
    
    Parameters:
    alarmId - Identifier of alarm to be terminated.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - terminateAlarm
```
public void terminateAlarm(String helpdeskReference)
                    throws IOException,
                           NXCException
```
    Terminate alarm by helpdesk reference.
    
    Parameters:
    helpdeskReference - Identifier of alarm to be resolved.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteAlarm
```
public void deleteAlarm(long alarmId)
                 throws IOException,
                        NXCException
```
    Delete alarm.
    
    Parameters:
    alarmId - Identifier of alarm to be deleted.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - openHelpdeskIssue
```
public String openHelpdeskIssue(long alarmId)
                         throws IOException,
                                NXCException
```
    Open issue in helpdesk system from given alarm
    
    Parameters:
    alarmId - alarm identifier
    
    Returns:
    helpdesk issue identifier
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getHelpdeskIssueUrl
```
public String getHelpdeskIssueUrl(long alarmId)
                           throws IOException,
                                  NXCException
```
    Get URL for helpdesk issue associated with given alarm
    
    Parameters:
    alarmId -
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unlinkHelpdeskIssue
```
public void unlinkHelpdeskIssue(String helpdeskReference)
                         throws IOException,
                                NXCException
```
    Unlink helpdesk issue from alarm. User must have OBJECT_ACCESS_UPDATE_ALARMS access right on alarm's source object and SYSTEM_ACCESS_UNLINK_ISSUES system wide access right.
    
    Parameters:
    helpdeskReference -
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unlinkHelpdeskIssue
```
public void unlinkHelpdeskIssue(long alarmId)
                         throws IOException,
                                NXCException
```
    Unlink helpdesk issue from alarm. User must have OBJECT_ACCESS_UPDATE_ALARMS access right on alarm's source object and SYSTEM_ACCESS_UNLINK_ISSUES system wide access right.
    
    Parameters:
    helpdeskReference -
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getAlarmComments
```
public List<AlarmComment> getAlarmComments(long alarmId)
                                    throws IOException,
                                           NXCException
```
    Get list of comments for given alarm.
    
    Parameters:
    alarmId - alarm ID
    
    Returns:
    list of alarm comments
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteAlarmComment
```
public void deleteAlarmComment(long alarmId,
                      long commentId)
                        throws IOException,
                               NXCException
```
    Delete alarm comment.
    
    Parameters:
    alarmId - alarm ID
    commentId - comment ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createAlarmComment
```
public void createAlarmComment(long alarmId,
                      String text)
                        throws IOException,
                               NXCException
```
    Create alarm comment.
    
    Parameters:
    alarmId -
    text -
    
    Throws:
    
    IOException
    
    NXCException
  - createAlarmComment
```
public void createAlarmComment(String helpdeskReference,
                      String text)
                        throws IOException,
                               NXCException
```
    Create alarm comment by helpdesk reference.
    
    Parameters:
    helpdeskReference -
    text -
    
    Throws:
    
    IOException
    
    NXCException
  - updateAlarmComment
```
public void updateAlarmComment(long alarmId,
                      long commentId,
                      String text)
                        throws IOException,
                               NXCException
```
    Update alarm comment. If alarmId == 0 — new comment will be created.
    
    Parameters:
    alarmId - alarm ID
    commentId - comment ID or 0 for creating new comment
    text - message text
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setAlarmFlowState
```
public void setAlarmFlowState(int state)
                       throws IOException,
                              NXCException
```
    Changes state of alarm status flow. Strict or not - terminate state can be set only after resolve state or after any state.
    
    Parameters:
    state - state of alarm status flow - strict or not (1 or 0)
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getServerVariables
```
public Map<String,ServerVariable> getServerVariables()
                                              throws IOException,
                                                     NXCException
```
    Get server configuration variables
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - setServerVariable
```
public void setServerVariable(String name,
                     String value)
                       throws IOException,
                              NXCException
```
    Set server configuration variable
    
    Parameters:
    name -
    value -
    
    Throws:
    
    IOException
    
    NXCException
  - deleteServerVariable
```
public void deleteServerVariable(String name)
                          throws IOException,
                                 NXCException
```
    Delete server configuration variable
    
    Parameters:
    name -
    
    Throws:
    
    IOException
    
    NXCException
  - getServerConfigClob
```
public String getServerConfigClob(String name)
                           throws IOException,
                                  NXCException
```
    Get server config CLOB
    
    Parameters:
    name -
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - setServerConfigClob
```
public void setServerConfigClob(String name,
                       String value)
                         throws IOException,
                                NXCException
```
    Set server config CLOB
    
    Parameters:
    name -
    value -
    
    Throws:
    
    IOException
    
    NXCException
  - subscribe
```
public void subscribe(int channels)
               throws IOException,
                      NXCException
```
    Subscribe to notification channel(s)
    
    Parameters:
    channels - Notification channels to subscribe to. Multiple channels can be specified by combining them with OR operation.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unsubscribe
```
public void unsubscribe(int channels)
                 throws IOException,
                        NXCException
```
    Unsubscribe from notification channel(s)
    
    Parameters:
    channels - Notification channels to unsubscribe from. Multiple channels can be specified by combining them with OR operation.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncUserDatabase
```
public void syncUserDatabase()
                      throws IOException,
                             NXCException
```
    Synchronize user database
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - findUserDBObjectById
```
public AbstractUserObject findUserDBObjectById(long id)
```
    Find user by ID
    
    Returns:
    User object with given ID or null if such user does not exist
  - getUserDatabaseObjects
```
public AbstractUserObject[] getUserDatabaseObjects()
```
    Get list of all user database objects
    
    Returns:
    List of all user database objects
  - createUser
```
public long createUser(String name)
                throws IOException,
                       NXCException
```
    Create user on server
    
    Parameters:
    name - Login name for new user
    
    Returns:
    ID assigned to newly created user
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createUserGroup
```
public long createUserGroup(String name)
                     throws IOException,
                            NXCException
```
    Create user group on server
    
    Parameters:
    name - Name for new user group
    
    Returns:
    ID assigned to newly created user group
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteUserDBObject
```
public void deleteUserDBObject(long id)
                        throws IOException,
                               NXCException
```
    Delete user or group on server
    
    Parameters:
    id - User or group ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setUserPassword
```
public void setUserPassword(long id,
                   String newPassword,
                   String oldPassword)
                     throws IOException,
                            NXCException
```
    Set password for user
    
    Parameters:
    id - User ID
    newPassword - New password
    oldPassword - Old password
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyUserDBObject
```
public void modifyUserDBObject(AbstractUserObject object,
                      int fields)
                        throws IOException,
                               NXCException
```
    Modify user database object
    
    Parameters:
    object - User data
    fields - bit mask indicating fields to modify
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyUserDBObject
```
public void modifyUserDBObject(AbstractUserObject object)
                        throws IOException,
                               NXCException
```
    Modify user database object
    
    Parameters:
    object - User data
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - lockUserDatabase
```
public void lockUserDatabase()
                      throws IOException,
                             NXCException
```
    Lock user database
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unlockUserDatabase
```
public void unlockUserDatabase()
                        throws IOException,
                               NXCException
```
    Unlock user database
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setAttributeForCurrentUser
```
public void setAttributeForCurrentUser(String name,
                              String value)
                                throws IOException,
                                       NXCException
```
    Set custom attribute for currently logged in user. Server will allow to change only attributes whose name starts with dot.
    
    Parameters:
    name - Attribute's name
    value - New attribute's value
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getAttributeForCurrentUser
```
public String getAttributeForCurrentUser(String name)
                                  throws IOException,
                                         NXCException
```
    Get custom attribute for currently logged in user. If attribute is not set, empty string will be returned.
    
    Parameters:
    name - Attribute's name
    
    Returns:
    Attribute's value
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getLastValues
```
public DciValue[] getLastValues(long nodeId,
                       boolean objectTooltipOnly,
                       boolean overviewOnly,
                       boolean includeNoValueObjects)
                         throws IOException,
                                NXCException
```
    Get last DCI values for given node
    
    Parameters:
    nodeId - ID of the node to get DCI values for
    objectTooltipOnly - if set to true, only DCIs with DCF_SHOW_ON_OBJECT_TOOLTIP flag set are returned
    overviewOnly - if set to true, only DCIs with DCF_SHOW_IN_OBJECT_OVERVIEW flag set are returned
    includeNoValueObjects - if set to true, objects with no value (like instance discovery DCIs) will be returned as well
    
    Returns:
    List of DCI values
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getLastValues
```
public DciValue[] getLastValues(long nodeId)
                         throws IOException,
                                NXCException
```
    Get last DCI values for given node
    
    Parameters:
    nodeId - ID of the node to get DCI values for
    
    Returns:
    List of DCI values
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getLastValues
```
public DciValue[] getLastValues(Set<MapDCIInstance> dciIDList)
                         throws IOException,
                                NXCException
```
    Get last DCI values for given DCI id list(list can contain simple DCIss and table DCIs)
    
    Parameters:
    dciIDList - List with all required data to get last DCI id
    
    Returns:
    List of DCI values
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getTableLastValues
```
public Table getTableLastValues(long nodeId,
                       long dciId)
                         throws IOException,
                                NXCException
```
    Get last values for given table DCI on given node
    
    Parameters:
    nodeId - ID of the node to get DCI values for
    dciId - DCI ID
    
    Returns:
    Table object with last values for table DCI
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getPerfTabItems
```
public PerfTabDci[] getPerfTabItems(long nodeId)
                             throws IOException,
                                    NXCException
```
    Get list of DCIs configured to be shown on performance tab in console for given node.
    
    Parameters:
    nodeId - Node object ID
    
    Returns:
    List of performance tab DCIs
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getThresholdSummary
```
public List<ThresholdViolationSummary> getThresholdSummary(long objectId)
                                                    throws IOException,
                                                           NXCException
```
    Get threshold violation summary for all nodes under given parent object. Parent object could be container, subnet, zone, entire network, or infrastructure service root.
    
    Parameters:
    objectId - parent object ID
    
    Returns:
    list of threshold violation summary objects for all nodes below given root
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getCollectedData
```
public DciData getCollectedData(long nodeId,
                       long dciId,
                       Date from,
                       Date to,
                       int maxRows)
                         throws IOException,
                                NXCException
```
    Get collected DCI data from server. Please note that you should specify either row count limit or time from/to limit.
    
    Parameters:
    nodeId - Node ID
    dciId - DCI ID
    from - Start of time range or null for no limit
    to - End of time range or null for no limit
    maxRows - Maximum number of rows to retrieve or 0 for no limit
    
    Returns:
    DCI data set
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getCollectedTableData
```
public DciData getCollectedTableData(long nodeId,
                            long dciId,
                            String instance,
                            String dataColumn,
                            Date from,
                            Date to,
                            int maxRows)
                              throws IOException,
                                     NXCException
```
    Get collected table DCI data from server. Please note that you should specify either row count limit or time from/to limit.
    
    Parameters:
    nodeId - Node ID
    dciId - DCI ID
    instance - instance value
    dataColumn - name of column to retrieve data from
    from - Start of time range or null for no limit
    to - End of time range or null for no limit
    maxRows - Maximum number of rows to retrieve or 0 for no limit
    
    Returns:
    DCI data set
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - clearCollectedData
```
public void clearCollectedData(long nodeId,
                      long dciId)
                        throws IOException,
                               NXCException
```
    Clear collected data for given DCI
    
    Parameters:
    nodeId - Node object ID
    dciId - DCI ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - forceDCIPoll
```
public void forceDCIPoll(long nodeId,
                long dciId)
                  throws IOException,
                         NXCException
```
    Force DCI poll for given DCI
    
    Parameters:
    nodeId - Node object ID
    dciId - DCI ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getThresholds
```
public Threshold[] getThresholds(long nodeId,
                        long dciId)
                          throws IOException,
                                 NXCException
```
    Get list of thresholds configured for given DCI
    
    Parameters:
    nodeId - Node object ID
    dciId - DCI ID
    
    Returns:
    List of configured thresholds
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - resolveDciNames
```
public String[] resolveDciNames(long[] nodeIds,
                       long[] dciIds)
                         throws IOException,
                                NXCException
```
    Resolve names of given DCIs
    
    Parameters:
    nodeIds - node identifiers
    dciIds - DCI identifiers (length must match length of node identifiers list)
    
    Returns:
    array of resolved DCI names
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - resolveDciNames
```
public String[] resolveDciNames(Collection<ConditionDciInfo> dciList)
                         throws IOException,
                                NXCException
```
    Resolve names of given DCIs
    
    Parameters:
    dciList - DCI list
    
    Returns:
    array of resolved DCI names
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - queryParameter
```
public String queryParameter(long nodeId,
                    int origin,
                    String name)
                      throws IOException,
                             NXCException
```
    Query parameter immediately. This call will cause server to do actual call to managed node and will return current value for given parameter. Result is not cached.
    
    Parameters:
    nodeId - node object ID
    origin - parameter's origin (NetXMS agent, SNMP, etc.)
    name - parameter's name
    
    Returns:
    current parameter's value
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - queryAgentTable
```
public Table queryAgentTable(long nodeId,
                    String name)
                      throws IOException,
                             NXCException
```
    Query agent's table immediately. This call will cause server to do actual call to managed node and will return current value for given table. Result is not cached.
    
    Parameters:
    nodeId - node object ID
    name - table's name
    
    Returns:
    current table's value
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createCustomObject
```
protected void createCustomObject(NXCObjectCreationData data,
                      Object userData,
                      org.netxms.base.NXCPMessage msg)
```
    Hook method to allow adding of custom object creation data to NXCP message. Default implementation does nothing.
    
    Parameters:
    data - object creation data passed to createObject
    userData - user-defined data for object creation passed to createObject
    msg - NXCP message that will be sent to server
  - createObject
```
public long createObject(NXCObjectCreationData data,
                Object userData)
                  throws IOException,
                         NXCException
```
    Create new NetXMS object.
    
    Parameters:
    data - Object creation data
    userData - User-defined data for custom object creation
    
    Returns:
    ID of new object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createObject
```
public long createObject(NXCObjectCreationData data)
                  throws IOException,
                         NXCException
```
    Create new NetXMS object. Equivalent of calling createObject(data, null).
    
    Parameters:
    data - Object creation data
    
    Returns:
    ID of new object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteObject
```
public void deleteObject(long objectId)
                  throws IOException,
                         NXCException
```
    Delete object
    
    Parameters:
    objectId - ID of an object which should be deleted
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyCustomObject
```
protected void modifyCustomObject(NXCObjectModificationData data,
                      Object userData,
                      org.netxms.base.NXCPMessage msg)
```
    Hook method to populate NXCP message with custom object's data on object modification. Default implementation does nothing.
    
    Parameters:
    data - object modification data passed to modifyObject
    userData - user-defined data passed to modifyObject
    msg - NXCP message to be sent to server
  - modifyObject
```
public void modifyObject(NXCObjectModificationData data,
                Object userData)
                  throws IOException,
                         NXCException
```
    Modify object (generic interface, in most cases wrapper functions should be used instead).
    
    Parameters:
    data - Object modification data
    userData - user-defined data for custom object modification
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyObject
```
public void modifyObject(NXCObjectModificationData data)
                  throws IOException,
                         NXCException
```
    Modify object (generic interface, in most cases wrapper functions should be used instead). Equivalent of calling modifyObject(data, null).
    
    Parameters:
    data - Object modification data
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setObjectName
```
public void setObjectName(long objectId,
                 String name)
                   throws IOException,
                          NXCException
```
    Change object's name (wrapper for modifyObject())
    
    Parameters:
    objectId - ID of object to be changed
    name - New object's name
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setObjectCustomAttributes
```
public void setObjectCustomAttributes(long objectId,
                             Map<String,String> attrList)
                               throws IOException,
                                      NXCException
```
    Change object's custom attributes (wrapper for modifyObject())
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setObjectACL
```
public void setObjectACL(long objectId,
                AccessListElement[] acl,
                boolean inheritAccessRights)
                  throws IOException,
                         NXCException
```
    Change object's ACL (wrapper for modifyObject())
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - changeObjectZone
```
public void changeObjectZone(long objectId,
                    long zoneId)
                      throws IOException,
                             NXCException
```
    Move object to different zone. Only nodes and clusters can be moved between zones.
    
    Parameters:
    objectId - Node or cluster object ID
    zoneId -
    
    Throws:
    
    IOException
    
    NXCException
  - updateObjectComments
```
public void updateObjectComments(long objectId,
                        String comments)
                          throws IOException,
                                 NXCException
```
    Change object's comments.
    
    Parameters:
    objectId - Object's ID
    comments - New comments
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setObjectManaged
```
public void setObjectManaged(long objectId,
                    boolean isManaged)
                      throws IOException,
                             NXCException
```
    Set object's managed status.
    
    Parameters:
    objectId - object's identifier
    isManaged - object's managed status
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getEffectiveRights
```
public int getEffectiveRights(long objectId)
                       throws IOException,
                              NXCException
```
    Get effective rights of currently logged in user to given object.
    
    Parameters:
    objectId -
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - bindObject
```
public void bindObject(long parentId,
              long childId)
                throws IOException,
                       NXCException
```
    Bind object.
    
    Parameters:
    parentId - parent object's identifier
    childId - Child object's identifier
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unbindObject
```
public void unbindObject(long parentId,
                long childId)
                  throws IOException,
                         NXCException
```
    Unbind object.
    
    Parameters:
    parentId - parent object's identifier
    childId - Child object's identifier
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - removeTemplate
```
public void removeTemplate(long templateId,
                  long nodeId,
                  boolean removeDci)
                    throws IOException,
                           NXCException
```
    Remove data collection template from node.
    
    Parameters:
    templateId - template object identifier
    nodeId - node object identifier
    removeDci - true if DCIs created from this template should be removed
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - applyTemplate
```
public void applyTemplate(long templateId,
                 long nodeId)
                   throws IOException,
                          NXCException
```
    Apply data collection template to node.
    
    Parameters:
    templateId - template object ID
    nodeId - node object ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - addClusterNode
```
public void addClusterNode(long clusterId,
                  long nodeId)
                    throws IOException,
                           NXCException
```
    Add node to cluster.
    
    Parameters:
    clusterId - cluster object ID
    nodeId - node object ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - removeClusterNode
```
public void removeClusterNode(long clusterId,
                     long nodeId)
                       throws IOException,
                              NXCException
```
    Remove node from cluster.
    
    Parameters:
    clusterId - cluster object ID
    nodeId - node object ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - queryLayer2Topology
```
public NetworkMapPage queryLayer2Topology(long nodeId)
                                   throws IOException,
                                          NXCException
```
    Query layer 2 topology for node
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - executeAction
```
public void executeAction(long nodeId,
                 String action)
                   throws IOException,
                          NXCException
```
    Execute action on remote agent
    
    Parameters:
    nodeId - Node object ID
    action - Action name
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - executeAction
```
public void executeAction(long nodeId,
                 String action,
                 boolean receiveOutput,
                 TextOutputListener listener,
                 Writer writer)
                   throws IOException,
                          NXCException
```
    Execute action on remote agent
    
    Parameters:
    nodeId - Node object ID
    action - Action name
    receiveOutput - true if action's output has to be read
    listener - listener for action's output or null
    writer - writer for action's output or null
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - wakeupNode
```
public void wakeupNode(long objectId)
                throws IOException,
                       NXCException
```
    Wakeup node by sending wake-on-LAN magic packet. Either node ID or interface ID may be given. If node ID is given, system will send wakeup packets to all active interfaces with IP address.
    
    Parameters:
    objectId - node or interface ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getNodePhysicalComponents
```
public PhysicalComponent getNodePhysicalComponents(long nodeId)
                                            throws IOException,
                                                   NXCException
```
    Get node's physical components (obtained from ENTITY-MIB).
    
    Parameters:
    nodeId - node object identifier
    
    Returns:
    root component
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getNodeWinPerfObjects
```
public List<WinPerfObject> getNodeWinPerfObjects(long nodeId)
                                          throws IOException,
                                                 NXCException
```
    Get list of available Windows performance objects. Returns empty list if node does is not a Windows node or does not have WinPerf subagent installed.
    
    Parameters:
    nodeId - node object ID
    
    Returns:
    list of available Windows performance objects
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getNodeSoftwarePackages
```
public List<SoftwarePackage> getNodeSoftwarePackages(long nodeId)
                                              throws IOException,
                                                     NXCException
```
    Get list of software packages installed on node.
    
    Parameters:
    nodeId - node object identifier
    
    Returns:
    root component
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getServerJobList
```
public ServerJob[] getServerJobList()
                             throws IOException,
                                    NXCException
```
    Get list of server jobs
    
    Returns:
    list of server jobs
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - cancelServerJob
```
public void cancelServerJob(long jobId)
                     throws IOException,
                            NXCException
```
    Cancel server job
    
    Parameters:
    jobId - Job ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - holdServerJob
```
public void holdServerJob(long jobId)
                   throws IOException,
                          NXCException
```
    Put server job on hold
    
    Parameters:
    jobId - Job ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unholdServerJob
```
public void unholdServerJob(long jobId)
                     throws IOException,
                            NXCException
```
    Put server on hold job to pending state
    
    Parameters:
    jobId - Job ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deployAgentPolicy
```
public void deployAgentPolicy(long policyId,
                     long nodeId)
                       throws IOException,
                              NXCException
```
    Deploy policy on agent
    
    Parameters:
    policyId - Policy object ID
    nodeId - Node object ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - uninstallAgentPolicy
```
public void uninstallAgentPolicy(long policyId,
                        long nodeId)
                          throws IOException,
                                 NXCException
```
    Uninstall policy from agent
    
    Parameters:
    policyId - Policy object ID
    nodeId - Node object ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getEventProcessingPolicy
```
public EventProcessingPolicy getEventProcessingPolicy()
                                               throws IOException,
                                                      NXCException
```
    Get read-only copy of ebent processing policy.
    
    Returns:
    Event processing policy
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - openEventProcessingPolicy
```
public EventProcessingPolicy openEventProcessingPolicy()
                                                throws IOException,
                                                       NXCException
```
    Open event processing policy for editing. This call will lock event processing policy on server until closeEventProcessingPolicy called or session terminated.
    
    Returns:
    Event processing policy
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - saveEventProcessingPolicy
```
public void saveEventProcessingPolicy(EventProcessingPolicy epp)
                               throws IOException,
                                      NXCException
```
    Save event processing policy. If policy was not previously open by current session exception will be thrown.
    
    Parameters:
    epp - Modified event processing policy
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - closeEventProcessingPolicy
```
public void closeEventProcessingPolicy()
                                throws IOException,
                                       NXCException
```
    Close event processing policy. This call will unlock event processing policy on server. If policy was not previously open by current session exception will be thrown.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - openDataCollectionConfiguration
```
public DataCollectionConfiguration openDataCollectionConfiguration(long nodeId)
                                                            throws IOException,
                                                                   NXCException
```
    Open data collection configuration for given node. You must call DataCollectionConfiguration.close() to close data collection configuration when it is no longer needed.
    
    Parameters:
    nodeId - Node object identifier
    
    Returns:
    Data collection configuration object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - testTransformationScript
```
public TransformationTestResult testTransformationScript(long nodeId,
                                                String script,
                                                String inputValue)
                                                  throws IOException,
                                                         NXCException
```
    Test DCI transformation script.
    
    Parameters:
    nodeId - ID of the node object to test script on
    script - script source code
    inputValue - input value for the script
    
    Returns:
    test execution results
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - executeScript
```
public void executeScript(long nodeId,
                 String script,
                 TextOutputListener listener)
                   throws IOException,
                          NXCException
```
    Execute script.
    
    Parameters:
    nodeId - ID of the node object to test script on
    script - script source code
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - openServerLog
```
public Log openServerLog(String logName)
                  throws IOException,
                         NXCException
```
    Open server log by name.
    
    Parameters:
    logName - Log name
    
    Returns:
    Log object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - syncEventTemplates
```
public void syncEventTemplates()
                        throws IOException,
                               NXCException
```
    Synchronize event templates configuration. After call to this method session object will maintain internal list of configured event templates.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getCachedEventTemplates
```
public EventTemplate[] getCachedEventTemplates()
```
    Get cached list event templates
    
    Returns:
    List of event templates cached by client library
  - findEventTemplateByName
```
public EventTemplate findEventTemplateByName(String name)
```
    Find event template by name in event template database internally maintained by session object. You must call NXCSession.syncEventTemplates() first to make local copy of event template database.
    
    Parameters:
    name - Event name
    
    Returns:
    Event template object or null if not found
  - findEventTemplateByCode
```
public EventTemplate findEventTemplateByCode(long code)
```
    Find event template by code in event template database internally maintained by session object. You must call NXCSession.syncEventTemplates() first to make local copy of event template database.
    
    Parameters:
    code - Event code
    
    Returns:
    Event template object or null if not found
  - findMultipleEventTemplates
```
public List<EventTemplate> findMultipleEventTemplates(Long[] codes)
```
    Find multiple event templates by event codes in event template database internally maintained by session object. You must call NXCSession.syncEventTemplates() first to make local copy of event template database.
    
    Parameters:
    codes - List of event codes
    
    Returns:
    List of found event templates
  - findMultipleEventTemplates
```
public List<EventTemplate> findMultipleEventTemplates(long[] codes)
```
    Find multiple event templates by event codes in event template database internally maintained by session object. You must call NXCSession.syncEventTemplates() first to make local copy of event template database.
    
    Parameters:
    codes - List of event codes
    
    Returns:
    List of found event templates
  - getEventTemplates
```
public List<EventTemplate> getEventTemplates()
                                      throws IOException,
                                             NXCException
```
    Get event templates from server
    
    Returns:
    List of configured event templates
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - generateEventCode
```
public long generateEventCode()
                       throws IOException,
                              NXCException
```
    Generate code for new event template.
    
    Returns:
    Code for new event template
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteEventTemplate
```
public void deleteEventTemplate(long eventCode)
                         throws IOException,
                                NXCException
```
    Delete event template.
    
    Parameters:
    eventCode - Event code
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyEventTemplate
```
public void modifyEventTemplate(EventTemplate evt)
                         throws IOException,
                                NXCException
```
    Modify event template.
    
    Parameters:
    evt - Event template
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - sendEvent
```
public void sendEvent(long eventCode,
             String eventName,
             long objectId,
             String[] parameters,
             String userTag)
               throws IOException,
                      NXCException
```
    Send event to server. Event can be identified either by event code or event name. If event name is given, event code will be ignored.
    Node: sending events by name supported by server version 1.1.8 and higher.
    
    Parameters:
    eventCode - event code. Ignored if event name is not null.
    eventName - event name. Must be set to null if event identified by code.
    objectId - Object ID to send event on behalf of. If set to 0, server will determine object ID by client IP address.
    parameters - event's parameters
    userTag - event's user tag
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - sendEvent
```
public void sendEvent(long eventCode,
             String[] parameters)
               throws IOException,
                      NXCException
```
    Convenience wrapper for sendEvent interface.
    
    Parameters:
    eventCode - event code
    parameters - event's parameters
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - sendEvent
```
public void sendEvent(String eventName,
             String[] parameters)
               throws IOException,
                      NXCException
```
    Convenience wrapper for sendEvent interface.
    
    Parameters:
    eventName - event name
    parameters - event's parameters
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSnmpCommunities
```
public List<String> getSnmpCommunities()
                                throws IOException,
                                       NXCException
```
    Get list of well-known SNMP communities configured on server.
    
    Returns:
    List of SNMP community strings
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - updateSnmpCommunities
```
public void updateSnmpCommunities(List<String> list)
                           throws IOException,
                                  NXCException
```
    Update list of well-known SNMP community strings on server. Existing list will be replaced by given one.
    
    Parameters:
    list - New list of SNMP community strings
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSnmpUsmCredentials
```
public List<SnmpUsmCredential> getSnmpUsmCredentials()
                                              throws IOException,
                                                     NXCException
```
    Get list of well-known SNMP USM (user security model) credentials configured on server.
    
    Returns:
    List of SNMP USM credentials
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - updateSnmpUsmCredentials
```
public void updateSnmpUsmCredentials(List<SnmpUsmCredential> list)
                              throws IOException,
                                     NXCException
```
    Update list of well-known SNMP USM credentials on server. Existing list will be replaced by given one.
    
    Parameters:
    list - New list of SNMP USM credentials
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getAgentConfig
```
public String getAgentConfig(long nodeId)
                      throws IOException,
                             NXCException
```
    Get agent's master configuration file.
    
    Parameters:
    nodeId - Node ID
    
    Returns:
    Master configuration file of agent running on given node
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - updateAgentConfig
```
public void updateAgentConfig(long nodeId,
                     String config,
                     boolean apply)
                       throws IOException,
                              NXCException
```
    Update agent's master configuration file.
    
    Parameters:
    nodeId - Node ID
    config - New configuration file content
    apply - Apply flag - if set to true, agent will restart automatically to apply changes
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSupportedParameters
```
public List<AgentParameter> getSupportedParameters(long nodeId)
                                            throws IOException,
                                                   NXCException
```
    Get list of parameters supported by agent running on given node.
    
    Parameters:
    nodeId - Node ID
    
    Returns:
    List of parameters supported by agent
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSupportedTables
```
public List<AgentTable> getSupportedTables(long nodeId)
                                    throws IOException,
                                           NXCException
```
    Get list of tables supported by agent running on given node.
    
    Parameters:
    nodeId - Node ID
    
    Returns:
    List of tables supported by agent
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getDataCollectionEvents
```
public long[] getDataCollectionEvents(long objectId)
                               throws IOException,
                                      NXCException
```
    Get all events used in data collection by given node, cluster, or template object.
    
    Parameters:
    objectId - node, cluster, or template object ID
    
    Returns:
    list of used event codes
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getDataCollectionScripts
```
public List<Script> getDataCollectionScripts(long objectId)
                                      throws IOException,
                                             NXCException
```
    Get names of all scripts used in data collection by given node, cluster, or template object.
    
    Parameters:
    objectId - node, cluster, or template object ID
    
    Returns:
    list of used library scripts
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - exportConfiguration
```
public String exportConfiguration(String description,
                         long[] events,
                         long[] traps,
                         long[] templates,
                         UUID[] rules,
                         long[] scripts,
                         long[] objectTools,
                         long[] dciSummaryTables)
                           throws IOException,
                                  NXCException
```
    Export server configuration. Returns requested configuration elements exported into XML.
    
    Parameters:
    description - Description of exported configuration
    events - List of event codes
    traps - List of trap identifiers
    templates - List of template object identifiers
    rules - List of event processing rule GUIDs
    scripts - List of library script identifiers
    objectTools - List of object tool identifiers
    dciSummaryTables - List of DCI summary table identifiers
    
    Returns:
    resulting XML document
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - importConfiguration
```
public void importConfiguration(String config,
                       int flags)
                         throws IOException,
                                NXCException
```
    Import server configuration (events, traps, thresholds) from XML
    
    Parameters:
    config - Configuration in XML format
    flags - Import flags
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getServerStats
```
public Map<String,Object> getServerStats()
                                  throws IOException,
                                         NXCException
```
    Get server stats. Returns set of named properties. The following properties could be found in result set: String: VERSION Integer: UPTIME, SESSION_COUNT, DCI_COUNT, OBJECT_COUNT, NODE_COUNT, PHYSICAL_MEMORY_USED, VIRTUAL_MEMORY_USED, QSIZE_CONDITION_POLLER, QSIZE_CONF_POLLER, QSIZE_DCI_POLLER, QSIZE_DBWRITER, QSIZE_EVENT, QSIZE_DISCOVERY, QSIZE_NODE_POLLER, QSIZE_ROUTE_POLLER, QSIZE_STATUS_POLLER, QSIZE_DCI_CACHE_LOADER, ALARM_COUNT long[]: ALARMS_BY_SEVERITY
    
    Returns:
    Server stats as set of named properties.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getActions
```
public List<ServerAction> getActions()
                              throws IOException,
                                     NXCException
```
    Get list of configured actions from server
    
    Returns:
    List of configured actions
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createAction
```
public long createAction(String name)
                  throws IOException,
                         NXCException
```
    Create new server action.
    
    Parameters:
    name - action name
    
    Returns:
    ID assigned to new action
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyAction
```
public void modifyAction(ServerAction action)
                  throws IOException,
                         NXCException
```
    Modify server action
    
    Parameters:
    action - Action object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteAction
```
public void deleteAction(long actionId)
                  throws IOException,
                         NXCException
```
    Delete server action
    
    Parameters:
    actionId - Action ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getCertificateList
```
public List<AuthCertificate> getCertificateList()
                                         throws IOException,
                                                NXCException
```
    Get list of certificates
    
    Returns:
    List of certificates
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createNewCertificate
```
public void createNewCertificate(byte[] data,
                        String comments)
                          throws IOException,
                                 NXCException
```
    Create new certificate
    
    Parameters:
    data - certificate file content
    comments - comment for certificate
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteCertificate
```
public void deleteCertificate(long id)
                       throws IOException,
                              NXCException
```
    Delete certificate
    
    Parameters:
    id - the certificate id
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - updateCertificate
```
public void updateCertificate(long id,
                     String comment)
                       throws IOException,
                              NXCException
```
    Update certificate
    
    Parameters:
    id - the certificate id
    comment - the certificate comment
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getObjectTools
```
public List<ObjectTool> getObjectTools()
                                throws IOException,
                                       NXCException
```
    Get list of configured object tools
    
    Returns:
    List of object tools
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getObjectToolDetails
```
public ObjectToolDetails getObjectToolDetails(long toolId)
                                       throws IOException,
                                              NXCException
```
    Get object tool details
    
    Parameters:
    toolId - Tool ID
    
    Returns:
    Object tool details
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - generateObjectToolId
```
public long generateObjectToolId()
                          throws IOException,
                                 NXCException
```
    Generate unique ID for new object tool.
    
    Returns:
    Unique ID for object tool
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyObjectTool
```
public void modifyObjectTool(ObjectToolDetails tool)
                      throws IOException,
                             NXCException
```
    Modify object tool.
    
    Parameters:
    tool - Object tool
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteObjectTool
```
public void deleteObjectTool(long toolId)
                      throws IOException,
                             NXCException
```
    Delete object tool.
    
    Parameters:
    toolId - Object tool ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - changeObjecToolDisableStatuss
```
public void changeObjecToolDisableStatuss(long toolId,
                                 boolean enable)
                                   throws IOException,
                                          NXCException
```
    Delete object tool.
    
    Parameters:
    toolId - Object tool ID
    enable - true if object tool should be enabled, false if disabled
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - executeTableTool
```
public Table executeTableTool(long toolId,
                     long nodeId)
                       throws IOException,
                              NXCException
```
    Execute object tool of "table" type against given node.
    
    Parameters:
    toolId - Tool ID
    nodeId - Node object ID
    
    Returns:
    Table with tool execution results
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - executeServerCommand
```
public void executeServerCommand(long objectId,
                        String command)
                          throws IOException,
                                 NXCException
```
    Execute server command related to given object (usually defined as object tool)
    
    Parameters:
    objectId - object ID
    command - command
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSnmpTrapsConfigurationSummary
```
public List<SnmpTrap> getSnmpTrapsConfigurationSummary()
                                                throws IOException,
                                                       NXCException
```
    Get summary of SNMP trap mapping. Trap configurations returned without parameter mapping.
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSnmpTrapsConfiguration
```
public List<SnmpTrap> getSnmpTrapsConfiguration()
                                         throws IOException,
                                                NXCException
```
    Get list of configured SNMP traps
    
    Returns:
    List of configured SNMP traps.
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createSnmpTrapConfiguration
```
public long createSnmpTrapConfiguration()
                                 throws IOException,
                                        NXCException
```
    Create new trap configuration record.
    
    Returns:
    ID of new record
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteSnmpTrapConfiguration
```
public void deleteSnmpTrapConfiguration(long trapId)
                                 throws IOException,
                                        NXCException
```
    Delete SNMP trap configuration record from server.
    
    Parameters:
    trapId - Trap configuration record ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifySnmpTrapConfiguration
```
public void modifySnmpTrapConfiguration(SnmpTrap trap)
                                 throws IOException,
                                        NXCException
```
    Modify SNMP trap configuration record.
    
    Parameters:
    trap - Modified trap configuration record
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getMibFileTimestamp
```
public Date getMibFileTimestamp()
                         throws IOException,
                                NXCException
```
    Get timestamp of server's MIB file.
    
    Returns:
    Timestamp of server's MIB file
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - downloadMibFile
```
public File downloadMibFile()
                     throws IOException,
                            NXCException
```
    Download MIB file from server.
    
    Returns:
    file handle for temporary file on local file system
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getPredefinedGraphs
```
public List<GraphSettings> getPredefinedGraphs()
                                        throws IOException,
                                               NXCException
```
    Get list of predefined graphs.
    
    Returns:
    list of predefined graphs
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - saveGraph
```
public long saveGraph(GraphSettings graph,
             boolean overwrite)
               throws IOException,
                      NXCException
```
    Checks if graph with specified name can be created/overwritten and creates/overwrites it in DB. If graph id is set to 0 it checks if graph with the same name exists, and if yes checks overwrite parameter. If it is set to false, then function returns error that graph with this name already exists. If there is no graph with the same name it just creates a new one. If id is set it checks that provided name is assigned only to this graph and overwrites it or throws error is the same name was already used. Also check if user have permissions to overwrite graph. If it can, then it returns 1. If graph with this name already exists, but can be overwritten by current user function returns 2. If graph with this name already exists, but can not be overwritten by current user function returns 0.
    
    Parameters:
    graph - predefined graph configuration
    overwrite - defines if existing graph should be overwritten
    
    Returns:
    ID of predefined graph object
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deletePredefinedGraph
```
public void deletePredefinedGraph(long graphId)
                           throws IOException,
                                  NXCException
```
    Delete predefined graph.
    
    Parameters:
    graphId - predefined graph object ID
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getScriptLibrary
```
public List<Script> getScriptLibrary()
                              throws IOException,
                                     NXCException
```
    Get list of all scripts in script library.
    
    Returns:
    ID/name pairs for scripts in script library
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getScript
```
public Script getScript(long scriptId)
                 throws IOException,
                        NXCException
```
    Get script from library
    
    Parameters:
    scriptId - script ID
    
    Returns:
    script source code
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyScript
```
public long modifyScript(long scriptId,
                String name,
                String source)
                  throws IOException,
                         NXCException
```
    Modify script. If scriptId is 0, new script will be created in library.
    
    Parameters:
    scriptId - script ID
    name - script name
    source - script source code
    
    Returns:
    script ID (newly assigned if new script was created)
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - renameScript
```
public void renameScript(long scriptId,
                String name)
                  throws IOException,
                         NXCException
```
    Rename script in script library.
    
    Parameters:
    scriptId - script ID
    name - new script name
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteScript
```
public void deleteScript(long scriptId)
                  throws IOException,
                         NXCException
```
    Delete script from library
    
    Parameters:
    scriptId - script ID
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - findConnectionPoint
```
public ConnectionPoint findConnectionPoint(long objectId)
                                    throws IOException,
                                           NXCException
```
    Find connection point (either directly connected or most close known interface on a switch) for given node or interface object. Will return null if connection point information cannot be found.
    
    Parameters:
    objectId - Node or interface object ID
    
    Returns:
    connection point information or null
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - findConnectionPoint
```
public ConnectionPoint findConnectionPoint(MacAddress macAddr)
                                    throws IOException,
                                           NXCException
```
    Find connection point (either directly connected or most close known interface on a switch) for given MAC address. Will return null if connection point information cannot be found.
    
    Parameters:
    macAddr - MAC address
    
    Returns:
    connection point information or null
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - findConnectionPoint
```
public ConnectionPoint findConnectionPoint(int zoneId,
                                  InetAddress ipAddr)
                                    throws IOException,
                                           NXCException
```
    Find connection point (either directly connected or most close known interface on a switch) for given IP address. Will return null if connection point information cannot be found.
    
    Parameters:
    zoneId - zone ID
    ipAddr - IP address to find
    
    Returns:
    connection point information or null
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - checkConnection
```
public boolean checkConnection()
```
    Send KEEPALIVE message. Return true is connection is fine and false otherwise. If connection is broken, session notification with code CONNECTION_BROKEN will be sent to all subscribers. Note that this function will not throw exception in case of error.
    
    Returns:
    true if connection is fine
  - getImageLibrary
```
public List<LibraryImage> getImageLibrary()
                                   throws IOException,
                                          NXCException
```
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - getImageLibrary
```
public List<LibraryImage> getImageLibrary(String category)
                                   throws IOException,
                                          NXCException
```
    Parameters:
    category -
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - getImage
```
public LibraryImage getImage(UUID guid)
                      throws IOException,
                             NXCException
```
    Parameters:
    guid -
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - createImage
```
public LibraryImage createImage(LibraryImage image,
                       ProgressListener listener)
                         throws IOException,
                                NXCException
```
    Parameters:
    image -
    listener -
    
    Returns:
    
    Throws:
    
    IOException
    
    NXCException
  - deleteImage
```
public void deleteImage(LibraryImage image)
                 throws IOException,
                        NXCException
```
    Parameters:
    image -
    
    Throws:
    
    IOException
    
    NXCException
  - modifyImage
```
public void modifyImage(LibraryImage image,
               ProgressListener listener)
                 throws IOException,
                        NXCException
```
    Parameters:
    image -
    listener -
    
    Throws:
    
    IOException
    
    NXCException
  - pollNode
```
public void pollNode(long nodeId,
            NodePollType pollType,
            TextOutputListener listener)
              throws IOException,
                     NXCException
```
    Perform a forced node poll. This method will not return until poll is complete, so it's advised to run it from separate thread. For each message received from poller listener's method onPollerMessage will be called.
    
    Parameters:
    nodeId - node object ID
    pollType - poll type
    listener - listener
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSituations
```
public List<Situation> getSituations()
                              throws IOException,
                                     NXCException
```
    Get list of all configured situations
    
    Returns:
    list of situation objects
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createSituation
```
public long createSituation(String name,
                   String comments)
                     throws IOException,
                            NXCException
```
    Create new situation object.
    
    Parameters:
    name - name for new situation object
    comments - comments for new situation object
    
    Returns:
    id assigned to created situation object
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifySituation
```
public void modifySituation(long id,
                   String name,
                   String comments)
                     throws IOException,
                            NXCException
```
    Modify situation object.
    
    Parameters:
    id - situation id
    name - new name or null to leave unchanged
    comments - new comments or null to leave unchanged
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteSituation
```
public void deleteSituation(long id)
                     throws IOException,
                            NXCException
```
    Delete situation object
    
    Parameters:
    id - situation id
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteSituationInstance
```
public void deleteSituationInstance(long id,
                           String instance)
                             throws IOException,
                                    NXCException
```
    Delete situation instance
    
    Parameters:
    id - situation id
    instance - situation instance
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - listServerFiles
```
public ServerFile[] listServerFiles()
                             throws IOException,
                                    NXCException
```
    List files in server's file store.
    
    Returns:
    list of files in server's file store
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - listServerFiles
```
public ServerFile[] listServerFiles(String[] filter)
                             throws IOException,
                                    NXCException
```
    List files in server's file store.
    
    Parameters:
    filter - array with required extension. Will be used as file filter. Give empty array or null if no filter should be applyed.
    
    Returns:
    list of files in server's file store
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - listAgentFiles
```
public ServerFile[] listAgentFiles(ServerFile file,
                          String fullPath,
                          long objectId)
                            throws IOException,
                                   NXCException
```
    List files on agent file store.
    
    Parameters:
    file - parent of new coomming list
    fullPath - path that will be used on an agent to get list of subfiles
    objectId - the ID of the node
    
    Returns:
    will return the list of sub files or the list of allowed folders if full path is set to "/"
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - uploadFileToAgent
```
public long uploadFileToAgent(long nodeId,
                     String serverFileName,
                     String remoteFileName,
                     boolean jobOnHold)
                       throws IOException,
                              NXCException
```
    Start file upload from server's file store to agent. Returns ID of upload job.
    
    Parameters:
    nodeId - node object ID
    serverFileName - file name in server's file store
    remoteFileName - fully qualified file name on target system or null to upload file to agent's file store
    jobOnHold - if true, upload job will be created in "hold" status
    
    Returns:
    ID of upload job
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - uploadFileToServer
```
public void uploadFileToServer(File localFile,
                      String serverFileName,
                      ProgressListener listener)
                        throws IOException,
                               NXCException
```
    Upload local file to server's file store
    
    Parameters:
    localFile - local file
    serverFileName - name under which file will be stored on server
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - uploadLocalFileToAgent
```
public void uploadLocalFileToAgent(File localFile,
                          String agentFileName,
                          long nodeId,
                          ProgressListener listener)
                            throws IOException,
                                   NXCException
```
    Upload local file to server's file store
    
    Parameters:
    localFile - local file
    serverFileName - name under which file will be stored on server
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createFolderOnAgent
```
public void createFolderOnAgent(String folder,
                       long nodeId)
                         throws IOException,
                                NXCException
```
    Upload local file to server's file store
    
    Parameters:
    localFile - local file
    serverFileName - name under which file will be stored on server
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - downloadFileFromAgent
```
public AgentFile downloadFileFromAgent(long nodeId,
                              String remoteFileName,
                              long maxFileSize,
                              boolean follow)
                                throws IOException,
                                       NXCException
```
    Download file from remote host via agent.
    
    Parameters:
    nodeId - node object ID
    remoteFileName - fully qualified file name on remote system
    maxFileSize - maximum download size, 0 == UNLIMITED
    follow - if set to true, server will send file updates as they appear (like for tail -f command)
    
    Returns:
    agent file handle which contains server assigned ID and handle for local file
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - downloadFileFromServer
```
public File downloadFileFromServer(String remoteFileName)
                            throws IOException,
                                   NXCException
```
    Download file from server file storage.
    
    Parameters:
    remoteFileName - fully qualified file name on remote system
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - cancelFileMonitoring
```
public void cancelFileMonitoring(long nodeId,
                        String remoteFileName)
                          throws IOException,
                                 NXCException
```
    Cancel file monitoring
    
    Parameters:
    nodeId - node object ID
    remoteFileName - fully qualified file name on remote system
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteServerFile
```
public void deleteServerFile(String serverFileName)
                      throws IOException,
                             NXCException
```
    Delete file from server's file store
    
    Parameters:
    serverFileName - name of server file
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteAgentFile
```
public void deleteAgentFile(long nodeId,
                   String fileName)
                     throws IOException,
                            NXCException
```
    Delete file from agent
    
    Parameters:
    serverFileName - name of server file
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - renameAgentFile
```
public void renameAgentFile(long nodeId,
                   String oldName,
                   String newFileName)
                     throws IOException,
                            NXCException
```
    Rename file from agent
    
    Parameters:
    serverFileName - name of server file
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - moveAgentFile
```
public void moveAgentFile(long nodeId,
                 String oldName,
                 String newFileName)
                   throws IOException,
                          NXCException
```
    Move file from agent
    
    Parameters:
    serverFileName - name of server file
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - openConsole
```
public void openConsole()
                 throws IOException,
                        NXCException
```
    Open server console.
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - closeConsole
```
public void closeConsole()
                  throws IOException,
                         NXCException
```
    Close server console.
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - processConsoleCommand
```
public boolean processConsoleCommand(String command)
                              throws IOException,
                                     NXCException
```
    Process console command on server. Output of the command delivered via console listener.
    
    Parameters:
    command - command to process
    
    Returns:
    true if console should be closed (usually after "exit" command)
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - isServerConsoleConnected
```
public boolean isServerConsoleConnected()
```
    Returns:
    the serverConsoleConnected
  - snmpWalk
```
public void snmpWalk(long nodeId,
            String rootOid,
            SnmpWalkListener listener)
              throws IOException,
                     NXCException
```
    Do SNMP walk. Operation will start at given root object, and callback will be called one or more times as data will come from server. This method will exit only when walk operation is complete.
    
    Parameters:
    nodeId - node object ID
    rootOid - root SNMP object ID (as text)
    listener - listener
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getVlans
```
public List<VlanInfo> getVlans(long nodeId)
                        throws IOException,
                               NXCException
```
    Get list of VLANs configured on given node
    
    Parameters:
    nodeId - node object ID
    
    Returns:
    list of VLANs
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - isObjectsSynchronized
```
public boolean isObjectsSynchronized()
```
    Returns:
    the objectsSynchronized
  - getAddressList
```
public List<IpAddressListElement> getAddressList(int listId)
                                          throws IOException,
                                                 NXCException
```
    Get address list.
    
    Parameters:
    list - list identifier (defined in NXCSession as ADDRESS_LIST_xxx)
    
    Returns:
    address list
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - setAddressList
```
public void setAddressList(int listId,
                  List<IpAddressListElement> list)
                    throws IOException,
                           NXCException
```
    Set content of address list.
    
    Parameters:
    listId - list ID
    list - new list content
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - resetServerComponent
```
public void resetServerComponent(int component)
                          throws IOException,
                                 NXCException
```
    Reset server's internal component (defined by SERVER_COMPONENT_xxx)
    
    Parameters:
    component - component id
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getNetworkPath
```
public NetworkPath getNetworkPath(long node1,
                         long node2)
                           throws IOException,
                                  NXCException
```
    Get IPv4 network path between two nodes. Server will return path based on cached routing table information. Network path object may be incomplete if server does not have enough information to build full path. In this case, no exception thrown, and completness of path can be checked by calling NetworkPath.isComplete().
    
    Parameters:
    node1 - source node
    node2 - destination node
    
    Returns:
    network path object
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getRoutingTable
```
public List<Route> getRoutingTable(long nodeId)
                            throws IOException,
                                   NXCException
```
    Get routing table from node
    
    Parameters:
    nodeId - node object ID
    
    Returns:
    list of routing table entries
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getSwitchForwardingDatabase
```
public List<FdbEntry> getSwitchForwardingDatabase(long nodeId)
                                           throws IOException,
                                                  NXCException
```
    Get switch forwarding database (MAC address table) from node
    
    Parameters:
    nodeId - node object ID
    
    Returns:
    list of switch forwarding database entries
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getWirelessStations
```
public List<WirelessStation> getWirelessStations(long nodeId)
                                          throws IOException,
                                                 NXCException
```
    Get list of wireless stations registered at given wireless controller.
    
    Parameters:
    nodeId - controller node ID
    
    Returns:
    list of wireless stations
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - removePackage
```
public void removePackage(long packageId)
                   throws IOException,
                          NXCException
```
    Remove agent package from server
    
    Parameters:
    packageId -
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - installPackage
```
public long installPackage(PackageInfo info,
                  File pkgFile,
                  ProgressListener listener)
                    throws IOException,
                           NXCException
```
    Install (upload) package on server
    
    Parameters:
    info - package information
    pkgFile - package file
    listener - progress listener (may be null)
    
    Returns:
    unique ID assigned to package
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getInstalledPackages
```
public List<PackageInfo> getInstalledPackages()
                                       throws IOException,
                                              NXCException
```
    Get list of installed packages
    
    Returns:
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deployPackage
```
public void deployPackage(long packageId,
                 Long[] nodeList,
                 PackageDeploymentListener listener)
                   throws IOException,
                          NXCException
```
    Deploy agent packages onto given nodes
    
    Parameters:
    packageId - package ID
    nodeList - list of nodes
    listener - deployment progress listener (may be null)
    
    Throws:
    
    IOException - if socket or file I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - lockPackageDatabase
```
public void lockPackageDatabase()
                         throws IOException,
                                NXCException
```
    Lock package database
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - unlockPackageDatabase
```
public void unlockPackageDatabase()
                           throws IOException,
                                  NXCException
```
    Unlock package database
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - sendSMS
```
public void sendSMS(String phoneNumber,
           String message)
             throws IOException,
                    NXCException
```
    Send SMS via server. User should have appropriate rights to execute this command.
    
    Parameters:
    phoneNumber - target phone number
    message - message text
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - pushDciData
```
public void pushDciData(DciPushData[] data)
                 throws IOException,
                        NXCException
```
    Push data to server.
    
    Parameters:
    data - push data
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - pushDciData
```
public void pushDciData(long nodeId,
               long dciId,
               String value)
                 throws IOException,
                        NXCException
```
    Push value for single DCI.
    
    Parameters:
    nodeId - node ID
    dciId - DCI ID
    value - value to push
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - pushDciData
```
public void pushDciData(String nodeName,
               String dciName,
               String value)
                 throws IOException,
                        NXCException
```
    Push value for single DCI.
    
    Parameters:
    nodeName - node name
    dciName - DCI name
    value - value to push
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getClientType
```
public int getClientType()
```
    Returns:
    the clientType
  - setClientType
```
public void setClientType(int clientType)
```
    Set client type. Can be one of the following: DESKTOP_CLIENT WEB_CLIENT MOBILE_CLIENT TABLET_CLIENT APPLICATION_CLIENT Must be called before connect(), otherwise will not have any effect. Ignored by servers prior to 1.2.2.
    
    Parameters:
    clientType - the clientType to set
  - getDateFormat
```
public String getDateFormat()
```
    Get default date format provided by server
    
    Returns:
  - getTimeFormat
```
public String getTimeFormat()
```
    Get default time format provided by server
    
    Returns:
  - getShortTimeFormat
```
public String getShortTimeFormat()
```
    Get time format for short form (usually without seconds).
    
    Returns:
  - handover
```
public void handover(NXCSession target)
```
    Handover object cache to new session. After call to this method, object cache of this session invalidated and should not be used.
    
    Parameters:
    target - target session object
  - getSessionId
```
public int getSessionId()
```
    Get this session's ID on server.
    
    Returns:
    the sessionId
  - listMappingTables
```
public List<MappingTableDescriptor> listMappingTables()
                                               throws IOException,
                                                      NXCException
```
    Get list of all configured mapping tables.
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getMappingTable
```
public MappingTable getMappingTable(int id)
                             throws IOException,
                                    NXCException
```
    Parameters:
    id -
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - createMappingTable
```
public int createMappingTable(String name,
                     String description,
                     int flags)
                       throws IOException,
                              NXCException
```
    Create new mapping table.
    
    Parameters:
    name - name of new table
    description - description for new table
    flags - flags for new table
    
    Returns:
    ID of new table object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - updateMappingTable
```
public int updateMappingTable(MappingTable table)
                       throws IOException,
                              NXCException
```
    Create or update mapping table. If table ID is 0, new table will be created on server.
    
    Parameters:
    table - mapping table
    
    Returns:
    ID of new table object
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteMappingTable
```
public void deleteMappingTable(int id)
                        throws IOException,
                               NXCException
```
    Delete mapping table
    
    Parameters:
    id - mapping table ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getDefaultDciRetentionTime
```
public final int getDefaultDciRetentionTime()
```
    Returns:
    the default DCI retention time in days
  - getDefaultDciPollingInterval
```
public final int getDefaultDciPollingInterval()
```
    Returns:
    the default DCI polling interval in seconds
  - getMinViewRefreshInterval
```
public int getMinViewRefreshInterval()
```
    Returns:
    the minViewRefreshInterval
  - isStrictAlarmStatusFlow
```
public final boolean isStrictAlarmStatusFlow()
```
    Returns:
    true if alarm status flow set to "strict" mode
  - isTimedAlarmAckEnabled
```
public boolean isTimedAlarmAckEnabled()
```
    Returns:
    true if timed alarm acknowledgement is enabled
  - listDciSummaryTables
```
public List<DciSummaryTableDescriptor> listDciSummaryTables()
                                                     throws IOException,
                                                            NXCException
```
    Get list of all configured DCI summary tables
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getDciSummaryTable
```
public DciSummaryTable getDciSummaryTable(int id)
                                   throws IOException,
                                          NXCException
```
    Get DCI summary table configuration.
    
    Parameters:
    id - DCI summary table ID.
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - modifyDciSummaryTable
```
public int modifyDciSummaryTable(DciSummaryTable table)
                          throws IOException,
                                 NXCException
```
    Modify DCI summary table configuration. Will create new table object if id is 0.
    
    Parameters:
    table - DCI summary table configuration
    
    Returns:
    assigned summary table ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteDciSummaryTable
```
public void deleteDciSummaryTable(int id)
                           throws IOException,
                                  NXCException
```
    Delete DCI summary table.
    
    Parameters:
    id -
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - queryDciSummaryTable
```
public Table queryDciSummaryTable(int tableId,
                         long baseObjectId)
                           throws IOException,
                                  NXCException
```
    Query DCI summary table.
    
    Parameters:
    tableId - DCI summary table ID
    baseObjectId - base container object ID
    
    Returns:
    table with last values data for all nodes under given base container
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - queryAdHocDciSummaryTable
```
public Table queryAdHocDciSummaryTable(long baseObjectId,
                              List<DciSummaryTableColumn> columns,
                              AggregationFunction function,
                              Date periodStart,
                              Date periodEnd,
                              boolean multiInstance)
                                throws IOException,
                                       NXCException
```
    Query ad-hoc DCI summary table.
    
    Parameters:
    baseObjectId - base container object ID
    columns - columns for resulting table
    function - data aggregation function
    periodStart - start of query period
    periodEnd - end of query period
    
    Returns:
    table with last values data for all nodes under given base container
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - listReports
```
public List<UUID> listReports()
                       throws NXCException,
                              IOException
```
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - getReportDefinition
```
public ReportDefinition getReportDefinition(UUID reportId)
                                     throws NXCException,
                                            IOException
```
    Parameters:
    reportId -
    
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - executeReport
```
public UUID executeReport(UUID reportId,
                 Map<String,String> parameters)
                   throws NXCException,
                          IOException
```
    Parameters:
    reportId -
    parameters -
    
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - listReportResults
```
public List<ReportResult> listReportResults(UUID reportId)
                                     throws NXCException,
                                            IOException
```
    Parameters:
    reportId -
    
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - deleteReportResult
```
public void deleteReportResult(UUID reportId,
                      UUID jobId)
                        throws NXCException,
                               IOException
```
    Parameters:
    reportId -
    jobId -
    
    Throws:
    
    NXCException
    
    IOException
  - renderReport
```
public File renderReport(UUID reportId,
                UUID jobId,
                ReportRenderFormat format)
                  throws NXCException,
                         IOException
```
    Parameters:
    reportId -
    jobId -
    format -
    
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - scheduleReport
```
public void scheduleReport(ReportingJob job,
                  Map<String,String> parameters)
                    throws NXCException,
                           IOException
```
    Parameters:
    job -
    parameters -
    
    Throws:
    
    NXCException
    
    IOException
  - listScheduledJobs
```
public List<ReportingJob> listScheduledJobs(UUID reportId)
                                     throws NXCException,
                                            IOException
```
    Parameters:
    reportId -
    
    Returns:
    
    Throws:
    
    NXCException
    
    IOException
  - deleteReportSchedule
```
public void deleteReportSchedule(UUID reportId,
                        UUID jobId)
                          throws NXCException,
                                 IOException
```
    Parameters:
    reportId -
    jobId -
    
    Throws:
    
    NXCException
    
    IOException
  - setClientAddress
```
public void setClientAddress(String clientAddress)
```
    Parameters:
    clientAddress - the clientAddress to set
  - getClientLanguage
```
public String getClientLanguage()
```
    Returns:
    the clientLanguage
  - setClientLanguage
```
public void setClientLanguage(String clientLanguage)
```
    Parameters:
    clientLanguage - the clientLanguage to set
  - getSubnetAddressMap
```
public long[] getSubnetAddressMap(long subnetId)
                           throws NXCException,
                                  IOException
```
    Get address map for subnet. Returned array contains one entry for each IP address in a subnet. Element value could be eithet ID of the node with that IP address, 0 for unused addresses, and 0xFFFFFFFF for subnet and broadcast addresses.
    
    Parameters:
    subnetId -
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getConfigList
```
public List<ConfigListElement> getConfigList()
                                      throws NXCException,
                                             IOException
```
    Gets the list of configuration files.(Config id, name and sequence number)
    
    Returns:
    the list of configuration files in correct sequence
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getConfigContent
```
public ConfigContent getConfigContent(long id)
                               throws NXCException,
                                      IOException
```
    Saves existing config
    
    Parameters:
    id - config id
    
    Returns:
    content of requested by id configurations file
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - saveAgentConfig
```
public void saveAgentConfig(ConfigContent conf)
                     throws NXCException,
                            IOException
```
    Saves or creates new agent's config
    
    Parameters:
    conf - contents of config
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - deleteAgentConfig
```
public void deleteAgentConfig(long id)
                       throws NXCException,
                              IOException
```
    Delete config with given id. Does not change sequence number of following elements.
    
    Parameters:
    id - agent configuration ID
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - swapAgentConfigs
```
public void swapAgentConfigs(long id1,
                    long id2)
                      throws NXCException,
                             IOException
```
    Swaps 2 configs sequence numbers
    
    Parameters:
    id1 -
    id2 -
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - getLocationHistory
```
public List<org.netxms.base.GeoLocation> getLocationHistory(long objectId,
                                                   Date from,
                                                   Date to)
                                                     throws NXCException,
                                                            IOException
```
    Get location history for given object.
    
    Parameters:
    objectId -
    from -
    to -
    
    Returns:
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out
  - takeScreenshot
```
public byte[] takeScreenshot(long nodeId,
                    String sessionName)
                      throws NXCException,
                             IOException
```
    Take screenshot from given node. Session to take screenshot from can be identified either by ID or name. If ID is used name must be set to null.
    
    Parameters:
    nodeId - node object ID
    sessionId - session ID for session to take screenshot from
    sessionName - session name for session to take screenshot from
    
    Returns:
    Screenshot as PNG image
    
    Throws:
    
    IOException - if socket I/O error occurs
    
    NXCException - if NetXMS server returns an error or operation was timed out

Class NXCSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONN_PORT

CHANNEL_EVENTS

CHANNEL_SYSLOG

CHANNEL_ALARMS

CHANNEL_OBJECTS

CHANNEL_SNMP_TRAPS

CHANNEL_AUDIT_LOG

CHANNEL_SITUATIONS

OBJECT_SYNC_NOTIFY

OBJECT_SYNC_WAIT

CFG_IMPORT_REPLACE_EVENT_BY_CODE

CFG_IMPORT_REPLACE_EVENT_BY_NAME

ADDRESS_LIST_DISCOVERY_TARGETS

ADDRESS_LIST_DISCOVERY_FILTER

SERVER_COMPONENT_DISCOVERY_MANAGER

DESKTOP_CLIENT

WEB_CLIENT

MOBILE_CLIENT

TABLET_CLIENT

APPLICATION_CLIENT

Constructor Detail

NXCSession

NXCSession

NXCSession

Method Detail

finalize

createCustomObjectFromMessage

addListener

removeListener

addConsoleListener

removeConsoleListener

addMessageSubscription

removeMessageSubscription

sendNotification

sendMessage

sendFile

sendFile

waitForMessage

waitForMessage

waitForRCC

waitForRCC

newMessage

waitForFile

waitForFileTail

executeSimpleCommand

receiveTable

connect

connect

login

login

login

disconnect

isConnected

isEncrypted

isIgnoreProtocolVersion

setIgnoreProtocolVersion

validateProtocolVersions

getDefaultRecvBufferSize

getMaxRecvBufferSize

setRecvBufferSize

getServerAddress

getServerVersion

getServerId

getServerTimeZone

getServerTime

getServerChallenge

getTileServerURL

isZoningEnabled

isHelpdeskLinkActive

getClientInfo

setClientInfo

setCommandTimeout

getUserId