net.bluemind.externaluser.api

Interface IExternalUser

All Known Subinterfaces:

IInCoreExternalUser

All Known Implementing Classes:

ExternalUserService

@Path(value="/externaluser/{domainUid}")
public interface IExternalUser

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String uid, ExternalUser eu) Create an external user
void	delete(java.lang.String uid) Delete an external user
ItemValue<ExternalUser>	getComplete(java.lang.String uid) Retrieve an existing external user
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Returns the list of Group an external user is in
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Returns the list of Group an external user is in
void	update(java.lang.String uid, ExternalUser eu) Modify an existing external user

Method Detail

create

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

Create an external user

Parameters:

uid -

eu -

Throws:

ServerFault

update

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

Modify an existing external user

Parameters:

uid -

eu -

Throws:

ServerFault

delete

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

Delete an external user

Parameters:

uid -

Throws:

ServerFault

getComplete

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

Retrieve an existing external user

Parameters:

uid -

Returns:

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 an external 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 an external user is in

Parameters:

uid -

Returns:

Throws:

ServerFault