net.bluemind.user.service.internal

Class UserService

java.lang.Object

net.bluemind.user.service.internal.UserService

All Implemented Interfaces:

IRestoreDirEntryWithMailboxSupport<User>, IRestoreSupport<User>, IDirEntryExtIdSupport, IDirEntryPhotoSupport, IGroupMember, IInCoreGroupMember, IUser, IInCoreUser

public class UserService
extends java.lang.Object
implements IInCoreUser, IUser

Constructor Summary

Constructors

Constructor and Description
UserService(BmContext context, ItemValue<Domain> domain, Container container, java.util.List<IUserHook> userHooks, java.util.List<IPasswordUpdater> userPasswordUpdaters)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allUids() Retrieve all existing User uids
ItemValue<User>	byEmail(java.lang.String email) Fetches a User by its email
ItemValue<User>	byExtId(java.lang.String extId) Fetches a User by its external id
ItemValue<User>	byLogin(java.lang.String login) Fetches a User by its login
boolean	checkApiKey(java.lang.String userUid, java.lang.String sid)
boolean	checkPassword(java.lang.String login, java.lang.String password)
void	create(java.lang.String uid, User user) Creates a new User with the given uid.
void	createWithExtId(java.lang.String uid, java.lang.String extId, User user) Creates a new User with the given uid.
TaskRef	delete(java.lang.String uid) Deletes a User.
void	deletePhoto(java.lang.String uid) Delete the photo associated to the DirEntry
void	deleteUserIdentitiesForMailbox(java.lang.String mailboxUid)
void	deleteUserIdentitiesForMailbox(java.lang.String userUid, java.lang.String mailboxUid)
java.util.Set<java.lang.String>	directResolvedRoles(java.lang.String uid, java.util.List<java.lang.String> groups)
User	get(java.lang.String uid)
ItemValue<User>	getComplete(java.lang.String uid) Fetches a User by its unique id
ItemValue<User>	getFull(java.lang.String uid)
byte[]	getIcon(java.lang.String uid) Retrieves a User's icon/avatar
byte[]	getPhoto(java.lang.String uid) Retrieve the photo associated to the DirEntry
java.util.Set<java.lang.String>	getResolvedRoles(java.lang.String uid) Retrieves a list of all roles owned by a User.
java.util.Set<java.lang.String>	getRoles(java.lang.String uid) Retrieves a list of all roles directly owned by a User
java.util.Set<java.lang.String>	getUsersWithRoles(java.util.List<java.lang.String> roles) Retrieves a list of all Users owning all of the provided roles
VCard	getVCard(java.lang.String uid) Retrieves a User's contact informations (VCard)
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Retrieves a list of all Groups this uid is member of.
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Retrieves a list of all Group uids this uid is member of.
boolean	passwordUpdateNeeded(java.lang.String login)
void	restore(ItemValue<User> item, boolean isCreate)
void	setExtId(java.lang.String uid, java.lang.String extId) Adds an external id to a DirEntry
void	setPassword(java.lang.String uid, ChangePassword password) Update a User's password
void	setPhoto(java.lang.String uid, byte[] photo) Set a photo, needs to be in PNG format
void	setRoles(java.lang.String uid, java.util.Set<java.lang.String> roles) Sets the User's roles.
void	update(java.lang.String uid, User user) Modifies an existing User
void	updateAccountType(java.lang.String uid, BaseDirEntry.AccountType accountType) Modifies a User's net.bluemind.directory.api.AccountType
void	updatePassword(java.lang.String uid, ChangePassword password)
void	updateVCard(java.lang.String uid, VCard userVCard) Updates a User's contact informations
ValidationResult	validate(java.lang.String[] usersUids) Check that every uid corresponds to an existing group member

Methods inherited from class java.lang.Object

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

Constructor Detail

UserService

public UserService(BmContext context,
                   ItemValue<Domain> domain,
                   Container container,
                   java.util.List<IUserHook> userHooks,
                   java.util.List<IPasswordUpdater> userPasswordUpdaters)
            throws ServerFault

Throws:

ServerFault

Method Detail

create

public void create(java.lang.String uid,
                   User user)
            throws ServerFault

Description copied from interface: IUser

Creates a new User with the given uid. Also creates default calendar, todo elements and the User's mailbox if routing is internal

Specified by:

create in interface IUser

Parameters:

uid - the user's unique id

user - user data

Throws:

ServerFault - standard error object (unchecked exception)

createWithExtId

public void createWithExtId(java.lang.String uid,
                            java.lang.String extId,
                            User user)
                     throws ServerFault

Description copied from interface: IUser

Creates a new User with the given uid. Associates an external id to the User

Specified by:

createWithExtId in interface IUser

Parameters:

uid - the user's unique id

extId - an external id. Usually used to link the user to an external system

user - user data

Throws:

ServerFault - standard error object

update

public void update(java.lang.String uid,
                   User user)
            throws ServerFault

Description copied from interface: IUser

Modifies an existing User

Specified by:

update in interface IUser

Parameters:

uid - the user's unique id

user - the new user values

Throws:

ServerFault - standard error object (unchecked exception)

getFull

public ItemValue<User> getFull(java.lang.String uid)
                        throws ServerFault

Specified by:

getFull in interface IInCoreUser

Throws:

ServerFault

getComplete

public ItemValue<User> getComplete(java.lang.String uid)
                            throws ServerFault

Description copied from interface: IUser

Fetches a User by its unique id

Specified by:

getComplete in interface IUser

Parameters:

uid - the user's unique id

Returns:

the user item value, or null if the user does not exist

Throws:

ServerFault - standard error object (unchecked exception)

byEmail

public ItemValue<User> byEmail(java.lang.String email)
                        throws ServerFault

Description copied from interface: IUser

Fetches a User by its email

Specified by:

byEmail in interface IUser

Parameters:

email - the user's email

Returns:

the user item value, or null if the user does not exist

Throws:

ServerFault - standard error object (unchecked exception)

byLogin

public ItemValue<User> byLogin(java.lang.String login)
                        throws ServerFault

Description copied from interface: IUser

Fetches a User by its login

Specified by:

byLogin in interface IUser

Parameters:

login - the user's login

Returns:

the user item value, or null if the user does not exist

Throws:

ServerFault - standard error object (unchecked exception)

byExtId

public ItemValue<User> byExtId(java.lang.String extId)
                        throws ServerFault

Description copied from interface: IUser

Fetches a User by its external id

Specified by:

byExtId in interface IUser

Parameters:

extId - the user's external id

Returns:

the user item value, or null if the user does not exist

Throws:

ServerFault - standard error object (unchecked exception)

delete

public TaskRef delete(java.lang.String uid)
               throws ServerFault

Description copied from interface: IUser

Deletes a User. Also deletes all user related objects and the user's mailbox

Specified by:

delete in interface IRestoreDirEntryWithMailboxSupport<User>

Specified by:

delete in interface IUser

Parameters:

uid - the user's unique id

Throws:

ServerFault - standard error object (unchecked exception)

passwordUpdateNeeded

public boolean passwordUpdateNeeded(java.lang.String login)

Specified by:

passwordUpdateNeeded in interface IInCoreUser

checkPassword

public boolean checkPassword(java.lang.String login,
                             java.lang.String password)

Specified by:

checkPassword in interface IInCoreUser

checkApiKey

public boolean checkApiKey(java.lang.String userUid,
                           java.lang.String sid)

memberOf

public java.util.List<ItemValue<Group>> memberOf(java.lang.String uid)
                                          throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Groups this uid is member of.

Specified by:

memberOf in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of groups

Throws:

ServerFault - standard error object (unchecked exception)

memberOfGroups

public java.util.List<java.lang.String> memberOfGroups(java.lang.String uid)
                                                throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Group uids this uid is member of.

Specified by:

memberOfGroups in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of Group uids

Throws:

ServerFault - standard error object (unchecked exception)

validate

public ValidationResult validate(java.lang.String[] usersUids)
                          throws ServerFault

Description copied from interface: IInCoreGroupMember

Check that every uid corresponds to an existing group member

Specified by:

validate in interface IInCoreGroupMember

Returns:

Throws:

ServerFault

allUids

public java.util.List<java.lang.String> allUids()
                                         throws ServerFault

Description copied from interface: IUser

Retrieve all existing User uids

Specified by:

allUids in interface IUser

Returns:

a list of all existing User uids

Throws:

ServerFault - standard error object (unchecked exception)

setRoles

public void setRoles(java.lang.String uid,
                     java.util.Set<java.lang.String> roles)
              throws ServerFault

Description copied from interface: IUser

Sets the User's roles. Replaces all existing role assignments

Specified by:

setRoles in interface IUser

Parameters:

uid - the user's unique id

roles - a set of roles to be assigned to the user

Throws:

ServerFault - standard error object (unchecked exception)

getRoles

public java.util.Set<java.lang.String> getRoles(java.lang.String uid)
                                         throws ServerFault

Description copied from interface: IUser

Retrieves a list of all roles directly owned by a User

Specified by:

getRoles in interface IUser

Returns:

a list of roles

Throws:

ServerFault - standard error object (unchecked exception)

getResolvedRoles

public java.util.Set<java.lang.String> getResolvedRoles(java.lang.String uid)
                                                 throws ServerFault

Description copied from interface: IUser

Retrieves a list of all roles owned by a User. Also includes roles indirectly assigned to the User, for example by its Group memberships

Specified by:

getResolvedRoles in interface IUser

Parameters:

uid - the user's unique id

Returns:

a list of roles

Throws:

ServerFault - standard error object (unchecked exception)

directResolvedRoles

public java.util.Set<java.lang.String> directResolvedRoles(java.lang.String uid,
                                                           java.util.List<java.lang.String> groups)
                                                    throws ServerFault

Specified by:

directResolvedRoles in interface IInCoreUser

Throws:

ServerFault

getUsersWithRoles

public java.util.Set<java.lang.String> getUsersWithRoles(java.util.List<java.lang.String> roles)
                                                  throws ServerFault

Description copied from interface: IUser

Retrieves a list of all Users owning all of the provided roles

Specified by:

getUsersWithRoles in interface IUser

Parameters:

roles - a list of roles

Returns:

a list of users owning all provided roles

Throws:

ServerFault - standard error object (unchecked exception)

setPassword

public void setPassword(java.lang.String uid,
                        ChangePassword password)
                 throws ServerFault

Description copied from interface: IUser

Update a User's password

Specified by:

setPassword in interface IUser

Parameters:

uid - user's unique id

password - object containing the current and new password

Throws:

ServerFault - standard error object (unchecked exception)

updatePassword

public void updatePassword(java.lang.String uid,
                           ChangePassword password)
                    throws ServerFault

Throws:

ServerFault

setPhoto

public void setPhoto(java.lang.String uid,
                     byte[] photo)
              throws ServerFault

Description copied from interface: IDirEntryPhotoSupport

Set a photo, needs to be in PNG format

Specified by:

setPhoto in interface IDirEntryPhotoSupport

Parameters:

uid - the directory entry uid

photo - the photo data

Throws:

ServerFault - common error object

deletePhoto

public void deletePhoto(java.lang.String uid)
                 throws ServerFault

Description copied from interface: IDirEntryPhotoSupport

Delete the photo associated to the DirEntry

Specified by:

deletePhoto in interface IDirEntryPhotoSupport

Parameters:

uid - the directory entry uid

Throws:

ServerFault - common error object

getPhoto

public byte[] getPhoto(java.lang.String uid)
                throws ServerFault

Description copied from interface: IDirEntryPhotoSupport

Retrieve the photo associated to the DirEntry

Specified by:

getPhoto in interface IDirEntryPhotoSupport

Parameters:

uid - the directory entry uid

Returns:

the photo data, PNG format

Throws:

ServerFault - common error object

getIcon

public byte[] getIcon(java.lang.String uid)
               throws ServerFault

Description copied from interface: IUser

Retrieves a User's icon/avatar

Specified by:

getIcon in interface IDirEntryPhotoSupport

Specified by:

getIcon in interface IUser

Parameters:

uid - user's unique id

Returns:

a byte array containing an icon in png format

Throws:

ServerFault - standard error object (unchecked exception)

updateVCard

public void updateVCard(java.lang.String uid,
                        VCard userVCard)
                 throws ServerFault

Description copied from interface: IUser

Updates a User's contact informations

Specified by:

updateVCard in interface IUser

Parameters:

uid - user's unique id

userVCard - the new contact informations

Throws:

ServerFault - standard error object (unchecked exception)

getVCard

public VCard getVCard(java.lang.String uid)
               throws ServerFault

Description copied from interface: IUser

Retrieves a User's contact informations (VCard)

Specified by:

getVCard in interface IUser

Parameters:

uid - user's unique id

Returns:

the user's contact informations

Throws:

ServerFault - standard error object (unchecked exception)

deleteUserIdentitiesForMailbox

public void deleteUserIdentitiesForMailbox(java.lang.String mailboxUid)
                                    throws ServerFault

Specified by:

deleteUserIdentitiesForMailbox in interface IInCoreUser

Throws:

ServerFault

deleteUserIdentitiesForMailbox

public void deleteUserIdentitiesForMailbox(java.lang.String userUid,
                                           java.lang.String mailboxUid)
                                    throws ServerFault

Specified by:

deleteUserIdentitiesForMailbox in interface IInCoreUser

Throws:

ServerFault

setExtId

public void setExtId(java.lang.String uid,
                     java.lang.String extId)
              throws ServerFault

Description copied from interface: IDirEntryExtIdSupport

Adds an external id to a DirEntry

Specified by:

setExtId in interface IDirEntryExtIdSupport

Parameters:

uid - the DirEntryQuery's UID

extId - the external id

Throws:

ServerFault - common error object

updateAccountType

public void updateAccountType(java.lang.String uid,
                              BaseDirEntry.AccountType accountType)
                       throws ServerFault

Description copied from interface: IUser

Modifies a User's net.bluemind.directory.api.AccountType

Specified by:

updateAccountType in interface IUser

Parameters:

uid - user's unique id

accountType - the new account type

Throws:

ServerFault - standard error object (unchecked exception)

get

public User get(java.lang.String uid)

Specified by:

get in interface IRestoreSupport<User>

restore

public void restore(ItemValue<User> item,
                    boolean isCreate)

Specified by:

restore in interface IRestoreSupport<User>