Package org.apache.openmeetings.webservice

Class WbWebService

java.lang.Object

org.apache.openmeetings.webservice.BaseWebService

org.apache.openmeetings.webservice.WbWebService

@Service("wbWebService")
@Produces("application/json")
@Path("/wb")
public class WbWebService
extends BaseWebService

WbService contains methods to manipulate whiteboard contents

Field Summary

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

fileDao, roomDao, sessionDao, userDao

Constructor Summary

Constructors

Constructor	Description
WbWebService()

Method Summary

Modifier and Type	Method	Description
ServiceResult	cleanSlide(String sid, long roomId, long wbId, int slide)	This method will do the same as clean slide in the room (except for there will be no UNDO)
ServiceResult	cleanWb(String sid, long roomId, long wbId)	This method will do the same as clean WB in the room (except for there will be no UNDO)
ServiceResult	resetWb(String sid, long id)	This method will remove all whiteboards from given room and create empty one(s) for room files specified
ServiceResult	uploadWb(String sid, String type, String data)	This method will receive WB as binary data (png) and store it to temporary PDF/PNG file unlike other web service methods this one uses internal client sid NOT web service sid

Methods inherited from class java.lang.Object

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

Constructor Detail

WbWebService

public WbWebService()

Method Detail

resetWb

@GET
@Path("/resetwb/{id}")
public ServiceResult resetWb(@QueryParam("sid")
                             String sid,
                             @PathParam("id")
                             long id)
                      throws ServiceException

This method will remove all whiteboards from given room and create empty one(s) for room files specified

Parameters:

sid - - The SID of the User. This SID must be marked as Loggedin

id - - id of the room to clean

Returns:

- serviceResult object with the result

Throws:

ServiceException

cleanWb

@GET
@Path("/cleanwb/{roomid}/{wbid}")
public ServiceResult cleanWb(@QueryParam("sid")
                             String sid,
                             @PathParam("roomid")
                             long roomId,
                             @PathParam("wbid")
                             long wbId)
                      throws ServiceException

This method will do the same as clean WB in the room (except for there will be no UNDO)

Parameters:

sid - - The SID of the User. This SID must be marked as Loggedin

roomId - - id of the room to clean

wbId - - id of the white board to clean

Returns:

- serviceResult object with the result

Throws:

ServiceException

cleanSlide

@GET
@Path("/cleanslide/{roomid}/{wbid}/{slide}")
public ServiceResult cleanSlide(@QueryParam("sid")
                                String sid,
                                @PathParam("roomid")
                                long roomId,
                                @PathParam("wbid")
                                long wbId,
                                @PathParam("slide")
                                int slide)
                         throws ServiceException

This method will do the same as clean slide in the room (except for there will be no UNDO)

Parameters:

sid - - The SID of the User. This SID must be marked as Loggedin

roomId - - id of the room to clean

wbId - - id of the white board to clean

slide - - slide number (zero based)

Returns:

- serviceResult object with the result

Throws:

ServiceException

uploadWb

@POST
@Path("/uploadwb/{type}")
public ServiceResult uploadWb(@QueryParam("sid")
                              String sid,
                              @PathParam("type")
                              String type,
                              @FormParam("data")
                              String data)
                       throws ServiceException

This method will receive WB as binary data (png) and store it to temporary PDF/PNG file unlike other web service methods this one uses internal client sid NOT web service sid

Parameters:

sid - - internal client sid

type - - the type of document being saved PNG/PDF

data - - binary data

Returns:

- serviceResult object with the result

Throws:

ServiceException