com.chemaxon.overlap.wui.resources

Class GenerateErrorResponse

java.lang.Object

com.chemaxon.overlap.wui.resources.GenerateErrorResponse

@Path(value="generate-error-response")
public class GenerateErrorResponse
extends Object

Diagnostic resource to generate error response. The same error response is used in other parts of the API when a request fails.

Constructor Summary

Constructors

Constructor and Description
GenerateErrorResponse()

Method Summary

Modifier and Type	Method and Description
ErrorReport	get(int status, String message) Generate an error report.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateErrorResponse

public GenerateErrorResponse()

Method Detail

get

@GET
 @Produces(value="application/json")
public ErrorReport get(@QueryParam(value="status") @DefaultValue(value="404")
                                                                 int status,
                                                                 @QueryParam(value="message") @DefaultValue(value="This is a diagnostic error response")
                                                                 String message)

Generate an error report.

Parameters:

status - HTTP status to return. When invalid code given "500" (Response.Status#INTERNAL_SERVER_ERROR) is used.

message - Message to return in ErrorReport.message

Returns:

Error response normally returned upon errors