com.chemaxon.overlap.wui.resources

Class ExperimentalAsyncCallsResource

java.lang.Object

com.chemaxon.overlap.wui.resources.ExperimentalAsyncCallsResource

@Path(value="experimental-async-calls")
public class ExperimentalAsyncCallsResource
extends Object

Async calls REST API endpoint. (Experimental currently) Represents the status of launched asynchronous calls, including their progress, results and partial results. Please note that endpoints of this resource are expected to be changed in an incompatible way in any of the future releases.

Constructor Summary

Constructors

Constructor and Description
ExperimentalAsyncCallsResource()

Method Summary

Modifier and Type	Method and Description
void	cancel(String id) Sets the cancel request state.
AsyncCallDto	get(String id, boolean needPartialResult) Status of an asynchronous call.
List<String>	getIds() List of asynchronous call IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimentalAsyncCallsResource

public ExperimentalAsyncCallsResource()

Method Detail

get

@GET
 @Path(value="/{id}")
 @Produces(value="application/json")
public AsyncCallDto get(@PathParam(value="id")
                                                                                        String id,
                                                                                        @QueryParam(value="need-partial-result") @DefaultValue(value="false")
                                                                                        boolean needPartialResult)

Status of an asynchronous call.

Parameters:

id - ID of the asynchronous call. ID is assigned by the REST API endpoint used to launch the asynchronous task.

needPartialResult - if true then result may contain partial result.

Returns:

Call status. The returned object's result and partialResult fields depend on the represented task. Type of these fields are determined by the REST API endpoint used to launch the task.

Throws:

RuntimeException - directly from from call if failed

cancel

@POST
 @Path(value="/{id}/cancel")
public void cancel(@PathParam(value="id")
                                                      String id)

Sets the cancel request state. NOTE: This does not guarantee that the call will be actually cancelled/terminated.

Parameters:

id - ID of the asynchronous call. ID is assigned by the REST API endpoint used to launch the asynchronous task.

getIds

@GET
 @Path(value="ids")
 @Produces(value="application/json")
public List<String> getIds()

List of asynchronous call IDs.

Returns:

List of allocated IDs

Throws:

WuiForbiddenException - When async call ID listing is disabled (See ServerFeature.ASYNC_CALL_ID_LIST).