Package com.storedobject.core

Class SystemUser

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.SystemUser

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasName, Notifye

@Table(tab="User")
public final class SystemUser
extends StoredObject
implements HasName, Notifye

This class represents a person who is also a system user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SystemUser.LogicHit
static final class	SystemUser.SessionLog

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
SystemUser()	Constructor for internal use only
SystemUser(String login, Id personId)	Constructs a System Person

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
boolean	canChangeLoginTo(String login)
void	changePassword(char[] currentPassword, char[] newPassword, String newLogin)	Change the password.
static void	columns(Columns columns)
String	createLoginBlock(ServerInformation server)
String	createLoginBlock(String externalServer)
String	format(Date date)
static SystemUser	get(String login)
AutoLogin	getAutoLogin()
Iterable<StoredObject>	getChangeLog(SystemUser.SessionLog sessionLog)
boolean	getConfirmLogout()
static SystemUser	getExact(String login)
Locale	getLocale()
static Locale	getLocale(String localeCountry, String localeLanguage)
String	getLocaleCountry()
String	getLocaleLanguage()
Iterable<SystemUser.LogicHit>	getLogicHit(SystemUser.SessionLog sessionLog)
String	getLogin()	Gets the login name.
String	getName()	Gets the name of the Person
Date	getPasswordExpiry()
Person	getPerson()	Gets the person.
Id	getPersonId()	Gets the Id of the person.
int	getPreferences()
static String[]	getPreferencesBitValues()
String	getPreferencesValue()
static String	getPreferencesValue(int value)
Iterable<SystemUser.SessionLog>	getSessionLog(AbstractPeriod<?> period, boolean reverse, String server)
Iterable<SystemUser.SessionLog>	getSessionLog(AbstractPeriod<?> period, String server)
int	getStatus()
static String[]	getStatusBitValues()
String	getStatusValue()
static String	getStatusValue(int value)
String	getUniqueCondition()	Gets the unique index condition of this object.
static void	indices(Indices indices)
boolean	isAdmin()
boolean	isAppAdmin()
boolean	isLocked()
static boolean	isLoginAvailable(String login)
boolean	isMemberOf(SystemUserGroup group)
boolean	isPasswordExpired()
boolean	isSS()
static boolean	isValidLogin(String login)
boolean	isVerified()
static String[]	links()
static ObjectIterator<SystemUser>	list(String login)
ObjectIterator<Logic>	listAutoLogic()
List<SystemEntity>	listEntities()	Get the list of entities configured for this user.
List<ExternalSystemUser>	listExternalUsers(String fromURL)
ObjectIterator<SystemUserGroup>	listGroups()
ObjectIterator<Logic>	listQuickAccessLogic()
void	lock(TransactionManager tm)
boolean	notify(String templateName, TransactionManager tm, Object... messageParameters)	Create and send a message to this user.
static String[]	protectedColumns()
void	resetPassword()
void	saveAsAuditor(Transaction transaction)
void	saveAsExternalUser(Transaction transaction)
void	saveAsProcessUser(Transaction transaction)
void	saveKeyForTOTP(TransactionManager tm, byte[] keyForTOTP)
static String[]	searchColumns()
void	setLocale(Locale locale)
void	setLocaleCountry(String localeCountry)
void	setLocaleLanguage(String localeLanguage)
void	setLogin(String login)
void	setPerson(Id id)
void	setPerson(BigDecimal idValue)
void	setPreferences(int preferences)
void	setStatus(int status)
String	toString()	String representation of the instance.
void	unlock(TransactionManager tm)
void	validate()	This method is invoked internally by the system whenever the object gets saved to the DB (that means, while doing transactions).
void	validateChildAttach(StoredObject child)
void	validateChildDetach(StoredObject child)
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.
void	validateNewPassword(char[] currentPassword, char[] password)
boolean	verify(char[] password)
boolean	verify(char[] password, boolean ignoreAuthenticator)
boolean	verify(char[] password, int authenticatorCode)
boolean	verifyPasswordUpdate()
boolean	verifyTOTP(int totp)

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SystemUser

public SystemUser(String login,
 Id personId)

Constructs a System Person

Parameters:

login - Login

personId - The Id of the person.

SystemUser

public SystemUser()

Constructor for internal use only

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

searchColumns

public static String[] searchColumns()

browseColumns

public static String[] browseColumns()

links

public static String[] links()

protectedColumns

public static String[] protectedColumns()

getName

public String getName()

Gets the name of the Person

Specified by:

getName in interface HasName

Returns:

The name

getPersonId

@SetNotAllowed
public Id getPersonId()

Gets the Id of the person.

Returns:

The Id of the person

setPerson

public void setPerson(BigDecimal idValue)

setPerson

public void setPerson(Id id)

Parameters:

id - Id of the person

getPerson

public Person getPerson()

Gets the person.

Returns:

The person.

getLogin

@Column(caption="Username")
public String getLogin()

Gets the login name.

Returns:

The login name.

setLogin

public void setLogin(String login)

getStatus

@SetNotAllowed
public int getStatus()

setStatus

public void setStatus(int status)

getStatusBitValues

public static String[] getStatusBitValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

saveKeyForTOTP

public void saveKeyForTOTP(TransactionManager tm,
 byte[] keyForTOTP)
                    throws Exception

Throws:

Exception

verifyTOTP

public boolean verifyTOTP(int totp)

validateNewPassword

public void validateNewPassword(char[] currentPassword,
 char[] password)
                         throws SOException

Throws:

SOException

changePassword

public void changePassword(char[] currentPassword,
 char[] newPassword,
 String newLogin)
                    throws SOException

Change the password.

Parameters:

currentPassword - Current password.

newPassword - New Password.

newLogin - New login (Could be null if no login change required).

Throws:

SOException - If password can not be set.

getPasswordExpiry

public Date getPasswordExpiry()

isPasswordExpired

public boolean isPasswordExpired()

verifyPasswordUpdate

public boolean verifyPasswordUpdate()

verify

public boolean verify(char[] password,
 boolean ignoreAuthenticator)

verify

public boolean verify(char[] password)

verify

public boolean verify(char[] password,
 int authenticatorCode)

isVerified

public boolean isVerified()

resetPassword

public void resetPassword()
                   throws Exception

Throws:

Exception

isSS

public boolean isSS()

isAdmin

public boolean isAdmin()

isAppAdmin

public boolean isAppAdmin()

setPreferences

public void setPreferences(int preferences)

getPreferences

@Column(required=false)
public int getPreferences()

getPreferencesBitValues

public static String[] getPreferencesBitValues()

getPreferencesValue

public static String getPreferencesValue(int value)

getPreferencesValue

public String getPreferencesValue()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

saveAsProcessUser

public void saveAsProcessUser(Transaction transaction)
                       throws Exception

Throws:

Exception

saveAsExternalUser

public void saveAsExternalUser(Transaction transaction)
                        throws Exception

Throws:

Exception

saveAsAuditor

public void saveAsAuditor(Transaction transaction)
                   throws Exception

Throws:

Exception

isValidLogin

public static boolean isValidLogin(String login)

isLoginAvailable

public static boolean isLoginAvailable(String login)

canChangeLoginTo

public boolean canChangeLoginTo(String login)

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

This method is invoked internally by the system whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/un-deleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc. are used to check the specific states but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate method is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Overrides:

validate in class StoredObject

Throws:

Exception - By raising an exception from this method the current transaction can be abandoned.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method the current transaction can be abandoned.

validateChildAttach

public void validateChildAttach(StoredObject child)
                         throws Exception

Throws:

Exception

validateChildDetach

public void validateChildDetach(StoredObject child)
                         throws Exception

Throws:

Exception

setLocaleLanguage

public void setLocaleLanguage(String localeLanguage)

getLocaleLanguage

@Column(required=false)
public String getLocaleLanguage()

setLocaleCountry

public void setLocaleCountry(String localeCountry)

getLocaleCountry

@Column(required=false,
        style="(country)")
public String getLocaleCountry()

setLocale

public void setLocale(Locale locale)

getLocale

public Locale getLocale()

getLocale

public static Locale getLocale(String localeCountry,
 String localeLanguage)

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

listQuickAccessLogic

public ObjectIterator<Logic> listQuickAccessLogic()

listAutoLogic

public ObjectIterator<Logic> listAutoLogic()

getExact

public static SystemUser getExact(String login)

get

public static SystemUser get(String login)

list

public static ObjectIterator<SystemUser> list(String login)

listGroups

public ObjectIterator<SystemUserGroup> listGroups()

getConfirmLogout

public boolean getConfirmLogout()

format

public String format(Date date)

isLocked

public boolean isLocked()

unlock

public void unlock(TransactionManager tm)
            throws Exception

Throws:

Exception

lock

public void lock(TransactionManager tm)
          throws Exception

Throws:

Exception

listEntities

public List<SystemEntity> listEntities()

Get the list of entities configured for this user.

Returns:

List.

getSessionLog

public Iterable<SystemUser.SessionLog> getSessionLog(AbstractPeriod<?> period,
 String server)

getSessionLog

public Iterable<SystemUser.SessionLog> getSessionLog(AbstractPeriod<?> period,
 boolean reverse,
 String server)

getChangeLog

public Iterable<StoredObject> getChangeLog(SystemUser.SessionLog sessionLog)

getLogicHit

public Iterable<SystemUser.LogicHit> getLogicHit(SystemUser.SessionLog sessionLog)

createLoginBlock

public String createLoginBlock(String externalServer)

createLoginBlock

public String createLoginBlock(ServerInformation server)

listExternalUsers

public List<ExternalSystemUser> listExternalUsers(String fromURL)

getAutoLogin

public AutoLogin getAutoLogin()

isMemberOf

public boolean isMemberOf(SystemUserGroup group)

notify

public boolean notify(String templateName,
 TransactionManager tm,
 Object... messageParameters)

Create and send a message to this user.

Note: If the template doesn't exist, the default template is used.

Specified by:

notify in interface Notifye

Parameters:

templateName - Name of the template to create the message.

tm - Transaction manager.

messageParameters - Parameters for creating message from the associated template.

Returns:

True the message is successfully created for delivery.