Package org.netxms.client.objects
Class NetworkMap
java.lang.Object
org.netxms.client.objects.AbstractObject
org.netxms.client.objects.GenericObject
org.netxms.client.objects.NetworkMap
- All Implemented Interfaces:
PollingTarget
Network map object
-
Field Summary
Modifier and TypeFieldDescriptionstatic final UUID
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
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, moduleData, nameOnMap, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_ASSET, OBJECT_ASSETGROUP, OBJECT_ASSETROOT, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEPROTOTYPE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, 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, urls, ZONE0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Identify if this object can have NetXMS agent.boolean
Identify if this object can have network interfaces.boolean
Identify if this object can have poller node property.boolean
Identify if this object can use EtherNet/IP for communications.boolean
Identify if this object can use Modbus for communications.Create map page from map object's dataGet agent cache mode.int
int
int
int
int
int
final int
int
getFlags()
Get object flags.int
int
Get ifXTable usage policy.int
Get name of NetXMS object's class.long
Get poller node ID.Get poll states.Get all strings in objectint
getWidth()
boolean
If this method returns true object is allowed to be on custom network map.boolean
Returns the MF_CALCULATE_STATUS flag statusboolean
Returns the MF_CENTER_BKGND_IMAGE flag statusboolean
Returns the MF_DONT_UPDATE_LINK_TEXT flag statusboolean
boolean
Returns the MF_SHOW_END_NODES flag statusboolean
Returns the MF_SHOW_LINK_DIRECTION flag statusboolean
Returns the MF_SHOW_STATUS_BKGND flag statusboolean
Returns the MF_SHOW_STATUS_FRAME flag statusboolean
Returns the MF_SHOW_STATUS_ICON flag statusboolean
Returns the MF_TRANSLUCENT_LABEL_BKGND flag statusvoid
Prepare object creation and modification data to create map copyvoid
Update modification data with template fields form this mapMethods 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, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getObjectClass, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getTrustedObjects, getUrls, hasAccessibleChildren, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasParents, hasUrls, isAlarmsVisible, 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
Methods inherited from interface org.netxms.client.objects.interfaces.PollingTarget
getObjectId, getObjectName
-
Field Details
-
GEOMAP_BACKGROUND
-
TYPE_CUSTOM
public static final int TYPE_CUSTOM- See Also:
-
TYPE_LAYER2_TOPOLOGY
public static final int TYPE_LAYER2_TOPOLOGY- See Also:
-
TYPE_IP_TOPOLOGY
public static final int TYPE_IP_TOPOLOGY- See Also:
-
TYPE_INTERNAL_TOPOLOGY
public static final int TYPE_INTERNAL_TOPOLOGY- See Also:
-
TYPE_OSPF_TOPOLOGY
public static final int TYPE_OSPF_TOPOLOGY- See Also:
-
MF_SHOW_STATUS_ICON
public static final int MF_SHOW_STATUS_ICON- See Also:
-
MF_SHOW_STATUS_FRAME
public static final int MF_SHOW_STATUS_FRAME- See Also:
-
MF_SHOW_STATUS_BKGND
public static final int MF_SHOW_STATUS_BKGND- See Also:
-
MF_SHOW_END_NODES
public static final int MF_SHOW_END_NODES- See Also:
-
MF_CALCULATE_STATUS
public static final int MF_CALCULATE_STATUS- See Also:
-
MF_FILTER_OBJECTS
public static final int MF_FILTER_OBJECTS- See Also:
-
MF_SHOW_LINK_DIRECTION
public static final int MF_SHOW_LINK_DIRECTION- See Also:
-
MF_USE_L1_TOPOLOGY
public static final int MF_USE_L1_TOPOLOGY- See Also:
-
MF_CENTER_BKGND_IMAGE
public static final int MF_CENTER_BKGND_IMAGE- See Also:
-
MF_TRANSLUCENT_LABEL_BKGND
public static final int MF_TRANSLUCENT_LABEL_BKGND- See Also:
-
MF_DONT_UPDATE_LINK_TEXT
public static final int MF_DONT_UPDATE_LINK_TEXT- See Also:
-
MF_FIT_BKGND_IMAGE
public static final int MF_FIT_BKGND_IMAGE- See Also:
-
MF_BKGND_IMAGE_FLAGS
public static final int MF_BKGND_IMAGE_FLAGS- See Also:
-
-
Constructor Details
-
NetworkMap
Create from NXCP message.- Parameters:
msg
- NXCP messagesession
- owning client session
-
-
Method Details
-
prepareCopy
Prepare object creation and modification data to create map copy- Parameters:
cd
- object creation datamd
- object modification data
-
getObjectClassName
Description copied from class:AbstractObject
Get name of NetXMS object's class.- Overrides:
getObjectClassName
in classAbstractObject
- Returns:
- Name of NetXMS object's class
- See Also:
-
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 classAbstractObject
- Returns:
- true if object is allowed to be on custom network map
- See Also:
-
getMapType
public int getMapType()- Returns:
- the mapType
-
getLayout
- Returns:
- the layout
-
getBackground
- Returns:
- the background
-
getSeedObjects
- Returns:
- the seedObjectIds
-
createMapPage
Create map page from map object's data- Returns:
- new map page
-
getBackgroundLocation
- Returns:
- the backgroundLocation
-
getBackgroundZoom
public int getBackgroundZoom()- Returns:
- the backgroundZoom
-
getFlags
public int getFlags()Description copied from interface:PollingTarget
Get object flags.- Specified by:
getFlags
in interfacePollingTarget
- Returns:
- object flags
- See Also:
-
getDefaultLinkColor
public int getDefaultLinkColor()- Returns:
- the defaultLinkColor
-
getDefaultLinkRouting
public int getDefaultLinkRouting()- Returns:
- the defaultLinkRouting
-
getDefaultLinkWidth
public int getDefaultLinkWidth()- Returns:
- the defaultLinkWidth
-
getDefaultLinkStyle
public int getDefaultLinkStyle()- Returns:
- the defaultLinkStyle
-
getBackgroundColor
public int getBackgroundColor()- Returns:
- the backgroundColor
-
getDiscoveryRadius
public final int getDiscoveryRadius()- Returns:
- the discoveryRadius
-
getFilter
- Returns:
- the filter
-
getLinkStylingScript
- Returns:
- the updateLinkScript
-
getObjectDisplayMode
- Returns:
- the objectDisplayMode
-
getStrings
Description copied from class:AbstractObject
Get all strings in object- Overrides:
getStrings
in classAbstractObject
- Returns:
- set of all strings in object
- See Also:
-
isShowStatusIcon
public boolean isShowStatusIcon()Returns the MF_SHOW_STATUS_ICON flag status- Returns:
- true if MF_SHOW_STATUS_ICON flag is set
-
isShowStatusFrame
public boolean isShowStatusFrame()Returns the MF_SHOW_STATUS_FRAME flag status- Returns:
- true if MF_SHOW_STATUS_FRAME flag is set
-
isShowStatusBackground
public boolean isShowStatusBackground()Returns the MF_SHOW_STATUS_BKGND flag status- Returns:
- true if MF_SHOW_STATUS_BKGND flag is set
-
isShowEndNodes
public boolean isShowEndNodes()Returns the MF_SHOW_END_NODES flag status- Returns:
- true if MF_SHOW_END_NODES flag is set
-
isShowLinkDirection
public boolean isShowLinkDirection()Returns the MF_SHOW_LINK_DIRECTION flag status- Returns:
- true if MF_SHOW_LINK_DIRECTION flag is set
-
isCalculateStatus
public boolean isCalculateStatus()Returns the MF_CALCULATE_STATUS flag status- Returns:
- true if MF_CALCULATE_STATUS flag is set
-
isCenterBackgroundImage
public boolean isCenterBackgroundImage()Returns the MF_CENTER_BKGND_IMAGE flag status- Returns:
- true if MF_CENTER_BKGND_IMAGE flag is set
-
isTranslucentLabelBackground
public boolean isTranslucentLabelBackground()Returns the MF_TRANSLUCENT_LABEL_BKGND flag status- Returns:
- true if MF_TRANSLUCENT_LABEL_BKGND flag is set
-
isDontUpdateLinkText
public boolean isDontUpdateLinkText()Returns the MF_DONT_UPDATE_LINK_TEXT flag status- Returns:
- true if MF_DONT_UPDATE_LINK_TEXT flag is set
-
getWidth
public int getWidth()- Returns:
- the mapWidth
-
getHeight
public int getHeight()- Returns:
- the mapHeight
-
isFitBackgroundImage
public boolean isFitBackgroundImage()- Returns:
- true if background image should fit map size
-
updateWithTemplateData
Update modification data with template fields form this map- Parameters:
md
- modification data
-
getIfXTablePolicy
public int getIfXTablePolicy()Description copied from interface:PollingTarget
Get ifXTable usage policy.- Specified by:
getIfXTablePolicy
in interfacePollingTarget
- Returns:
- ifXTable usage policy
- See Also:
-
getAgentCacheMode
Description copied from interface:PollingTarget
Get agent cache mode.- Specified by:
getAgentCacheMode
in interfacePollingTarget
- Returns:
- agent cache mode
- See Also:
-
getPollerNodeId
public long getPollerNodeId()Description copied from interface:PollingTarget
Get poller node ID.- Specified by:
getPollerNodeId
in interfacePollingTarget
- Returns:
- poller node ID or 0 if object cannot have poler node
- See Also:
-
canHaveAgent
public boolean canHaveAgent()Description copied from interface:PollingTarget
Identify if this object can have NetXMS agent.- Specified by:
canHaveAgent
in interfacePollingTarget
- Returns:
- true if this object can have NetXMS agent
- See Also:
-
canHaveInterfaces
public boolean canHaveInterfaces()Description copied from interface:PollingTarget
Identify if this object can have network interfaces.- Specified by:
canHaveInterfaces
in interfacePollingTarget
- Returns:
- true if this object can have network interfaces
- See Also:
-
canHavePollerNode
public boolean canHavePollerNode()Description copied from interface:PollingTarget
Identify if this object can have poller node property.- Specified by:
canHavePollerNode
in interfacePollingTarget
- Returns:
- true if this object can have poller node property
- See Also:
-
canUseEtherNetIP
public boolean canUseEtherNetIP()Description copied from interface:PollingTarget
Identify if this object can use EtherNet/IP for communications.- Specified by:
canUseEtherNetIP
in interfacePollingTarget
- Returns:
- true if this object can use EtherNet/IP for communications
- See Also:
-
canUseModbus
public boolean canUseModbus()Description copied from interface:PollingTarget
Identify if this object can use Modbus for communications.- Specified by:
canUseModbus
in interfacePollingTarget
- Returns:
- true if this object can use Modbus for communications
- See Also:
-
getPollStates
Description copied from interface:PollingTarget
Get poll states.- Specified by:
getPollStates
in interfacePollingTarget
- Returns:
- array of poll states or null if object doesn't have any
- See Also:
-