Package org.netxms.client.objects

Class Rack

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

org.netxms.client.objects.Rack

All Implemented Interfaces:

PollingTarget

public class Rack
extends DataCollectionTarget
implements PollingTarget

Rack object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FRONT_SIDE_ONLY
static final int	PLACED_IN_ROOM

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_ROOM, 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, timeZone, timeZoneRule, timeZoneSourceObjectId, trustedObjects, UNKNOWN, urls, ZONE0

Constructor Summary

Constructors

Constructor	Description
Rack(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.
int	getDepth()	Get external cabinet depth.
int	getFlags()	Get object flags.
int	getHeight()
int	getIfXTablePolicy()	Get ifXTable usage policy.
String	getObjectClassName()	Get name of NetXMS object's class.
PassiveRackElement	getPassiveElement(long id)	Get passive element by ID.
List<PassiveRackElement>	getPassiveElements()	Get rack attribute config entry list
long	getPollerNodeId()	Get poller node ID.
PollState[]	getPollStates()	Get poll states.
int	getRoomRotation()	Get rotation of rack on room floor plan (front direction).
int	getRoomX()	Get X coordinate of rack footprint reference corner on room floor plan.
int	getRoomY()	Get Y coordinate of rack footprint reference corner on room floor plan.
List<HardwareEntity>	getUnits()	Get rack units, ordered by unit numbers
int	getWidth()	Get external cabinet width.
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	isFrontSideOnly()	Check if "front side only" flag is set for this rack.
boolean	isPlacedInRoom()	Check if this rack was positioned on floor plan of its room.
boolean	isTopBottomNumbering()

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, getStrings, getTimeZone, getTimeZoneRule, getTimeZoneSourceObjectId, 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, isTimeZoneInherited, 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

FRONT_SIDE_ONLY

public static final int FRONT_SIDE_ONLY

See Also:

• Constant Field Values

PLACED_IN_ROOM

public static final int PLACED_IN_ROOM

See Also:

• Constant Field Values

Constructor Details

Rack

public Rack(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

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

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

getHeight

public int getHeight()

Returns:

the height

isTopBottomNumbering

public boolean isTopBottomNumbering()

Returns:

the topBottomNumbering

getPassiveElements

public List<PassiveRackElement> getPassiveElements()

Get rack attribute config entry list

Returns:

entryList

getUnits

public List<HardwareEntity> getUnits()

Get rack units, ordered by unit numbers

Returns:

rack units, ordered by unit numbers

getPassiveElement

public PassiveRackElement getPassiveElement(long id)

Get passive element by ID.

Parameters:

id - element ID

Returns:

passive element with given ID or null if such element does not exist

getWidth

public int getWidth()

Get external cabinet width.

Returns:

external cabinet width in millimetres

getDepth

public int getDepth()

Get external cabinet depth.

Returns:

external cabinet depth in millimetres

getRoomX

public int getRoomX()

Get X coordinate of rack footprint reference corner on room floor plan. Only meaningful if rack is placed in room.

Returns:

X coordinate in room coordinates, millimetres

getRoomY

public int getRoomY()

Get Y coordinate of rack footprint reference corner on room floor plan. Only meaningful if rack is placed in room.

Returns:

Y coordinate in room coordinates, millimetres

getRoomRotation

public int getRoomRotation()

Get rotation of rack on room floor plan (front direction). Only meaningful if rack is placed in room.

Returns:

rotation in degrees (0..359)

isPlacedInRoom

public boolean isPlacedInRoom()

Check if this rack was positioned on floor plan of its room. Server clears this flag when rack is removed from the room.

Returns:

true if rack was positioned on room floor plan

isFrontSideOnly

public boolean isFrontSideOnly()

Check if "front side only" flag is set for this rack.

Returns:

true if "front side only" flag is set for this rack

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