Package org.apache.openmeetings.webservice

Class UserWebService

java.lang.Object

org.apache.openmeetings.webservice.BaseWebService

org.apache.openmeetings.webservice.UserWebService

@Service("userWebService")
@Produces("application/json")
@Path("/user")
public class UserWebService
extends BaseWebService

The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general

Author:

sebawagner

Field Summary

Fields inherited from class org.apache.openmeetings.webservice.BaseWebService

fileDao, roomDao, sessionDao, userDao

Constructor Summary

Constructors

Constructor	Description
UserWebService()

Method Summary

Modifier and Type	Method	Description
UserDTO	add(String sid, UserDTO user, Boolean confirm)	Adds a new User like through the Frontend, but also does activates the Account To do SSO see the methods to create a hash and use those ones!
ServiceResult	delete(String sid, long id)	Delete a certain user by its id
ServiceResult	deleteExternal(String sid, String externalType, String externalId)	Delete a certain user by its external user id
List<UserDTO>	get(String sid)	Lists all users in the system!
ServiceResult	getRoomHash(String sid, ExternalUserDTO user, RoomOptionsDTO options)	Sets the SessionObject for a certain SID, after setting this Session-Object you can use the SID + a RoomId to enter any Room.
ServiceResult	login(String user, String pass)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserWebService

public UserWebService()

Method Detail

login

@GET
@Path("/login")
public ServiceResult login(@QueryParam("user")
                           String user,
                           @QueryParam("pass")
                           String pass)

Parameters:

user - - login or email of Openmeetings user with admin or SOAP-rights

pass - - password

Returns:

- ServiceResult with error code or SID and userId

get

@GET
@Path("/")
public List<UserDTO> get(@QueryParam("sid")
                         String sid)
                  throws ServiceException

Lists all users in the system!

Parameters:

sid - The SID from getSession

Returns:

- list of users

Throws:

ServiceException

add

@POST
@Path("/")
public UserDTO add(@QueryParam("sid")
                   String sid,
                   @FormParam("user")
                   UserDTO user,
                   @FormParam("confirm")
                   Boolean confirm)
            throws ServiceException

Adds a new User like through the Frontend, but also does activates the Account To do SSO see the methods to create a hash and use those ones!

Parameters:

sid - The SID from getSession

user - user object

confirm - whatever or not to send email, leave empty for auto-send

Returns:

- id of the user added or error code

Throws:

ServiceException

delete

@DELETE
@Path("/{id}")
public ServiceResult delete(@QueryParam("sid")
                            String sid,
                            @PathParam("id")
                            long id)
                     throws ServiceException

Delete a certain user by its id

Parameters:

sid - The SID from getSession

id - the openmeetings user id

Returns:

- id of the user deleted, error code otherwise

Throws:

ServiceException

deleteExternal

@DELETE
@Path("/{externaltype}/{externalid}")
public ServiceResult deleteExternal(@QueryParam("sid")
                                    String sid,
                                    @PathParam("externaltype")
                                    String externalType,
                                    @PathParam("externalid")
                                    String externalId)
                             throws ServiceException

Delete a certain user by its external user id

Parameters:

sid - The SID from getSession

externalId - externalUserId

externalType - externalType

Returns:

- id of user deleted, or error code

Throws:

ServiceException

getRoomHash

@POST
@Path("/hash")
public ServiceResult getRoomHash(@QueryParam("sid")
                                 String sid,
                                 @FormParam("user")
                                 ExternalUserDTO user,
                                 @FormParam("options")
                                 RoomOptionsDTO options)
                          throws ServiceException

Sets the SessionObject for a certain SID, after setting this Session-Object you can use the SID + a RoomId to enter any Room. ... Session-Hashs are deleted 15 minutes after the creation if not used.

Parameters:

sid - The SID from getSession

user - user details to set

options - room options to set

Returns:

- secure hash or error code

Throws:

ServiceException