Package org.netxms.client.objects

Class DataCollectionTarget

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

Direct Known Subclasses:

AbstractNode, AccessPoint, Chassis, Circuit, Cluster, Collector, MobileDevice, Sensor

public class DataCollectionTarget
extends GenericObject

Base class for all data collection targets

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DCF_DISABLE_CONF_POLL
static final int	DCF_DISABLE_DATA_COLLECT
static final int	DCF_DISABLE_STATUS_POLL
static final int	DCF_LOCATION_CHANGE_EVENT
static final int	DCSF_NETWORK_PATH_PROBLEM
static final int	DCSF_UNREACHABLE
protected long[]	geoAreas
protected GeoLocationControlMode	geoLocationControlMode
protected int	numDataCollectionItems
protected List<DciValue>	overviewDciData
protected List<DciValue>	tooltipDciData
protected long	webServiceProxyId

Fields inherited from class org.netxms.client.objects.AbstractObject

accessList, alias, assetId, ASSETS, backupZoneProxyId, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, categoryId, children, comments, commentsSource, CONTEXT, creationTime, customAttributes, DASHBOARDROOT, dashboards, drillDownObjectId, fixedPropagatedStatus, flags, geolocation, guid, inheritAccessRights, inMaintenanceMode, isDeleted, maintenanceInitiatorId, mapImage, MARKDOWN_COMMENTS_INDICATOR, moduleData, nameOnMap, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_ASSET, OBJECT_ASSETGROUP, OBJECT_ASSETROOT, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEPROTOTYPE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CIRCUIT, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_DASHBOARDTEMPLATE, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_RACK, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_WIRELESSDOMAIN, OBJECT_ZONE, objectClass, objectId, objectName, parents, partialObject, pollStates, postalAddress, primaryZoneProxyId, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, responsibleUsers, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, TEMPLATEROOT, trustedObjects, UNKNOWN, urls, ZONE0

Constructor Summary

Constructors

Constructor	Description
DataCollectionTarget(long id, NXCSession session)	Create new object.
DataCollectionTarget(NXCPMessage msg, NXCSession session)	Create object from NXCP message.

Method Summary

Modifier and Type	Method	Description
long[]	getGeoAreas()	Get geo areas configured for that object
GeoLocationControlMode	getGeoLocationControlMode()	Get geolocation control mode
int	getNumDataCollectionItems()	Get number of data collection items configured on this object.
List<DciValue>	getOverviewDciData()
List<DciValue>	getTooltipDciData()
long	getWebServiceProxyId()	Get ID of web service proxy node.
boolean	isLocationChageEventGenerated()	Check if generation of location change event is turned on

Methods inherited from class org.netxms.client.objects.AbstractObject

addString, areChildrenSynchronized, getAccessList, getAlias, getAllChildren, getAllChildren, getAllParents, getAllParents, getAssetId, getBackupZoneProxyId, getCategory, getCategoryId, getChildCount, getChildIdList, getChildren, getChildrenAsArray, getComments, getCommentsSource, getConfiguredNameOnMap, getCreationTime, getCustomAttribute, getCustomAttributes, getCustomAttributeValue, getCustomAttributeValueAsBoolean, getDashboardIdentifiers, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getNetworkMaps, getObjectClass, getObjectClassName, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getStrings, getTrustedObjects, getUrls, hasAccessibleChildren, hasAccessibleParents, hasAccessibleViewParents, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasNetworkMap, hasParents, hasUrls, isAlarmsVisible, isAllowedOnMap, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isInheritAccessRights, isInMaintenanceMode, isParentOf, isParentOf, isPartialObject, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DCF_DISABLE_STATUS_POLL

public static final int DCF_DISABLE_STATUS_POLL

See Also:

• Constant Field Values

DCF_DISABLE_CONF_POLL

public static final int DCF_DISABLE_CONF_POLL

See Also:

• Constant Field Values

DCF_DISABLE_DATA_COLLECT

public static final int DCF_DISABLE_DATA_COLLECT

See Also:

• Constant Field Values

DCF_LOCATION_CHANGE_EVENT

public static final int DCF_LOCATION_CHANGE_EVENT

See Also:

• Constant Field Values

DCSF_UNREACHABLE

public static final int DCSF_UNREACHABLE

See Also:

• Constant Field Values

DCSF_NETWORK_PATH_PROBLEM

public static final int DCSF_NETWORK_PATH_PROBLEM

See Also:

• Constant Field Values

overviewDciData

protected List<DciValue> overviewDciData

tooltipDciData

protected List<DciValue> tooltipDciData

numDataCollectionItems

protected int numDataCollectionItems

geoLocationControlMode

protected GeoLocationControlMode geoLocationControlMode

geoAreas

protected long[] geoAreas

webServiceProxyId

protected long webServiceProxyId

Constructor Details

DataCollectionTarget

public DataCollectionTarget(long id,
 NXCSession session)

Create new object.

Parameters:

id - object ID

session - client session where this object was received

DataCollectionTarget

public DataCollectionTarget(NXCPMessage msg,
 NXCSession session)

Create object from NXCP message.

Parameters:

msg - NXCP message

session - client session where this object was received

Method Details

getOverviewDciData

public List<DciValue> getOverviewDciData()

Returns:

the overviewDciData

getTooltipDciData

public List<DciValue> getTooltipDciData()

Returns:

the tooltipDciData

getNumDataCollectionItems

public int getNumDataCollectionItems()

Get number of data collection items configured on this object.

Returns:

number of data collection items configured on this object

getGeoLocationControlMode

public GeoLocationControlMode getGeoLocationControlMode()

Get geolocation control mode

Returns:

geolocation control mode

getGeoAreas

public long[] getGeoAreas()

Get geo areas configured for that object

Returns:

list of geo area IDs

isLocationChageEventGenerated

public boolean isLocationChageEventGenerated()

Check if generation of location change event is turned on

Returns:

true if location change event should be generated for this object

getWebServiceProxyId

public long getWebServiceProxyId()

Get ID of web service proxy node.

Returns:

ID of web service proxy node