Package org.netxms.client.users

Class AbstractUserObject

java.lang.Object
org.netxms.client.users.AbstractUserObject
Direct Known Subclasses:
User, UserGroup
public abstract class AbstractUserObject extends Object
Abstract NetXMS user database object.

  • Field Details

  • Constructor Details

    • AbstractUserObject

      public AbstractUserObject(String name, String type)
      Create new user object.
      Parameters:
      name - object name
      type - object type for REST API (should be "user" or "group")

    • AbstractUserObject

      public AbstractUserObject(AbstractUserObject src)
      Copy constructor
      Parameters:
      src - source object

    • AbstractUserObject

      public AbstractUserObject(NXCPMessage msg, String type)
      Create object from NXCP message
      Parameters:
      msg - Message containing object's data
      type - object type

  • Method Details

    • fillMessage

      public void fillMessage(NXCPMessage msg)
      Fill NXCP message with object data
      Parameters:
      msg - destination message

    • isDeleted

      public boolean isDeleted()
      Returns:
      true if user is marked as deleted

    • getId

      public int getId()
      Returns:
      the id

    • setId

      public void setId(int id)
      Parameters:
      id - the id to set

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getGuid

      public UUID getGuid()
      Returns:
      the guid

    • getLdapDn

      public String getLdapDn()
      Returns:
      the ldapDn

    • getLdapId

      public String getLdapId()
      Returns:
      the ldapId

    • getSystemRights

      public long getSystemRights()
      Returns:
      the systemRights

    • setSystemRights

      public void setSystemRights(long systemRights)
      Parameters:
      systemRights - the systemRights to set

    • getUIAccessRules

      public String getUIAccessRules()
      Returns:
      the uiAccessRules

    • setUIAccessRules

      public void setUIAccessRules(String uiAccessRules)
      Parameters:
      uiAccessRules - the uiAccessRules to set

    • getFlags

      public int getFlags()
      Returns:
      the flags

    • setFlags

      public void setFlags(int flags)
      Parameters:
      flags - the flags to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getLabel

      public String getLabel()
      Get display label for this object. Label includes object name and description (if present). Subclasses may add additional fields to the label.
      Returns:
      display label for this object

    • getCustomAttribute

      public String getCustomAttribute(String name)
      Get custom attribute
      Parameters:
      name - Name of the attribute
      Returns:
      Custom attribute value

    • setCustomAttribute

      public void setCustomAttribute(String name, String value)
      Set custom attribute's value
      Parameters:
      name - Name of the attribute
      value - New value for attribute

    • getCustomAttributes

      public Map<String,String> getCustomAttributes()
      Returns:
      the customAttributes

    • setCustomAttributes

      public void setCustomAttributes(Map<String,String> customAttributes)
      Parameters:
      customAttributes - the customAttributes to set

    • isDisabled

      public boolean isDisabled()
      Check if object is disabled
      Returns:
      true if object is disabled

    • isPasswordChangeNeeded

      public boolean isPasswordChangeNeeded()
      Check if password should be changed at next logon
      Returns:
      true if password should be changed at next logon

    • isPasswordChangeForbidden

      public boolean isPasswordChangeForbidden()
      Check if password change is forbidden
      Returns:
      true if password change is forbidden

    • getCreationTime

      public Date getCreationTime()
      Get creation date
      Returns:
      creation date