Class 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
    • Constructor Summary

      Constructors 
      Constructor Description
      UserWebService()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.openmeetings.db.dto.user.UserDTO add​(java.lang.String sid, org.apache.openmeetings.db.dto.user.UserDTO user, java.lang.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!
      org.apache.openmeetings.db.dto.basic.ServiceResult delete​(java.lang.String sid, long id)
      Delete a certain user by its id
      org.apache.openmeetings.db.dto.basic.ServiceResult deleteExternal​(java.lang.String sid, java.lang.String externalType, java.lang.String externalId)
      Delete a certain user by its external user id
      java.util.List<org.apache.openmeetings.db.dto.user.UserDTO> get​(java.lang.String sid)
      Lists all users in the system!
      org.apache.openmeetings.db.dto.basic.ServiceResult getRoomHash​(java.lang.String sid, org.apache.openmeetings.db.dto.user.ExternalUserDTO user, org.apache.openmeetings.db.dto.room.RoomOptionsDTO options)
      Description: sets the SessionObject for a certain SID, after setting this Session-Object you can use the SID + a RoomId to enter any Room.
      org.apache.openmeetings.db.dto.basic.ServiceResult login​(java.lang.String user, java.lang.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 org.apache.openmeetings.db.dto.basic.ServiceResult login​(@QueryParam("user")
                                                                        java.lang.String user,
                                                                        @QueryParam("pass")
                                                                        java.lang.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 java.util.List<org.apache.openmeetings.db.dto.user.UserDTO> get​(@QueryParam("sid")
                                                                               java.lang.String sid)
        Lists all users in the system!
        Parameters:
        sid - The SID from getSession
        Returns:
        - list of users
      • add

        @POST
        @Path("/")
        public org.apache.openmeetings.db.dto.user.UserDTO add​(@QueryParam("sid")
                                                               java.lang.String sid,
                                                               @FormParam("user")
                                                               org.apache.openmeetings.db.dto.user.UserDTO user,
                                                               @FormParam("confirm")
                                                               java.lang.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!
        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
      • delete

        @DELETE
        @Path("/{id}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult delete​(@QueryParam("sid")
                                                                         java.lang.String sid,
                                                                         @PathParam("id")
                                                                         long id)
        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
      • deleteExternal

        @DELETE
        @Path("/{externaltype}/{externalid}")
        public org.apache.openmeetings.db.dto.basic.ServiceResult deleteExternal​(@QueryParam("sid")
                                                                                 java.lang.String sid,
                                                                                 @PathParam("externaltype")
                                                                                 java.lang.String externalType,
                                                                                 @PathParam("externalid")
                                                                                 java.lang.String externalId)
        Delete a certain user by its external user id
        Parameters:
        sid - The SID from getSession
        externalId - externalUserId
        externalType - externalUserId
        Returns:
        - id of user deleted, or error code
      • getRoomHash

        @POST
        @Path("/hash")
        public org.apache.openmeetings.db.dto.basic.ServiceResult getRoomHash​(@QueryParam("sid")
                                                                              java.lang.String sid,
                                                                              @FormParam("user")
                                                                              org.apache.openmeetings.db.dto.user.ExternalUserDTO user,
                                                                              @FormParam("options")
                                                                              org.apache.openmeetings.db.dto.room.RoomOptionsDTO options)
        Description: 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