com.appiancorp.suiteapi.personalization

Class User

java.lang.Object

com.appiancorp.suiteapi.personalization.UserBase

com.appiancorp.suiteapi.personalization.User

All Implemented Interfaces:

com.appiancorp.asl3.servicefw.connect.ASLIdentity, LocalStringId, java.io.Serializable

Direct Known Subclasses:

UserProfile

@UserDataType
public class User
extends UserBase
implements LocalStringId

This represents the common User object. Username needs to be unique when creating or updating.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_ID Sort by the Id propety
static java.lang.Integer	SORT_BY_PASSWORD Sort by password
static java.lang.Integer	SORT_BY_USERNAME Sort by the Username property
static java.lang.Integer	USER_ROLE_ADMINISTRATOR Administrator user role for a group
static java.lang.Integer	USER_ROLE_CREATOR Creator user role for a group
static java.lang.Integer	USER_ROLE_MEMBER Member user role for a group
static java.lang.Integer	USER_ROLE_VIEWER Viewer user role for a group

Fields inherited from class com.appiancorp.suiteapi.personalization.UserBase

SORT_BY_DISPLAYNAME, SORT_BY_EMAIL, SORT_BY_FIRSTNAME, SORT_BY_LASTNAME, SORT_BY_MIDDLENAME, SORT_BY_SOCIALSECURITYNUMBER, STATUS_ACTIVE, STATUS_DEACTIVATED

Constructor Summary

Constructors

Constructor and Description
User() Default constructor.
User(java.lang.String username) Contructs a User object with the given username.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getId()
java.lang.String	getIdentifier() Alias for the the User's uuid {getUuid()
java.lang.String	getIdentity()
java.lang.String	getPassword() Deprecated. Since 6.0.2, use getUserPassword()
java.sql.Timestamp	getPasswordModified() Returns the timestamp when the user's password was modified last.
java.lang.String	getStringId() Returns this object's local identifier, null if the object was not identified locally using a String Id.
static java.lang.String[]	getUsernames(User[] users) Get the usernames (as a String array) from an array of User objects.
byte[]	getUserPassword() "UTF-8" Charset can be used to decode the byte[] password into a String or char[].
java.lang.String	getUuid() The User's Universal Unique Identifier
boolean	isTemporaryPassword() Returns true if the user's password is temporary else false; see UserService#changeUserPassword(String, char[], boolean).
boolean	isUserLocked() Returns true if the user is locked due to multiple unsuccessful login attempts else false; see UserService.loginAttempt(String,boolean) and UserService.unlockUser(String)
void	setId(java.lang.Long id)
void	setPassword(java.lang.String password) Deprecated. Since 6.0.2, use setUserPassword(byte[])
void	setPasswordModified(java.sql.Timestamp passwordModified) This field cannot be set explicitly using this setter.
void	setStringId(java.lang.String id) Sets this object's local identifier.
void	setTemporaryPassword(boolean temporaryPassword) This field cannot be set explicitly using this setter; see UserService#changeUserPassword(String, char[], boolean).
void	setUserLocked(boolean userLocked) This field cannot be set explicitly using this setter; see UserService.loginAttempt(String,boolean) and UserService.unlockUser(String)
void	setUserPassword(byte[] password) "UTF-8" Charset must be used to encode a String or char[] password into a byte[].
void	setUuid(java.lang.String uuid) Sets the User's uuid to the given uuid.

Methods inherited from class com.appiancorp.suiteapi.personalization.UserBase

getDisplayName, getEmail, getFavorite, getFirstName, getLastName, getMiddleName, getSocialSecurityNumber, getStatus, getUsername, setDisplayName, setEmail, setFavorite, setFirstName, setLastName, setMiddleName, setSocialSecurityNumber, setStatus, setUsername

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_USERNAME

public static final java.lang.Integer SORT_BY_USERNAME

Sort by the Username property

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Sort by the Id propety

SORT_BY_PASSWORD

public static final java.lang.Integer SORT_BY_PASSWORD

Sort by password

USER_ROLE_CREATOR

public static final java.lang.Integer USER_ROLE_CREATOR

Creator user role for a group

USER_ROLE_ADMINISTRATOR

public static final java.lang.Integer USER_ROLE_ADMINISTRATOR

Administrator user role for a group

USER_ROLE_MEMBER

public static final java.lang.Integer USER_ROLE_MEMBER

Member user role for a group

USER_ROLE_VIEWER

public static final java.lang.Integer USER_ROLE_VIEWER

Viewer user role for a group

Constructor Detail

User

public User()

Default constructor.

User

public User(java.lang.String username)

Contructs a User object with the given username.

Parameters:

username - the username

Method Detail

getIdentity

public java.lang.String getIdentity()

Specified by:

getIdentity in interface com.appiancorp.asl3.servicefw.connect.ASLIdentity

Overrides:

getIdentity in class UserBase

setStringId

public void setStringId(java.lang.String id)

Description copied from interface: LocalStringId

Sets this object's local identifier.

Specified by:

setStringId in interface LocalStringId

Parameters:

id - ID to set

See Also:

LocalStringId.getStringId()

getStringId

public java.lang.String getStringId()

Description copied from interface: LocalStringId

Returns this object's local identifier, null if the object was not identified locally using a String Id.

Specified by:

getStringId in interface LocalStringId

Returns:

Object's Id

See Also:

LocalStringId.setStringId(String)

setPassword

@Deprecated
public void setPassword(java.lang.String password)

Deprecated. Since 6.0.2, use setUserPassword(byte[])

getPassword

@Deprecated
 @Transient
public java.lang.String getPassword()

Deprecated. Since 6.0.2, use getUserPassword()

setUserPassword

public void setUserPassword(byte[] password)

"UTF-8" Charset must be used to encode a String or char[] password into a byte[]. Note: it is recommended to use char[] to store password and flush the array after the use. See this reference guide.

Parameters:

password - password as byte array

getUserPassword

public byte[] getUserPassword()

"UTF-8" Charset can be used to decode the byte[] password into a String or char[]. Note: it is recommended to use char[] to store password and flush the array after the use. See this reference guide. return password as byte array

getId

public java.lang.Long getId()

setId

public void setId(java.lang.Long id)

getUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getUuid()

The User's Universal Unique Identifier

Returns:

User's uuid

setUuid

public void setUuid(java.lang.String uuid)

Sets the User's uuid to the given uuid.

Parameters:

uuid - the

getIdentifier

@Transient
 @ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getIdentifier()

Alias for the the User's uuid {getUuid()

Returns:

User's uuid

getUsernames

public static java.lang.String[] getUsernames(User[] users)

Get the usernames (as a String array) from an array of User objects.

Parameters:

users - an array of Users

Returns:

an array of the same size as the given array, containing the usernames of the given Users; if given array is null, returns null

getPasswordModified

public java.sql.Timestamp getPasswordModified()

Returns the timestamp when the user's password was modified last.

setPasswordModified

public void setPasswordModified(java.sql.Timestamp passwordModified)

This field cannot be set explicitly using this setter.

isTemporaryPassword

public boolean isTemporaryPassword()

Returns true if the user's password is temporary else false; see UserService#changeUserPassword(String, char[], boolean).

setTemporaryPassword

public void setTemporaryPassword(boolean temporaryPassword)

This field cannot be set explicitly using this setter; see UserService#changeUserPassword(String, char[], boolean).

isUserLocked

public boolean isUserLocked()

Returns true if the user is locked due to multiple unsuccessful login attempts else false; see UserService.loginAttempt(String,boolean) and UserService.unlockUser(String)

setUserLocked

public void setUserLocked(boolean userLocked)

This field cannot be set explicitly using this setter; see UserService.loginAttempt(String,boolean) and UserService.unlockUser(String)