Package org.apache.openmeetings.webservice

Class ErrorWebService

java.lang.Object

org.apache.openmeetings.webservice.BaseWebService

org.apache.openmeetings.webservice.ErrorWebService

@Service("errorWebService")
@Produces("application/json")
@Path("/error")
public class ErrorWebService
extends BaseWebService

The Service contains methods to get localized errors

Author:

solomax

Field Summary

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

fileDao, roomDao, sessionDao, userDao

Constructor Summary

Constructors

Constructor	Description
ErrorWebService()

Method Summary

Modifier and Type	Method	Description
ServiceResult	get(String key, long lang)	loads an Error-Object.
void	report(String sid, String message)	Logs an error to the log file for reporting

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorWebService

public ErrorWebService()

Method Detail

get

@GET
@Path("/{key}/{lang}")
public ServiceResult get(@PathParam("key")
                         String key,
                         @PathParam("lang")
                         long lang)

loads an Error-Object. If a Method returns a negative Result, its an Error-id, it needs a languageId to specify in which language you want to display/read the error-message. English has the Language-ID one, for different one see the list of languages

Parameters:

key - the error key for ex. `error.unknown`

lang - The id of the language

Returns:

- error with the code given

report

@POST
@Path("/report/")
public void report(@QueryParam("sid")
                   String sid,
                   @QueryParam("message")
                   String message)

Logs an error to the log file for reporting

Parameters:

sid - The SID from getSession

message - The message to log