Package org.netxms.client.users

Class User

java.lang.Object

org.netxms.client.users.AbstractUserObject

org.netxms.client.users.User

public class User
extends AbstractUserObject

NetXMS user object

Field Summary

Fields inherited from class org.netxms.client.users.AbstractUserObject

CANNOT_CHANGE_PASSWORD, CHANGE_PASSWORD, CLOSE_OTHER_SESSIONS, customAttributes, DELETED, description, DISABLED, flags, guid, id, INTRUDER_LOCKOUT, LDAP_USER, ldapDn, ldapId, MODIFIED, MODIFY_2FA_BINDINGS, MODIFY_ACCESS_RIGHTS, MODIFY_AUTH_METHOD, MODIFY_CERT_MAPPING, MODIFY_CUSTOM_ATTRIBUTES, MODIFY_DESCRIPTION, MODIFY_EMAIL, MODIFY_FLAGS, MODIFY_FULL_NAME, MODIFY_GROUP_MEMBERSHIP, MODIFY_LOGIN_NAME, MODIFY_MEMBERS, MODIFY_PASSWD_LENGTH, MODIFY_PHONE_NUMBER, MODIFY_TEMP_DISABLE, MODIFY_UI_ACCESS_RULES, name, PASSWORD_NEVER_EXPIRES, SYNC_EXCEPTION, systemRights, TOKEN_AUTH_ONLY, type, uiAccessRules, USERDB_TYPE_GROUP, USERDB_TYPE_USER, WELL_KNOWN_ID_EVERYONE, WELL_KNOWN_ID_SYSTEM

Constructor Summary

Constructors

Constructor	Description
User(String name)	Default constructor
User(NXCPMessage msg)	Create user object from NXCP message
User(User src)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	fillMessage(NXCPMessage msg)	Fill NXCP message with object data
int	getAuthFailures()
UserAuthenticationMethod	getAuthMethod()	Get authentication method for this user.
String	getCertMappingData()
CertificateMappingMethod	getCertMappingMethod()	Get certificate mapping method for certificate based authentication.
Date	getDisabledUntil()
String	getEmail()
String	getFullName()
int[]	getGroups()
String	getLabel()	Get display label for this object.
Date	getLastLogin()
Date	getLastPasswordChange()
int	getMinPasswordLength()
String	getPhoneNumber()
Map<String,Map<String,String>>	getTwoFactorAuthMethodBindings()
void	setAuthMethod(UserAuthenticationMethod authMethod)	Set authentication method for this user.
void	setCertMappingData(String certMappingData)
void	setCertMappingMethod(CertificateMappingMethod certMappingMethod)	Set certificate mapping method for certificate based authentication.
void	setDisabledUntil(Date disabledUntil)
void	setEmail(String email)
void	setFullName(String fullName)
void	setGroups(int[] groups)
void	setMinPasswordLength(int minPasswordLength)
void	setPhoneNumber(String phoneNumber)
void	setTwoFactorAuthMethodBindings(Map<String,Map<String,String>> twoFactorAuthMethodBindings)

Methods inherited from class org.netxms.client.users.AbstractUserObject

getCreationTime, getCustomAttribute, getCustomAttributes, getDescription, getFlags, getGuid, getId, getLdapDn, getLdapId, getName, getSystemRights, getUIAccessRules, isDeleted, isDisabled, isPasswordChangeForbidden, isPasswordChangeNeeded, setCustomAttribute, setCustomAttributes, setDescription, setFlags, setId, setName, setSystemRights, setUIAccessRules

Methods inherited from class java.lang.Object

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

Constructor Details

User

public User(String name)

Default constructor

Parameters:

name - user name

User

public User(User src)

Copy constructor

Parameters:

src - object for copy

User

public User(NXCPMessage msg)

Create user object from NXCP message

Parameters:

msg - NXCP message

Method Details

fillMessage

public void fillMessage(NXCPMessage msg)

Fill NXCP message with object data

Overrides:

fillMessage in class AbstractUserObject

Parameters:

msg - NXCP message

getAuthMethod

public UserAuthenticationMethod getAuthMethod()

Get authentication method for this user.

Returns:

authentication method

setAuthMethod

public void setAuthMethod(UserAuthenticationMethod authMethod)

Set authentication method for this user.

Parameters:

authMethod - new authentication method

getCertMappingMethod

public CertificateMappingMethod getCertMappingMethod()

Get certificate mapping method for certificate based authentication.

Returns:

certificate mapping method for certificate based authentication

setCertMappingMethod

public void setCertMappingMethod(CertificateMappingMethod certMappingMethod)

Set certificate mapping method for certificate based authentication.

Parameters:

certMappingMethod - certificate mapping method for certificate based authentication

getCertMappingData

public String getCertMappingData()

Returns:

the certMappingData

setCertMappingData

public void setCertMappingData(String certMappingData)

Parameters:

certMappingData - the certMappingData to set

getFullName

public String getFullName()

Returns:

the fullName

setFullName

public void setFullName(String fullName)

Parameters:

fullName - the fullName to set

getLabel

public String getLabel()

Description copied from class: AbstractUserObject

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

Overrides:

getLabel in class AbstractUserObject

Returns:

display label for this object

See Also:

• AbstractUserObject.getLabel()

getMinPasswordLength

public int getMinPasswordLength()

Returns:

the minPasswordLength

setMinPasswordLength

public void setMinPasswordLength(int minPasswordLength)

Parameters:

minPasswordLength - the minPasswordLength to set

getDisabledUntil

public Date getDisabledUntil()

Returns:

the disabledUntil

setDisabledUntil

public void setDisabledUntil(Date disabledUntil)

Parameters:

disabledUntil - the disabledUntil to set

getLastLogin

public Date getLastLogin()

Returns:

the lastLogin

getLastPasswordChange

public Date getLastPasswordChange()

Returns:

the lastPasswordChange

getAuthFailures

public int getAuthFailures()

Returns:

the authFailures

getEmail

public String getEmail()

Returns:

the email

setEmail

public void setEmail(String email)

Parameters:

email - the email to set

getPhoneNumber

public String getPhoneNumber()

Returns:

the phoneNumber

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

Parameters:

phoneNumber - the phoneNumber to set

getGroups

public int[] getGroups()

Returns:

the groups

setGroups

public void setGroups(int[] groups)

Parameters:

groups - the groups to set

getTwoFactorAuthMethodBindings

public Map<String,Map<String,String>> getTwoFactorAuthMethodBindings()

Returns:

the twoFactorAuthMethodBindings

setTwoFactorAuthMethodBindings

public void setTwoFactorAuthMethodBindings(Map<String,Map<String,String>> twoFactorAuthMethodBindings)

Parameters:

twoFactorAuthMethodBindings - the twoFactorAuthMethodBindings to set