org.netxms.client.objects
Class AbstractObject

java.lang.Object
  extended by org.netxms.client.objects.AbstractObject
Direct Known Subclasses:
GenericObject

public abstract class AbstractObject
extends java.lang.Object

Abstract base class for all NetXMS objects (both built-in and provided by extensions)


Field Summary
protected  java.util.HashSet<AccessListElement> accessList
           
static int BUSINESSSERVICEROOT
          Business Services
static int CALCULATE_DEFAULT
           
static int CALCULATE_MOST_CRITICAL
           
static int CALCULATE_MULTIPLE_THRESHOLDS
           
static int CALCULATE_SINGLE_THRESHOLD
           
protected  java.util.HashSet<java.lang.Long> children
           
protected  java.lang.String comments
           
protected  java.util.Map<java.lang.String,java.lang.String> customAttributes
           
static int DASHBOARDROOT
          Dashboards
protected  int fixedPropagatedStatus
           
protected  GeoLocation geolocation
           
protected  java.util.UUID guid
           
protected  java.util.UUID image
           
protected  boolean inheritAccessRights
           
protected  boolean isDeleted
           
static int NETWORK
          Entire network
static int NETWORKMAPROOT
          Network Maps
static int OBJECT_ACCESSPOINT
           
static int OBJECT_AGENTPOLICY
           
static int OBJECT_AGENTPOLICY_CONFIG
           
static int OBJECT_BUSINESSSERVICE
           
static int OBJECT_BUSINESSSERVICEROOT
           
static int OBJECT_CLUSTER
           
static int OBJECT_CONDITION
           
static int OBJECT_CONTAINER
           
static int OBJECT_CUSTOM
           
static int OBJECT_DASHBOARD
           
static int OBJECT_DASHBOARDROOT
           
static int OBJECT_GENERIC
           
static int OBJECT_INTERFACE
           
static int OBJECT_MOBILEDEVICE
           
static int OBJECT_NETWORK
           
static int OBJECT_NETWORKMAP
           
static int OBJECT_NETWORKMAPGROUP
           
static int OBJECT_NETWORKMAPROOT
           
static int OBJECT_NETWORKSERVICE
           
static int OBJECT_NODE
           
static int OBJECT_NODELINK
           
static int OBJECT_POLICYGROUP
           
static int OBJECT_POLICYROOT
           
static int OBJECT_RACK
           
static int OBJECT_REPORT
           
static int OBJECT_REPORTGROUP
           
static int OBJECT_REPORTROOT
           
static int OBJECT_SERVICEROOT
           
static int OBJECT_SLMCHECK
           
static int OBJECT_SUBNET
           
static int OBJECT_TEMPLATE
           
static int OBJECT_TEMPLATEGROUP
           
static int OBJECT_TEMPLATEROOT
           
static int OBJECT_VPNCONNECTOR
           
static int OBJECT_ZONE
           
protected  int objectClass
           
protected  long objectId
           
protected  java.lang.String objectName
           
protected  java.util.HashSet<java.lang.Long> parents
           
static int POLICYROOT
          Configuration Policies
protected  java.net.InetAddress primaryIP
           
static int PROPAGATE_DEFAULT
           
static int PROPAGATE_FIXED
           
static int PROPAGATE_RELATIVE
           
static int PROPAGATE_TRANSLATED
           
static int PROPAGATE_UNCHANGED
           
static int REPORTROOT
          Reports
static int SERVICEROOT
          Infrastructure Services
protected  NXCSession session
           
protected  int status
           
protected  int statusCalculationMethod
           
protected  int statusPropagationMethod
           
protected  int statusShift
           
protected  int statusSingleThreshold
           
protected  int[] statusThresholds
           
protected  int[] statusTransformation
           
protected  long submapId
           
static int TEMPLATEROOT
          Templates
protected  java.util.HashSet<java.lang.Long> trustedNodes
           
static int ZONE0
          Default zone
 
Constructor Summary
protected AbstractObject(long id, NXCSession session)
          Create dummy object of GENERIC class
  AbstractObject(NXCPMessage msg, NXCSession session)
          Create object from NXCP message
 
Method Summary
 AccessListElement[] getAccessList()
           
 java.util.Set<AbstractObject> getAllChilds(int classFilter)
          Get all child objects, direct and indirect
 java.util.Set<AbstractObject> getAllParents(int classFilter)
          Get all parent objects, direct and indirect
 long[] getChildIdList()
          Return identifiers of all child objects
 java.util.Iterator<java.lang.Long> getChildren()
           
 AbstractObject[] getChildsAsArray()
           
 java.lang.String getComments()
           
 java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()
          Get object's custom attributes
 int getFixedPropagatedStatus()
           
 GeoLocation getGeolocation()
           
 java.util.UUID getGuid()
           
 java.util.UUID getImage()
           
 int getObjectClass()
           
 java.lang.String getObjectClassName()
           
 long getObjectId()
           
 java.lang.String getObjectName()
           
 long[] getParentIdList()
          Return identifiers of all parent objects
 java.util.Iterator<java.lang.Long> getParents()
           
 AbstractObject[] getParentsAsArray()
           
 java.net.InetAddress getPrimaryIP()
           
 int getStatus()
           
 int getStatusCalculationMethod()
           
 int getStatusPropagationMethod()
           
 int getStatusShift()
           
 int getStatusSingleThreshold()
           
 int[] getStatusThresholds()
           
 int[] getStatusTransformation()
           
 long getSubmapId()
           
 AbstractObject[] getTrustedNodes()
           
 boolean hasAccessibleChildren()
           
 boolean hasChildren()
           
 int hashCode()
           
 boolean hasParents()
           
 boolean isAllowedOnMap()
          If this method returns true object is allowed to be on custom network map.
 boolean isChildOf(long objectId)
          Check if given object is direct or indirect parent
 boolean isChildOf(long[] objects)
          Check if at least one of given objects is direct or indirect parent
 boolean isDefaultImage()
          Check if object should be represented by class default image
 boolean isDeleted()
           
 boolean isDirectChildOf(long objectId)
          Check if given object is direct parent
 boolean isInheritAccessRights()
           
 void setSession(NXCSession session)
          Update internal session reference during session handover.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NETWORK

public static final int NETWORK
Entire network

See Also:
Constant Field Values

SERVICEROOT

public static final int SERVICEROOT
Infrastructure Services

See Also:
Constant Field Values

TEMPLATEROOT

public static final int TEMPLATEROOT
Templates

See Also:
Constant Field Values

ZONE0

public static final int ZONE0
Default zone

See Also:
Constant Field Values

POLICYROOT

public static final int POLICYROOT
Configuration Policies

See Also:
Constant Field Values

NETWORKMAPROOT

public static final int NETWORKMAPROOT
Network Maps

See Also:
Constant Field Values

DASHBOARDROOT

public static final int DASHBOARDROOT
Dashboards

See Also:
Constant Field Values

REPORTROOT

public static final int REPORTROOT
Reports

See Also:
Constant Field Values

BUSINESSSERVICEROOT

public static final int BUSINESSSERVICEROOT
Business Services

See Also:
Constant Field Values

OBJECT_GENERIC

public static final int OBJECT_GENERIC
See Also:
Constant Field Values

OBJECT_SUBNET

public static final int OBJECT_SUBNET
See Also:
Constant Field Values

OBJECT_NODE

public static final int OBJECT_NODE
See Also:
Constant Field Values

OBJECT_INTERFACE

public static final int OBJECT_INTERFACE
See Also:
Constant Field Values

OBJECT_NETWORK

public static final int OBJECT_NETWORK
See Also:
Constant Field Values

OBJECT_CONTAINER

public static final int OBJECT_CONTAINER
See Also:
Constant Field Values

OBJECT_ZONE

public static final int OBJECT_ZONE
See Also:
Constant Field Values

OBJECT_SERVICEROOT

public static final int OBJECT_SERVICEROOT
See Also:
Constant Field Values

OBJECT_TEMPLATE

public static final int OBJECT_TEMPLATE
See Also:
Constant Field Values

OBJECT_TEMPLATEGROUP

public static final int OBJECT_TEMPLATEGROUP
See Also:
Constant Field Values

OBJECT_TEMPLATEROOT

public static final int OBJECT_TEMPLATEROOT
See Also:
Constant Field Values

OBJECT_NETWORKSERVICE

public static final int OBJECT_NETWORKSERVICE
See Also:
Constant Field Values

OBJECT_VPNCONNECTOR

public static final int OBJECT_VPNCONNECTOR
See Also:
Constant Field Values

OBJECT_CONDITION

public static final int OBJECT_CONDITION
See Also:
Constant Field Values

OBJECT_CLUSTER

public static final int OBJECT_CLUSTER
See Also:
Constant Field Values

OBJECT_POLICYGROUP

public static final int OBJECT_POLICYGROUP
See Also:
Constant Field Values

OBJECT_POLICYROOT

public static final int OBJECT_POLICYROOT
See Also:
Constant Field Values

OBJECT_AGENTPOLICY

public static final int OBJECT_AGENTPOLICY
See Also:
Constant Field Values

OBJECT_AGENTPOLICY_CONFIG

public static final int OBJECT_AGENTPOLICY_CONFIG
See Also:
Constant Field Values

OBJECT_NETWORKMAPROOT

public static final int OBJECT_NETWORKMAPROOT
See Also:
Constant Field Values

OBJECT_NETWORKMAPGROUP

public static final int OBJECT_NETWORKMAPGROUP
See Also:
Constant Field Values

OBJECT_NETWORKMAP

public static final int OBJECT_NETWORKMAP
See Also:
Constant Field Values

OBJECT_DASHBOARDROOT

public static final int OBJECT_DASHBOARDROOT
See Also:
Constant Field Values

OBJECT_DASHBOARD

public static final int OBJECT_DASHBOARD
See Also:
Constant Field Values

OBJECT_REPORTROOT

public static final int OBJECT_REPORTROOT
See Also:
Constant Field Values

OBJECT_REPORTGROUP

public static final int OBJECT_REPORTGROUP
See Also:
Constant Field Values

OBJECT_REPORT

public static final int OBJECT_REPORT
See Also:
Constant Field Values

OBJECT_BUSINESSSERVICEROOT

public static final int OBJECT_BUSINESSSERVICEROOT
See Also:
Constant Field Values

OBJECT_BUSINESSSERVICE

public static final int OBJECT_BUSINESSSERVICE
See Also:
Constant Field Values

OBJECT_NODELINK

public static final int OBJECT_NODELINK
See Also:
Constant Field Values

OBJECT_SLMCHECK

public static final int OBJECT_SLMCHECK
See Also:
Constant Field Values

OBJECT_MOBILEDEVICE

public static final int OBJECT_MOBILEDEVICE
See Also:
Constant Field Values

OBJECT_RACK

public static final int OBJECT_RACK
See Also:
Constant Field Values

OBJECT_ACCESSPOINT

public static final int OBJECT_ACCESSPOINT
See Also:
Constant Field Values

OBJECT_CUSTOM

public static final int OBJECT_CUSTOM
See Also:
Constant Field Values

CALCULATE_DEFAULT

public static final int CALCULATE_DEFAULT
See Also:
Constant Field Values

CALCULATE_MOST_CRITICAL

public static final int CALCULATE_MOST_CRITICAL
See Also:
Constant Field Values

CALCULATE_SINGLE_THRESHOLD

public static final int CALCULATE_SINGLE_THRESHOLD
See Also:
Constant Field Values

CALCULATE_MULTIPLE_THRESHOLDS

public static final int CALCULATE_MULTIPLE_THRESHOLDS
See Also:
Constant Field Values

PROPAGATE_DEFAULT

public static final int PROPAGATE_DEFAULT
See Also:
Constant Field Values

PROPAGATE_UNCHANGED

public static final int PROPAGATE_UNCHANGED
See Also:
Constant Field Values

PROPAGATE_FIXED

public static final int PROPAGATE_FIXED
See Also:
Constant Field Values

PROPAGATE_RELATIVE

public static final int PROPAGATE_RELATIVE
See Also:
Constant Field Values

PROPAGATE_TRANSLATED

public static final int PROPAGATE_TRANSLATED
See Also:
Constant Field Values

session

protected NXCSession session

objectId

protected long objectId

guid

protected java.util.UUID guid

objectName

protected java.lang.String objectName

objectClass

protected int objectClass

status

protected int status

isDeleted

protected boolean isDeleted

primaryIP

protected java.net.InetAddress primaryIP

comments

protected java.lang.String comments

geolocation

protected GeoLocation geolocation

image

protected java.util.UUID image

submapId

protected long submapId

trustedNodes

protected java.util.HashSet<java.lang.Long> trustedNodes

inheritAccessRights

protected boolean inheritAccessRights

accessList

protected java.util.HashSet<AccessListElement> accessList

statusCalculationMethod

protected int statusCalculationMethod

statusPropagationMethod

protected int statusPropagationMethod

fixedPropagatedStatus

protected int fixedPropagatedStatus

statusShift

protected int statusShift

statusTransformation

protected int[] statusTransformation

statusSingleThreshold

protected int statusSingleThreshold

statusThresholds

protected int[] statusThresholds

parents

protected java.util.HashSet<java.lang.Long> parents

children

protected java.util.HashSet<java.lang.Long> children

customAttributes

protected java.util.Map<java.lang.String,java.lang.String> customAttributes
Constructor Detail

AbstractObject

protected AbstractObject(long id,
                         NXCSession session)
Create dummy object of GENERIC class

Parameters:
id - object ID to set
session - associated session

AbstractObject

public AbstractObject(NXCPMessage msg,
                      NXCSession session)
Create object from NXCP message

Parameters:
msg - Message to create object from
session - Associated client session
Method Detail

isDefaultImage

public boolean isDefaultImage()
Check if object should be represented by class default image

Returns:
true if default image should be used

getParents

public java.util.Iterator<java.lang.Long> getParents()
Returns:
Iterator for list of parent objects

getChildren

public java.util.Iterator<java.lang.Long> getChildren()
Returns:
Iterator for list of child objects

getAccessList

public AccessListElement[] getAccessList()
Returns:
Access list

getComments

public java.lang.String getComments()
Returns:
the comments

getObjectId

public long getObjectId()
Returns:
the objectId

getObjectName

public java.lang.String getObjectName()
Returns:
the objectName

getPrimaryIP

public java.net.InetAddress getPrimaryIP()
Returns:
the primaryIP

getStatus

public int getStatus()
Returns:
the status

isDeleted

public boolean isDeleted()
Returns:
the isDeleted

isInheritAccessRights

public boolean isInheritAccessRights()
Returns:
the inheritAccessRights

isChildOf

public boolean isChildOf(long objectId)
Check if given object is direct or indirect parent

Parameters:
objectId - ID of object to check

isChildOf

public boolean isChildOf(long[] objects)
Check if at least one of given objects is direct or indirect parent

Parameters:
objects - List of object ID to check

isDirectChildOf

public boolean isDirectChildOf(long objectId)
Check if given object is direct parent

Parameters:
objectId - ID of object to check

getParentsAsArray

public AbstractObject[] getParentsAsArray()
Returns:
List of parent objects

getChildsAsArray

public AbstractObject[] getChildsAsArray()
Returns:
List of child objects

getChildIdList

public long[] getChildIdList()
Return identifiers of all child objects

Returns:

getParentIdList

public long[] getParentIdList()
Return identifiers of all parent objects

Returns:

getAllChilds

public java.util.Set<AbstractObject> getAllChilds(int classFilter)
Get all child objects, direct and indirect

Parameters:
classFilter - -1 to get all childs, or NetXMS class id to retrieve objects of given class
Returns:
set of child objects

getAllParents

public java.util.Set<AbstractObject> getAllParents(int classFilter)
Get all parent objects, direct and indirect

Parameters:
classFilter - -1 to get all parents, or NetXMS class id to retrieve objects of given class
Returns:
set of parent objects

getTrustedNodes

public AbstractObject[] getTrustedNodes()
Returns:
List of trusted nodes

hasParents

public boolean hasParents()
Returns:
true if object has parents

hasChildren

public boolean hasChildren()
Returns:
true if object has children

hasAccessibleChildren

public boolean hasAccessibleChildren()
Returns:
true if object has children accessible by this session

isAllowedOnMap

public boolean isAllowedOnMap()
If this method returns true object is allowed to be on custom network map. Default implementation always returns false.

Returns:
true if object is allowed to be on custom network map

getObjectClass

public int getObjectClass()
Returns:
the objectClass

getObjectClassName

public java.lang.String getObjectClassName()
Returns:
Name of NetXMS object's class

getCustomAttributes

public java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()
Get object's custom attributes


getGeolocation

public GeoLocation getGeolocation()
Returns:
the geolocation

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getGuid

public java.util.UUID getGuid()
Returns:
the guid

getImage

public java.util.UUID getImage()
Returns:
the image

getSubmapId

public long getSubmapId()
Returns:
the submapId

getStatusCalculationMethod

public int getStatusCalculationMethod()
Returns:
the statusCalculationMethod

getStatusPropagationMethod

public int getStatusPropagationMethod()
Returns:
the statusPropagationMethod

getFixedPropagatedStatus

public int getFixedPropagatedStatus()
Returns:
the fixedPropagatedStatus

getStatusShift

public int getStatusShift()
Returns:
the statusShift

getStatusTransformation

public int[] getStatusTransformation()
Returns:
the statusTransformation

getStatusSingleThreshold

public int getStatusSingleThreshold()
Returns:
the statusSingleThreshold

getStatusThresholds

public int[] getStatusThresholds()
Returns:
the statusThresholds

setSession

public final void setSession(NXCSession session)
Update internal session reference during session handover. This method should not be called directly!

Parameters:
session - new session object


Copyright © 2013. All Rights Reserved.