Package com.chemaxon.overlap.wui.resources

JAX-RS resource classes exposed by the REST interface.

See: Description

Class Summary

Class	Description
DescriptorsResource	Molecular desciptors JAX-RS resource.
ExperimentalAsyncCallsResource	Async calls REST API endpoint.
ExperimentalRawFilesContentResource	Experimental REST API endpoint for accessing rawfiles.
ExperimentalRawFilesResource	Experimental REST API endpoint for rawfile handling.
ExperimentalResource	Experimental REST API endpoint with various functionalities.
GenerateErrorResponse	Diagnostic resource to generate error response.
GridsResource	Represents generic table resources.
KnnResource	KNN analysis results JAX-RS resource.
MetaResource	Description of available resources.
MolConverter	Expose CXN mol converter functionality for a single molecule.
MoleculesResource	Represents molecule sets.
ProfResResource	Profiling results JAX-RS resource.
StatisticsResource	Simple server statistics.
StatResResource	Execution statistics collection resource.

Package com.chemaxon.overlap.wui.resources Description

JAX-RS resource classes exposed by the REST interface. Notes about error handling/status codes:

• Possible response status codes are documented in the API documentations.
• In case of error the appropriate status code is set and a response (type: com.chemaxon.overlap.wui.resources.exceptions.ErrorReport) with details is returned.
• Error report JSON is returned by the REST API endpoints.

HTTP status codes used by the current version of the REST API (For details see RFC 2616 section 10):

• 200 (OK) is the default status returned when the server state is not modified.
• 500 (Internal Server Error) is the default status returned when an exception is thrown in the server side.
• 400 (Bad Request) when the REST API can not process the malformed request, for example when a passed structure can not be parsed or a format specifier s invalid.
• 404 (Not Found) when the request is syntactically valid but the given resource or representation is not available. For example an absent structure or ID is accessed or a structure ID is out of the range.

See also: http://blogs.mulesoft.com/api-best-practices-response-handling/, http://stackoverflow.com/questions/4687271/jax-rs-how-to-return-json-and-http-status-code-together and http://www.codingpedia.org/ama/error-handling-in-rest-api-with-jersey/.

Further details on error handling can be found in the API documentation of the class WuiExceptionMapper, the class WuiException.