Package org.netxms.client.objects

Class TrafficObserver

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

org.netxms.client.objects.TrafficObserver

All Implemented Interfaces:

PollingTarget, ZoneMember

public class TrafficObserver
extends DataCollectionTarget
implements PollingTarget, ZoneMember

Traffic observer object - represents one external traffic analysis instance

Field Summary

Fields

Modifier and Type	Field	Description
static final long	CAP_HISTORICAL_TIMESERIES
static final long	CAP_HOST_L7
static final long	CAP_HOST_PEERS
static final long	CAP_HOST_SET_AUTHORITATIVE
static final long	CAP_POINT_DSCP
static final long	CAP_POINT_L7
static final long	CAP_POINT_TOP_TALKERS
static final long	CAP_SYNC_HOST_ALIASES
static final int	STATE_AUTH_FAILURE
static final int	STATE_CONNECTED
static final int	STATE_UNKNOWN
static final int	STATE_UNREACHABLE

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

DCF_DISABLE_CONF_POLL, DCF_DISABLE_DATA_COLLECT, DCF_DISABLE_STATUS_POLL, DCF_LOCATION_CHANGE_EVENT, DCSF_NETWORK_PATH_PROBLEM, DCSF_UNREACHABLE, geoAreas, geoLocationControlMode, numDataCollectionItems, overviewDciData, tooltipDciData, webServiceProxyId

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

accessList, aiHint, 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, isHidden, maintenanceInitiatorId, maintenanceScheduled, 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_CLOUDDOMAIN, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_COOLINGZONE, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_DASHBOARDTEMPLATE, OBJECT_FACILITY, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_OBSERVATIONPOINT, OBJECT_POWERDOMAIN, OBJECT_RACK, OBJECT_RESOURCE, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_TRAFFICOBSERVER, OBJECT_VPNCONNECTOR, OBJECT_WIRELESSDOMAIN, OBJECT_ZONE, objectClass, objectId, objectName, parents, partialObject, pollStates, portStopList, 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
TrafficObserver(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
boolean	canHaveAgent()	Identify if this object can have NetXMS agent.
boolean	canHaveInterfaces()	Identify if this object can have network interfaces.
boolean	canHavePollerNode()	Identify if this object can have poller node property.
boolean	canUseEtherNetIP()	Identify if this object can use EtherNet/IP for communications.
boolean	canUseModbus()	Identify if this object can use Modbus for communications.
AgentCacheMode	getAgentCacheMode()	Get agent cache mode.
String	getBackendEdition()
String	getBackendProduct()
String	getBackendVersion()
long	getCapabilities()
int	getConnectionState()
String	getConnectorName()
String	getCredentials()	Get connector credentials as sent by the server: a JSON object with password-typed fields (as declared by the connector) removed.
int	getFlags()	Get object flags.
int	getGracePeriod()
int	getIfXTablePolicy()	Get ifXTable usage policy.
String	getLastDiscoveryMessage()
int	getLastDiscoveryStatus()
Date	getLastDiscoveryTime()
long	getLinkedNodeId()
String	getObjectClassName()	Get name of NetXMS object's class.
long	getPollerNodeId()	Get poller node ID.
PollState[]	getPollStates()	Get poll states.
int	getRemovalPolicy()
Set<String>	getStrings()	Get all strings in object
String	getSyncConfig()
int	getZoneId()	Get ID of the zone this object belongs to
String	getZoneName()	Get name of the zone this object belongs to
boolean	hasCapability(long capability)	Check if backend has given capability.
boolean	hasCredentials()
boolean	isAlarmsVisible()	If this method returns true object can have visible alarms.
boolean	isAllowedOnMap()	If this method returns true object is allowed to be on custom network map.
boolean	isConnectorLoaded()	Check if connector module referenced by this observer is loaded on the server.

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

getGeoAreas, getGeoLocationControlMode, getNumDataCollectionItems, getOverviewDciData, getTooltipDciData, getWebServiceProxyId, isEventSource, isLocationChageEventGenerated

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

addString, areChildrenSynchronized, getAccessList, getAiHint, 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, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPortStopList, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getTrustedObjects, getUrls, hasAccessibleChildren, hasAccessibleParents, hasAccessibleViewParents, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasNetworkMap, hasParents, hasUrls, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isHidden, isInheritAccessRights, isInMaintenanceMode, isMaintenanceScheduled, isParentOf, isParentOf, isPartialObject, setSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netxms.client.objects.interfaces.PollingTarget

getObjectId, getObjectName

Field Details

STATE_UNKNOWN

public static final int STATE_UNKNOWN

See Also:

• Constant Field Values

STATE_CONNECTED

public static final int STATE_CONNECTED

See Also:

• Constant Field Values

STATE_UNREACHABLE

public static final int STATE_UNREACHABLE

See Also:

• Constant Field Values

STATE_AUTH_FAILURE

public static final int STATE_AUTH_FAILURE

See Also:

• Constant Field Values

CAP_HOST_L7

public static final long CAP_HOST_L7

See Also:

• Constant Field Values

CAP_HOST_PEERS

public static final long CAP_HOST_PEERS

See Also:

• Constant Field Values

CAP_POINT_L7

public static final long CAP_POINT_L7

See Also:

• Constant Field Values

CAP_POINT_TOP_TALKERS

public static final long CAP_POINT_TOP_TALKERS

See Also:

• Constant Field Values

CAP_POINT_DSCP

public static final long CAP_POINT_DSCP

See Also:

• Constant Field Values

CAP_HISTORICAL_TIMESERIES

public static final long CAP_HISTORICAL_TIMESERIES

See Also:

• Constant Field Values

CAP_SYNC_HOST_ALIASES

public static final long CAP_SYNC_HOST_ALIASES

See Also:

• Constant Field Values

CAP_HOST_SET_AUTHORITATIVE

public static final long CAP_HOST_SET_AUTHORITATIVE

See Also:

• Constant Field Values

Constructor Details

TrafficObserver

public TrafficObserver(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

isAllowedOnMap

public boolean isAllowedOnMap()

Description copied from class: AbstractObject

If this method returns true object is allowed to be on custom network map. Default implementation always returns false.

Overrides:

isAllowedOnMap in class AbstractObject

Returns:

true if object is allowed to be on custom network map

See Also:

• AbstractObject.isAllowedOnMap()

isAlarmsVisible

public boolean isAlarmsVisible()

Description copied from class: AbstractObject

If this method returns true object can have visible alarms. Default implementation always returns false.

Overrides:

isAlarmsVisible in class AbstractObject

Returns:

true if object can contain visible alarms

See Also:

• AbstractObject.isAlarmsVisible()

getObjectClassName

public String getObjectClassName()

Description copied from class: AbstractObject

Get name of NetXMS object's class.

Overrides:

getObjectClassName in class AbstractObject

Returns:

Name of NetXMS object's class

See Also:

• AbstractObject.getObjectClassName()

getStrings

public Set<String> getStrings()

Description copied from class: AbstractObject

Get all strings in object

Overrides:

getStrings in class AbstractObject

Returns:

set of all strings in object

See Also:

• AbstractObject.getStrings()

getConnectorName

public String getConnectorName()

Returns:

the connectorName

isConnectorLoaded

public boolean isConnectorLoaded()

Check if connector module referenced by this observer is loaded on the server. When it is not, credentials are not sent to clients and the server ignores credentials in object modification requests.

Returns:

true if connector module is loaded on the server

getCredentials

public String getCredentials()

Get connector credentials as sent by the server: a JSON object with password-typed fields (as declared by the connector) removed. Secrets never leave the server. Not available (null) when the connector module is not loaded on the server.

Returns:

sanitized credentials JSON or null if credentials are not set or not available

hasCredentials

public boolean hasCredentials()

Returns:

true if connector credentials are set

getZoneId

public int getZoneId()

Description copied from interface: ZoneMember

Get ID of the zone this object belongs to

Specified by:

getZoneId in interface ZoneMember

Returns:

zone ID

See Also:

• ZoneMember.getZoneId()

getZoneName

public String getZoneName()

Description copied from interface: ZoneMember

Get name of the zone this object belongs to

Specified by:

getZoneName in interface ZoneMember

Returns:

zone name

See Also:

• ZoneMember.getZoneName()

getLinkedNodeId

public long getLinkedNodeId()

Returns:

ID of the node representing the analyzer itself (0 = not linked)

getRemovalPolicy

public int getRemovalPolicy()

Returns:

the removalPolicy

getGracePeriod

public int getGracePeriod()

Returns:

the gracePeriod

getSyncConfig

public String getSyncConfig()

Returns:

the syncConfig

getLastDiscoveryStatus

public int getLastDiscoveryStatus()

Returns:

the lastDiscoveryStatus

getLastDiscoveryTime

public Date getLastDiscoveryTime()

Returns:

the lastDiscoveryTime

getLastDiscoveryMessage

public String getLastDiscoveryMessage()

Returns:

the lastDiscoveryMessage

getConnectionState

public int getConnectionState()

Returns:

the connectionState

getBackendProduct

public String getBackendProduct()

Returns:

the backendProduct

getBackendVersion

public String getBackendVersion()

Returns:

the backendVersion

getBackendEdition

public String getBackendEdition()

Returns:

the backendEdition

getCapabilities

public long getCapabilities()

Returns:

the capabilities

hasCapability

public boolean hasCapability(long capability)

Check if backend has given capability.

Parameters:

capability - capability bit to check

Returns:

true if backend has given capability

getFlags

public int getFlags()

Description copied from interface: PollingTarget

Get object flags.

Specified by:

getFlags in interface PollingTarget

Returns:

object flags

See Also:

• PollingTarget.getFlags()

getIfXTablePolicy

public int getIfXTablePolicy()

Description copied from interface: PollingTarget

Get ifXTable usage policy.

Specified by:

getIfXTablePolicy in interface PollingTarget

Returns:

ifXTable usage policy

See Also:

• PollingTarget.getIfXTablePolicy()

getAgentCacheMode

public AgentCacheMode getAgentCacheMode()

Description copied from interface: PollingTarget

Get agent cache mode.

Specified by:

getAgentCacheMode in interface PollingTarget

Returns:

agent cache mode

See Also:

• PollingTarget.getAgentCacheMode()

getPollerNodeId

public long getPollerNodeId()

Description copied from interface: PollingTarget

Get poller node ID.

Specified by:

getPollerNodeId in interface PollingTarget

Returns:

poller node ID or 0 if object cannot have poler node

See Also:

• PollingTarget.getPollerNodeId()

canHaveAgent

public boolean canHaveAgent()

Description copied from interface: PollingTarget

Identify if this object can have NetXMS agent.

Specified by:

canHaveAgent in interface PollingTarget

Returns:

true if this object can have NetXMS agent

See Also:

• PollingTarget.canHaveAgent()

canHaveInterfaces

public boolean canHaveInterfaces()

Description copied from interface: PollingTarget

Identify if this object can have network interfaces.

Specified by:

canHaveInterfaces in interface PollingTarget

Returns:

true if this object can have network interfaces

See Also:

• PollingTarget.canHaveInterfaces()

canHavePollerNode

public boolean canHavePollerNode()

Description copied from interface: PollingTarget

Identify if this object can have poller node property.

Specified by:

canHavePollerNode in interface PollingTarget

Returns:

true if this object can have poller node property

See Also:

• PollingTarget.canHavePollerNode()

canUseEtherNetIP

public boolean canUseEtherNetIP()

Description copied from interface: PollingTarget

Identify if this object can use EtherNet/IP for communications.

Specified by:

canUseEtherNetIP in interface PollingTarget

Returns:

true if this object can use EtherNet/IP for communications

See Also:

• PollingTarget.canUseEtherNetIP()

canUseModbus

public boolean canUseModbus()

Description copied from interface: PollingTarget

Identify if this object can use Modbus for communications.

Specified by:

canUseModbus in interface PollingTarget

Returns:

true if this object can use Modbus for communications

See Also:

• PollingTarget.canUseModbus()

getPollStates

public PollState[] getPollStates()

Description copied from interface: PollingTarget

Get poll states.

Specified by:

getPollStates in interface PollingTarget

Returns:

array of poll states or null if object doesn't have any

See Also:

• PollingTarget.getPollStates()