net.bluemind.user.api

Interface IUser

All Superinterfaces:

IDirEntryExtIdSupport, IDirEntryPhotoSupport, IGroupMember, IRestoreDirEntryWithMailboxSupport<User>, IRestoreSupport<User>

All Known Subinterfaces:

IInCoreUser

All Known Implementing Classes:

UserService

@Path(value="/users/{domainUid}")
public interface IUser
extends IDirEntryPhotoSupport, IDirEntryExtIdSupport, IRestoreDirEntryWithMailboxSupport<User>, IGroupMember

User API. {domainUid} corresponds to the fully qualified domain name

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
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.
ItemValue<User>	getComplete(java.lang.String uid) Fetches a User by its unique id
byte[]	getIcon(java.lang.String uid) Retrieves a User's icon/avatar
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) Deprecated. This method may return group entities as well. Use IDirectory.getByRoles(List) instead
VCard	getVCard(java.lang.String uid) Retrieves a User's contact informations (VCard)
void	setPassword(java.lang.String uid, ChangePassword password) Update a User's password
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	updateVCard(java.lang.String uid, VCard userVCard) Updates a User's contact informations

Methods inherited from interface net.bluemind.directory.api.IDirEntryPhotoSupport

deletePhoto, getPhoto, setPhoto

Methods inherited from interface net.bluemind.directory.api.IDirEntryExtIdSupport

setExtId

Methods inherited from interface net.bluemind.core.container.api.IRestoreSupport

get, restore

Methods inherited from interface net.bluemind.group.api.IGroupMember

memberOf, memberOfGroups

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       User user)
                                throws ServerFault

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

Parameters:

uid - the user's unique id

user - user data

Throws:

ServerFault - standard error object (unchecked exception)

createWithExtId

@PUT
 @Path(value="{uid}/{extid}/createwithextid")
void createWithExtId(@PathParam(value="uid")
                                                                        java.lang.String uid,
                                                                        @PathParam(value="extid")
                                                                        java.lang.String extId,
                                                                        User user)
                                                                 throws ServerFault

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

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

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        User user)
                                 throws ServerFault

Modifies an existing User

Parameters:

uid - the user's unique id

user - the new user values

Throws:

ServerFault - standard error object (unchecked exception)

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<User> getComplete(@PathParam(value="uid")
                                                                java.lang.String uid)
                                                         throws ServerFault

Fetches a User by its unique id

Specified by:

getComplete in interface IRestoreDirEntryWithMailboxSupport<User>

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

@GET
 @Path(value="byEmail/{email}")
ItemValue<User> byEmail(@PathParam(value="email")
                                                             java.lang.String email)
                                                      throws ServerFault

Fetches a User by its email

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)

byExtId

@GET
 @Path(value="byExtId/{extid}")
ItemValue<User> byExtId(@PathParam(value="extid")
                                                             java.lang.String extId)
                                                      throws ServerFault

Fetches a User by its external id

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)

byLogin

@GET
 @Path(value="byLogin/{login}")
ItemValue<User> byLogin(@PathParam(value="login")
                                                             java.lang.String login)
                                                      throws ServerFault

Fetches a User by its login

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)

delete

@DELETE
 @Path(value="{uid}")
TaskRef delete(@PathParam(value="uid")
                                             java.lang.String uid)
                                      throws ServerFault

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

Specified by:

delete in interface IRestoreDirEntryWithMailboxSupport<User>

Parameters:

uid - the user's unique id

Throws:

ServerFault - standard error object (unchecked exception)

allUids

@GET
 @Path(value="_alluids")
java.util.List<java.lang.String> allUids()
                                                                throws ServerFault

Retrieve all existing User uids

Returns:

a list of all existing User uids

Throws:

ServerFault - standard error object (unchecked exception)

setRoles

@POST
 @Path(value="{uid}/roles")
void setRoles(@PathParam(value="uid")
                                                java.lang.String uid,
                                                java.util.Set<java.lang.String> roles)
                                         throws ServerFault

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

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)

getUsersWithRoles

@Deprecated
 @POST
 @Path(value="_roleusers")
java.util.Set<java.lang.String> getUsersWithRoles(java.util.List<java.lang.String> roles)
                                                                                         throws ServerFault

Deprecated. This method may return group entities as well. Use IDirectory.getByRoles(List) instead

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

Parameters:

roles - a list of roles

Returns:

a list of users owning all provided roles

Throws:

ServerFault - standard error object (unchecked exception)

getResolvedRoles

@GET
 @Path(value="{uid}/roles_resolved")
java.util.Set<java.lang.String> getResolvedRoles(@PathParam(value="uid")
                                                                                           java.lang.String uid)
                                                                                    throws ServerFault

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

Parameters:

uid - the user's unique id

Returns:

a list of roles

Throws:

ServerFault - standard error object (unchecked exception)

getRoles

@GET
 @Path(value="{uid}/roles")
java.util.Set<java.lang.String> getRoles(@PathParam(value="uid")
                                                                          java.lang.String uid)
                                                                   throws ServerFault

Retrieves a list of all roles directly owned by a User

Parameters:

the - user's unique id

Returns:

a list of roles

Throws:

ServerFault - standard error object (unchecked exception)

setPassword

@POST
 @Path(value="{uid}/password_")
void setPassword(@PathParam(value="uid")
                                                       java.lang.String uid,
                                                       ChangePassword password)
                                                throws ServerFault

Update a User's password

Parameters:

uid - user's unique id

password - object containing the current and new password

Throws:

ServerFault - standard error object (unchecked exception)

getIcon

@GET
 @Path(value="{uid}/icon")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="uid")
                                                                             java.lang.String uid)
                                                                      throws ServerFault

Retrieves a User's icon/avatar

Specified by:

getIcon in interface IDirEntryPhotoSupport

Parameters:

uid - user's unique id

Returns:

a byte array containing an icon in png format

Throws:

ServerFault - standard error object (unchecked exception)

updateVCard

@POST
 @Path(value="{uid}/vcard")
void updateVCard(@PathParam(value="uid")
                                                   java.lang.String uid,
                                                   VCard userVCard)
                                            throws ServerFault

Updates a User's contact informations

Parameters:

uid - user's unique id

userVCard - the new contact informations

Throws:

ServerFault - standard error object (unchecked exception)

getVCard

@GET
 @Path(value="{uid}/vcard")
VCard getVCard(@PathParam(value="uid")
                                                java.lang.String uid)
                                         throws ServerFault

Retrieves a User's contact informations (VCard)

Parameters:

uid - user's unique id

Returns:

the user's contact informations

Throws:

ServerFault - standard error object (unchecked exception)

updateAccountType

@POST
 @Path(value="_updateAccountType/{uid}")
void updateAccountType(@PathParam(value="uid")
                                                                      java.lang.String uid,
                                                                      BaseDirEntry.AccountType accountType)
                                                               throws ServerFault

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

Parameters:

uid - user's unique id

accountType - the new account type

Throws:

ServerFault - standard error object (unchecked exception)