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

public class NetworkMap
extends GenericObject

Network map object

Field Summary

Fields

Modifier and Type	Field	Description
static final UUID	GEOMAP_BACKGROUND
static final int	MF_CALCULATE_STATUS
static final int	MF_CENTER_BKGND_IMAGE
static final int	MF_FILTER_OBJECTS
static final int	MF_SHOW_END_NODES
static final int	MF_SHOW_LINK_DIRECTION
static final int	MF_SHOW_STATUS_BKGND
static final int	MF_SHOW_STATUS_FRAME
static final int	MF_SHOW_STATUS_ICON
static final int	MF_TRANSLUCENT_LABEL_BKGND
static final int	MF_USE_L1_TOPOLOGY
static final int	TYPE_CUSTOM
static final int	TYPE_INTERNAL_TOPOLOGY
static final int	TYPE_IP_TOPOLOGY
static final int	TYPE_LAYER2_TOPOLOGY
static final int	TYPE_OSPF_TOPOLOGY

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_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_ZONE, objectClass, objectId, objectName, parents, 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

Constructors

Constructor	Description
NetworkMap(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
NetworkMapPage	createMapPage()	Create map page from map object's data
UUID	getBackground()
int	getBackgroundColor()
GeoLocation	getBackgroundLocation()
int	getBackgroundZoom()
int	getDefaultLinkColor()
int	getDefaultLinkRouting()
final int	getDiscoveryRadius()
String	getFilter()
int	getFlags()
MapLayoutAlgorithm	getLayout()
int	getMapType()
String	getObjectClassName()	Get name of NetXMS object's class.
MapObjectDisplayMode	getObjectDisplayMode()
List<Long>	getSeedObjects()
Set<String>	getStrings()	Get all strings in object
boolean	isAllowedOnMap()	If this method returns true object is allowed to be on custom network map.
boolean	isCalculateStatus()	Returns the MF_CALCULATE_STATUS flag status
boolean	isCenterBackgroundImage()	Returns the MF_CENTER_BKGND_IMAGE flag status
boolean	isShowEndNodes()	Returns the MF_SHOW_END_NODES flag status
boolean	isShowLinkDirection()	Returns the MF_SHOW_LINK_DIRECTION flag status
boolean	isShowStatusBackground()	Returns the MF_SHOW_STATUS_BKGND flag status
boolean	isShowStatusFrame()	Returns the MF_SHOW_STATUS_FRAME flag status
boolean	isShowStatusIcon()	Returns the MF_SHOW_STATUS_ICON flag status
boolean	isTranslucentLabelBackground()	Returns the MF_TRANSLUCENT_LABEL_BKGND flag status
void	prepareCopy(NXCObjectCreationData cd, NXCObjectModificationData md)	Prepare object creation and modification data to create map copy

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, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getObjectClass, getObjectId, getObjectName, 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, setSession

Methods inherited from class java.lang.Object

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

Field Details

GEOMAP_BACKGROUND

public static final UUID GEOMAP_BACKGROUND

TYPE_CUSTOM

public static final int TYPE_CUSTOM

See Also:

• Constant Field Values

TYPE_LAYER2_TOPOLOGY

public static final int TYPE_LAYER2_TOPOLOGY

See Also:

• Constant Field Values

TYPE_IP_TOPOLOGY

public static final int TYPE_IP_TOPOLOGY

See Also:

• Constant Field Values

TYPE_INTERNAL_TOPOLOGY

public static final int TYPE_INTERNAL_TOPOLOGY

See Also:

• Constant Field Values

TYPE_OSPF_TOPOLOGY

public static final int TYPE_OSPF_TOPOLOGY

See Also:

• Constant Field Values

MF_SHOW_STATUS_ICON

public static final int MF_SHOW_STATUS_ICON

See Also:

• Constant Field Values

MF_SHOW_STATUS_FRAME

public static final int MF_SHOW_STATUS_FRAME

See Also:

• Constant Field Values

MF_SHOW_STATUS_BKGND

public static final int MF_SHOW_STATUS_BKGND

See Also:

• Constant Field Values

MF_SHOW_END_NODES

public static final int MF_SHOW_END_NODES

See Also:

• Constant Field Values

MF_CALCULATE_STATUS

public static final int MF_CALCULATE_STATUS

See Also:

• Constant Field Values

MF_FILTER_OBJECTS

public static final int MF_FILTER_OBJECTS

See Also:

• Constant Field Values

MF_SHOW_LINK_DIRECTION

public static final int MF_SHOW_LINK_DIRECTION

See Also:

• Constant Field Values

MF_USE_L1_TOPOLOGY

public static final int MF_USE_L1_TOPOLOGY

See Also:

• Constant Field Values

MF_CENTER_BKGND_IMAGE

public static final int MF_CENTER_BKGND_IMAGE

See Also:

• Constant Field Values

MF_TRANSLUCENT_LABEL_BKGND

public static final int MF_TRANSLUCENT_LABEL_BKGND

See Also:

• Constant Field Values

Constructor Details

NetworkMap

public NetworkMap(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

prepareCopy

public void prepareCopy(NXCObjectCreationData cd,
 NXCObjectModificationData md)

Prepare object creation and modification data to create map copy

Parameters:

cd - object creation data

md - object modification data

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()

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()

getMapType

public int getMapType()

Returns:

the mapType

getLayout

public MapLayoutAlgorithm getLayout()

Returns:

the layout

getBackground

public UUID getBackground()

Returns:

the background

getSeedObjects

public List<Long> getSeedObjects()

Returns:

the seedObjectIds

createMapPage

public NetworkMapPage createMapPage()

Create map page from map object's data

Returns:

new map page

getBackgroundLocation

public GeoLocation getBackgroundLocation()

Returns:

the backgroundLocation

getBackgroundZoom

public int getBackgroundZoom()

Returns:

the backgroundZoom

getFlags

public int getFlags()

Returns:

the flags

getDefaultLinkColor

public int getDefaultLinkColor()

Returns:

the defaultLinkColor

getDefaultLinkRouting

public int getDefaultLinkRouting()

Returns:

the defaultLinkRouting

getBackgroundColor

public int getBackgroundColor()

Returns:

the backgroundColor

getDiscoveryRadius

public final int getDiscoveryRadius()

Returns:

the discoveryRadius

getFilter

public String getFilter()

Returns:

the filter

getObjectDisplayMode

public MapObjectDisplayMode getObjectDisplayMode()

Returns:

the objectDisplayMode

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()

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