Package org.netxms.client.users
Class AbstractUserObject
java.lang.Object
org.netxms.client.users.AbstractUserObject
Abstract NetXMS user database object.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
protected String
static final int
protected int
protected UUID
protected int
static final int
static final int
protected String
protected String
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
protected String
static final int
static final int
protected long
static final int
protected String
protected String
static final String
static final String
static final int
static final int
-
Constructor Summary
ConstructorDescriptionAbstractUserObject
(String name, String type) Create new user object.AbstractUserObject
(NXCPMessage msg, String type) Create object from NXCP messageCopy constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
fillMessage
(NXCPMessage msg) Fill NXCP message with object dataGet creation dategetCustomAttribute
(String name) Get custom attributeint
getFlags()
getGuid()
int
getId()
getLabel()
Get display label for this object.getName()
long
boolean
boolean
Check if object is disabledboolean
Check if password change is forbiddenboolean
Check if password should be changed at next logonvoid
setCustomAttribute
(String name, String value) Set custom attribute's valuevoid
setDescription
(String description) void
setFlags
(int flags) void
setId
(int id) void
void
setSystemRights
(long systemRights) void
setUIAccessRules
(String uiAccessRules)
-
Field Details
-
USERDB_TYPE_USER
- See Also:
-
USERDB_TYPE_GROUP
- See Also:
-
MODIFIED
public static final int MODIFIED- See Also:
-
DELETED
public static final int DELETED- See Also:
-
DISABLED
public static final int DISABLED- See Also:
-
CHANGE_PASSWORD
public static final int CHANGE_PASSWORD- See Also:
-
CANNOT_CHANGE_PASSWORD
public static final int CANNOT_CHANGE_PASSWORD- See Also:
-
INTRUDER_LOCKOUT
public static final int INTRUDER_LOCKOUT- See Also:
-
PASSWORD_NEVER_EXPIRES
public static final int PASSWORD_NEVER_EXPIRES- See Also:
-
LDAP_USER
public static final int LDAP_USER- See Also:
-
SYNC_EXCEPTION
public static final int SYNC_EXCEPTION- See Also:
-
CLOSE_OTHER_SESSIONS
public static final int CLOSE_OTHER_SESSIONS- See Also:
-
TOKEN_AUTH_ONLY
public static final int TOKEN_AUTH_ONLY- See Also:
-
MODIFY_LOGIN_NAME
public static final int MODIFY_LOGIN_NAME- See Also:
-
MODIFY_DESCRIPTION
public static final int MODIFY_DESCRIPTION- See Also:
-
MODIFY_FULL_NAME
public static final int MODIFY_FULL_NAME- See Also:
-
MODIFY_FLAGS
public static final int MODIFY_FLAGS- See Also:
-
MODIFY_ACCESS_RIGHTS
public static final int MODIFY_ACCESS_RIGHTS- See Also:
-
MODIFY_MEMBERS
public static final int MODIFY_MEMBERS- See Also:
-
MODIFY_CERT_MAPPING
public static final int MODIFY_CERT_MAPPING- See Also:
-
MODIFY_AUTH_METHOD
public static final int MODIFY_AUTH_METHOD- See Also:
-
MODIFY_PASSWD_LENGTH
public static final int MODIFY_PASSWD_LENGTH- See Also:
-
MODIFY_TEMP_DISABLE
public static final int MODIFY_TEMP_DISABLE- See Also:
-
MODIFY_CUSTOM_ATTRIBUTES
public static final int MODIFY_CUSTOM_ATTRIBUTES- See Also:
-
MODIFY_UI_ACCESS_RULES
public static final int MODIFY_UI_ACCESS_RULES- See Also:
-
MODIFY_GROUP_MEMBERSHIP
public static final int MODIFY_GROUP_MEMBERSHIP- See Also:
-
MODIFY_EMAIL
public static final int MODIFY_EMAIL- See Also:
-
MODIFY_PHONE_NUMBER
public static final int MODIFY_PHONE_NUMBER- See Also:
-
MODIFY_2FA_BINDINGS
public static final int MODIFY_2FA_BINDINGS- See Also:
-
WELL_KNOWN_ID_SYSTEM
public static final int WELL_KNOWN_ID_SYSTEM- See Also:
-
WELL_KNOWN_ID_EVERYONE
public static final int WELL_KNOWN_ID_EVERYONE- See Also:
-
type
-
id
protected int id -
name
-
guid
-
systemRights
protected long systemRights -
uiAccessRules
-
flags
protected int flags -
description
-
ldapDn
-
ldapId
-
customAttributes
-
-
Constructor Details
-
AbstractUserObject
Create new user object.- Parameters:
name
- object nametype
- object type for REST API (should be "user" or "group")
-
AbstractUserObject
Copy constructor- Parameters:
src
- source object
-
AbstractUserObject
Create object from NXCP message- Parameters:
msg
- Message containing object's datatype
- object type
-
-
Method Details
-
fillMessage
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
- Returns:
- the name
-
setName
- Parameters:
name
- the name to set
-
getGuid
- Returns:
- the guid
-
getLdapDn
- Returns:
- the ldapDn
-
getLdapId
- Returns:
- the ldapId
-
getSystemRights
public long getSystemRights()- Returns:
- the systemRights
-
setSystemRights
public void setSystemRights(long systemRights) - Parameters:
systemRights
- the systemRights to set
-
getUIAccessRules
- Returns:
- the uiAccessRules
-
setUIAccessRules
- 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
- Returns:
- the description
-
setDescription
- Parameters:
description
- the description to set
-
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
Get custom attribute- Parameters:
name
- Name of the attribute- Returns:
- Custom attribute value
-
setCustomAttribute
Set custom attribute's value- Parameters:
name
- Name of the attributevalue
- New value for attribute
-
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
Get creation date- Returns:
- creation date
-