net.bluemind.user.api

Interface IUser

All Superinterfaces:

IDirEntryExtIdSupport, IDirEntryPhotoSupport

All Known Subinterfaces:

IInCoreUser

All Known Implementing Classes:

UserService

@Path(value="/users/{domainUid}")
public interface IUser
extends IDirEntryPhotoSupport, IDirEntryExtIdSupport

User API. BlueMind provides client and server implementations of this interface. This API manipulates User items in a users_[domainUid] container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IUser.DiagnosticReportCheckId

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allUids() Returns all the items uid from the container
ItemValue<User>	byEmail(java.lang.String email) Fetches a User item from the database with its email.
ItemValue<User>	byExtId(java.lang.String extId) Fetches a User item from the database with its external ID.
ItemValue<User>	byLogin(java.lang.String login) Fetches a User item from the database with its login.
TaskRef	check(java.lang.String uid) Deprecated.
TaskRef	checkAll() Deprecated.
TaskRef	checkAndRepair(java.lang.String uid) Deprecated.
TaskRef	checkAndRepairAll() Deprecated.
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) Create user with external ID
TaskRef	delete(java.lang.String uid) Deletes a User item from the database.
ItemValue<User>	getComplete(java.lang.String uid) Fetches a User item from the database with its uid.
byte[]	getIcon(java.lang.String uid)
java.util.Set<java.lang.String>	getResolvedRoles(java.lang.String uid)
java.util.Set<java.lang.String>	getRoles(java.lang.String uid)
java.util.Set<java.lang.String>	getUsersWithRoles(java.util.List<java.lang.String> roles)
VCard	getVCard(java.lang.String uid)
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Returns the list of Group a user is in
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Returns the list of Group a user is in
void	setPassword(java.lang.String uid, ChangePassword password)
void	setRoles(java.lang.String uid, java.util.Set<java.lang.String> roles)
void	update(java.lang.String uid, User user) Modifies a user with the given uid.
void	updateAccountType(java.lang.String uid, BaseDirEntry.AccountType accountType)
void	updateVCard(java.lang.String uid, VCard userVCard)

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

deletePhoto, getPhoto, setPhoto

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

setExtId

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. The User is created in the database and IUserHook implementations are invoked.

Parameters:

uid -

user -

Throws:

ServerFault

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

Create user with external ID

Parameters:

uid -

extId -

user -

Throws:

ServerFault

update

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

Modifies a user with the given uid. The User is updated in the database and IUserHook implementations are invoked.

Parameters:

uid -

user -

Throws:

ServerFault

getComplete

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

Fetches a User item from the database with its uid.

Parameters:

uid -

Returns:

Throws:

ServerFault

byEmail

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

Fetches a User item from the database with its email.

Parameters:

uid -

Returns:

Throws:

ServerFault

byExtId

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

Fetches a User item from the database with its external ID.

Parameters:

uid -

Returns:

Throws:

ServerFault

byLogin

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

Fetches a User item from the database with its login.

Parameters:

uid -

Returns:

Throws:

ServerFault

delete

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

Deletes a User item from the database. IUserHook implementations are invoked.

Parameters:

uid -

Throws:

ServerFault

memberOf

@GET
 @Path(value="{uid}/groups")
java.util.List<ItemValue<Group>> memberOf(@PathParam(value="uid")
                                                                            java.lang.String uid)
                                                                     throws ServerFault

Returns the list of Group a user is in

Parameters:

uid -

Returns:

Throws:

ServerFault

memberOfGroups

@GET
 @Path(value="{uid}/groupUids")
java.util.List<java.lang.String> memberOfGroups(@PathParam(value="uid")
                                                                                     java.lang.String uid)
                                                                              throws ServerFault

Returns the list of Group a user is in

Parameters:

uid -

Returns:

Throws:

ServerFault

allUids

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

Returns all the items uid from the container

Returns:

Throws:

ServerFault

setRoles

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

Throws:

ServerFault

getUsersWithRoles

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

Throws:

ServerFault

getResolvedRoles

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

Throws:

ServerFault

getRoles

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

Throws:

ServerFault

setPassword

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

Throws:

ServerFault

getIcon

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

Specified by:

getIcon in interface IDirEntryPhotoSupport

Throws:

ServerFault

check

@POST
 @Path(value="{uid}/_check")
 @Deprecated
TaskRef check(@PathParam(value="uid")
                                                              java.lang.String uid)
                                                       throws ServerFault

Deprecated.

Use IDirEntryMaintenance

 
 IDirEntryMaintenance.check(
        IDirEntryMaintenance.getAvailableOperations()
                .stream().map(mo -> mo.identifier)
                .collect(Collectors.toSet()));
 
 

Throws:

ServerFault

checkAndRepair

@POST
 @Path(value="{uid}/_check-and-repair")
 @Deprecated
TaskRef checkAndRepair(@PathParam(value="uid")
                                                                                  java.lang.String uid)
                                                                           throws ServerFault

Deprecated.

Use IDirEntryMaintenance.repair(Set)

 
 IDirEntryMaintenance.repair(
        IDirEntryMaintenance.getAvailableOperations()
                .stream().map(mo -> mo.identifier)
                .collect(Collectors.toSet()));
 
 

Throws:

ServerFault

checkAll

@POST
 @Path(value="_check-all")
 @Deprecated
TaskRef checkAll()
                                                        throws ServerFault

Deprecated.

Use IDirEntryMaintenance.check(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
 for (String userUid: IUser.allUids()) {
        IDirEntryMaintenance.check(opsIds);
 }
 
 

Throws:

ServerFault

checkAndRepairAll

@POST
 @Path(value="_check-and-repair-all")
 @Deprecated
TaskRef checkAndRepairAll()
                                                                            throws ServerFault

Deprecated.

Use IDirEntryMaintenance.repair(Set)

 
  Set<String> opsIds = IDirEntryMaintenance.getAvailableOperations()
                                        .stream().map(mo -> mo.identifier)
                                        .collect(Collectors.toSet());
 
 for (String userUid: IUser.allUids()) {
        IDirEntryMaintenance.repair(opsIds);
 }
 
 

Throws:

ServerFault

updateVCard

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

Throws:

ServerFault

getVCard

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

Throws:

ServerFault

updateAccountType

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

Throws:

ServerFault