12.13.3. Configure Asynchronous Jobs for RESTEasy
This topic covers examples of the query parameters for asynchronous jobs with RESTEasy.
Example 12.18. The Asynch Parameter
asynchquery parameter is used to run invocations in the background. A 202 Accepted response is returned, as well as a Location header with a URL pointing to where the response of the background method is located.
HTTP/1.1 202 Accepted Location: http://example.com/asynch/jobs/3332334
- GET returns the JAX-RS resource method invoked as a response if the job was completed. If the job has not been completed, this GET will return a 202 Accepted response code. Invoking GET does not remove the job, so it can be called multiple times.
- POST does a read of the job response and removes the job if it has been completed.
- DELETE is called to manually clean up the job queue.
NoteWhen the Job queue is full, it will evict the earliest job from memory automatically, without needing to call DELETE.
Example 12.19. Wait / Nowait
nowaitquery parameters. If the
waitparameter is not specified, the operation will default to
nowait=true, and will not wait at all if the job is not complete. The
waitparameter is defined in milliseconds.
Example 12.20. The Oneway Parameter