Package mc.core.domain.cc.dobj

Class UserDO

java.lang.Object

mc.core.system.base.BaseBean

mc.core.domain.base.dobj.AbstractBaseDO<T>

mc.core.domain.base.dobj.AbstractEntityBaseDO<T>

mc.core.domain.base.dobj.AbstractComplexEntityDO<T>

mc.core.domain.cc.dobj.AbstractPrincipalDO<User>

mc.core.domain.cc.dobj.UserDO

All Implemented Interfaces:

IBaseDO<User>

public class UserDO
extends AbstractPrincipalDO<User>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserDO.TemplateParameter
static class	UserDO.UserEvent

Nested classes/interfaces inherited from class mc.core.domain.base.dobj.AbstractBaseDO

AbstractBaseDO.Initializer

Constructor Summary

Constructors

Constructor	Description
UserDO()

Method Summary

Modifier and Type	Method	Description
void	delete(User user, boolean force)	NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!
void	deleteSync(User user)	Final delete of user.
User	edit(User user)
List<User>	getAllActive(mc.core.system.search.SearchFilter sf)	get all principals (User and UserGroup) according to given SearchFilter and active, not deleted and with isSystem-Flag false.
User	getFromLoginAndPassword(String login, String password)	get user from login and password: main method used for authenticating user
User	getSystemUser(UserCredentials systemUserCredentials)
List<Territory>	getTerritoriesForUser(User user, boolean fallbackToAllActive)
<T extends Serializable> T	getUserProfileValue(User user, UserProfile.UserProfileKey key, Class<T> valueClass)
boolean	getUserProfileValueBoolean(User user, UserProfile.UserProfileKey key)
String	getUserProfileValueString(User user, UserProfile.UserProfileKey key)
User	insert(User user)
User	insert(User user, Locale defaultLocale, UserGroup defaultUserGroup)
boolean	isLDAPUser(User user)
UserDO.UserEvent	newEvent(mc.core.service.event.Event.IEventType eventType, User entity)
void	passwordChange(User user, String oldPassword, String newPassword, String newPasswordRepeat)	compare old password, prepare and set new if password is valid
String	passwordGenerateNew(String login, String userIP)	generate new password for user with given login and send it an user email if any in profile, else send email to admin, the pw must be changed manual.
boolean	passwordMustBeChanged(User user)
void	passwordSet(User user, String pw)	verify and encrypt password, and set in user object if valid
User	passwordValidateLink(String changePasswordToken)
User	save(User user, String newPw, String newPwRepeat, DataMap dataMap)
User	save(User user, DataMap dataMap)	map data to entity if any, validate and save
void	setUserProfileValue(User user, UserProfile.UserProfileKey key, Object value)
void	unlockAccount(String uid)	Check validity of link and unlock the user account
User	validateLink(String tokenToCheck, String msgKey)

Methods inherited from class mc.core.domain.cc.dobj.AbstractPrincipalDO

getAllActive

Methods inherited from class mc.core.domain.base.dobj.AbstractComplexEntityDO

addDefaultSearchCriteria, assertPermission, assertPermission, attributes, copy, copyDataSync, copyToCollection, doRecursiveActionAsync, entityProfileApply, entityProfileApply, filter, getCollectionHierarchies, getCollectionsAll, getFromExternalKey, getFromKeySearchFilter, getUserRole, lifecycle, newComplexEntityEvent, onChange, parameter, permissions, prepareSearchFilter, relations, secondaryCollectionAdd, secondaryCollectionCopy, secondaryCollectionMove, secondaryCollectionRemove, setRightInheritanceDisabled, states, translate, versions, watches

Methods inherited from class mc.core.domain.base.dobj.AbstractEntityBaseDO

getFromInternalDescription, sendEvent, sendEvent

Methods inherited from class mc.core.domain.base.dobj.AbstractBaseDO

delete, getAll, getEntityDisplay, getFromId, getFromKey, getOne, map, map, save, validator

Methods inherited from class java.lang.Object

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

Constructor Details

UserDO

public UserDO()

Method Details

getAllActive

public List<User> getAllActive(mc.core.system.search.SearchFilter sf)

Description copied from class: AbstractPrincipalDO

get all principals (User and UserGroup) according to given SearchFilter and active, not deleted and with isSystem-Flag false.

Overrides:

getAllActive in class AbstractPrincipalDO<User>

insert

public User insert(User user)
            throws ApplicationException

Overrides:

insert in class AbstractComplexEntityDO<User>

Throws:

ApplicationException

insert

public User insert(User user,
 Locale defaultLocale,
 UserGroup defaultUserGroup)
            throws ApplicationException

Throws:

ApplicationException

edit

public User edit(User user)
          throws ApplicationException

Overrides:

edit in class AbstractComplexEntityDO<User>

Throws:

ApplicationException

save

public User save(User user,
 DataMap dataMap)
          throws ApplicationException

Description copied from interface: IBaseDO

map data to entity if any, validate and save

Specified by:

save in interface IBaseDO<User>

Overrides:

save in class AbstractEntityBaseDO<User>

Parameters:

user - mandatory

dataMap - optional

Returns:

mapped entity

Throws:

ApplicationException

save

public User save(User user,
 String newPw,
 String newPwRepeat,
 DataMap dataMap)
          throws ApplicationException

Throws:

ApplicationException

passwordChange

public void passwordChange(User user,
 String oldPassword,
 String newPassword,
 String newPasswordRepeat)
                    throws UserException

compare old password, prepare and set new if password is valid

Parameters:

user -

oldPassword - can be encoded if case forgot pw

newPassword -

newPasswordRepeat -

Throws:

UserException - if oldPassword is the wrong password, if passwordRepeat is not same as newPassword, if oldPassword is same as newPassword or if newPassword is too short or if new password is in history (the 3 last passwords)

passwordSet

public void passwordSet(User user,
 String pw)
                 throws UserException

verify and encrypt password, and set in user object if valid

Throws:

UserException - if password is not valid, to short or trivial

passwordValidateLink

public User passwordValidateLink(String changePasswordToken)
                          throws UserException

Throws:

UserException

validateLink

public User validateLink(String tokenToCheck,
 String msgKey)
                  throws UserException

Throws:

UserException

passwordMustBeChanged

public boolean passwordMustBeChanged(User user)

passwordGenerateNew

public String passwordGenerateNew(String login,
 String userIP)
                           throws UserException

generate new password for user with given login and send it an user email if any in profile, else send email to admin, the pw must be changed manual. change key UserProfileKey.PASSWORD_MUST_CHANGE in user profile to true.

Parameters:

login - mandatory

Returns:

message to user

Throws:

UserException

delete

public void delete(User user,
 boolean force)
            throws ApplicationException

Description copied from class: AbstractBaseDO

NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!

Overrides:

delete in class AbstractPrincipalDO<User>

Parameters:

user - mandatory

force - if true delete without usage check, which can result in db constraints error unless references are taken care of

Throws:

ApplicationException

deleteSync

public void deleteSync(User user)
                throws ApplicationException

Final delete of user. Make sure that delete-deny constraints don't exist or are removed beforehand otherwise we get an exception from DB.

Throws:

ApplicationException

getTerritoriesForUser

public List<Territory> getTerritoriesForUser(User user,
 boolean fallbackToAllActive)

getUserProfileValue

public <T extends Serializable> T getUserProfileValue(User user,
 UserProfile.UserProfileKey key,
 Class<T> valueClass)

getUserProfileValueBoolean

public boolean getUserProfileValueBoolean(User user,
 UserProfile.UserProfileKey key)

getUserProfileValueString

public String getUserProfileValueString(User user,
 UserProfile.UserProfileKey key)

setUserProfileValue

public void setUserProfileValue(User user,
 UserProfile.UserProfileKey key,
 Object value)

getFromLoginAndPassword

public User getFromLoginAndPassword(String login,
 String password)
                             throws UserException

get user from login and password: main method used for authenticating user

Parameters:

login - mandatory

password - mandatory

Returns:

user

Throws:

UserException - with appropriate message key if user does not exist or password does not match

unlockAccount

public void unlockAccount(String uid)
                   throws UserException

Check validity of link and unlock the user account

Parameters:

uid - mandatory

Throws:

UserException - the link be expired

UserException

ApplicationException

getSystemUser

public User getSystemUser(UserCredentials systemUserCredentials)
                   throws ApplicationException

Throws:

ApplicationException

isLDAPUser

public boolean isLDAPUser(User user)

Parameters:

user - Any persistent mediacockpit user.

Returns:

true if user is from LDAP. Otherwise false.

newEvent

public UserDO.UserEvent newEvent(mc.core.service.event.Event.IEventType eventType,
 User entity)