org.apache.openmeetings.webservice

Class ServerWebService

java.lang.Object

org.apache.openmeetings.webservice.ServerWebService

@Produces(value="application/json")
 @Path(value="/server")
public class ServerWebService
extends Object

This class provides method implementations necessary for OM to manage servers participating in cluster.

Author:

solomax, sebawagner

Constructor Summary

Constructors

Constructor and Description
ServerWebService()

Method Summary

Modifier and Type	Method and Description
ServerDTO	add(String sid, ServerDTO server) Method to add/update server
long	count(String sid) Method to retrieve the total count of the servers participating in cluster
ServiceResult	delete(String sid, long id) Method to delete server
List<ServerDTO>	getServers(String sid, int start, int max) Method to retrieve the list of the servers participating in cluster

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerWebService

public ServerWebService()

Method Detail

getServers

@GET
 @Path(value="/{start}/{max}")
public List<ServerDTO> getServers(@QueryParam(value="sid")
                                                                      String sid,
                                                                      @PathParam(value="start")
                                                                      int start,
                                                                      @PathParam(value="max")
                                                                      int max)
                                                               throws org.apache.openmeetings.webservice.error.ServiceException

Method to retrieve the list of the servers participating in cluster

Parameters:

sid - - session id to identify the user making request

start - - server index to start with

max - - Maximum server count

Returns:

The list of servers participating in cluster

Throws:

org.apache.openmeetings.webservice.error.ServiceException

count

@GET
 @Path(value="/count")
public long count(@QueryParam(value="sid")
                                              String sid)
                                       throws org.apache.openmeetings.webservice.error.ServiceException

Method to retrieve the total count of the servers participating in cluster

Parameters:

sid - - session id to identify the user making request

Returns:

total count of the servers participating in cluster

Throws:

org.apache.openmeetings.webservice.error.ServiceException

add

@POST
 @Path(value="/")
public ServerDTO add(@QueryParam(value="sid")
                                             String sid,
                                             @QueryParam(value="server")
                                             ServerDTO server)
                                      throws org.apache.openmeetings.webservice.error.ServiceException

Method to add/update server

Parameters:

sid - - session id to identify the user making request

server - - server to add/update

Returns:

the id of saved server

Throws:

org.apache.openmeetings.webservice.error.ServiceException

delete

@DELETE
 @Path(value="/{id}")
public ServiceResult delete(@QueryParam(value="sid")
                                                          String sid,
                                                          @PathParam(value="id")
                                                          long id)
                                                   throws org.apache.openmeetings.webservice.error.ServiceException

Method to delete server

Parameters:

sid - - session id to identify the user making request

id - - the id of the server to delete

Returns:

true if the server was deleted, false otherwise

Throws:

org.apache.openmeetings.webservice.error.ServiceException