Package uk.ac.manchester.spinnaker.alloc.web

Class BackgroundSupport

java.lang.Object

uk.ac.manchester.spinnaker.alloc.web.BackgroundSupport

Direct Known Subclasses:

SpallocServiceImpl

public abstract class BackgroundSupport
extends Object

Enables a web service class to move processing a request into a background task easily.

Author:

Donal Fellows

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	BackgroundSupport.BackgroundAction	An action that produces a response, usually handled asynchronously.

Constructor Summary

Constructors

Constructor	Description
BackgroundSupport()

Method Summary

Modifier and Type	Method	Description
protected void	bgAction(jakarta.ws.rs.container.AsyncResponse response, Permit permit, BackgroundSupport.BackgroundAction action)	Run the action in the background and wrap it into the response when it completes.
protected void	bgAction(jakarta.ws.rs.container.AsyncResponse response, BackgroundSupport.BackgroundAction action)	Run the action in the background and wrap it into the response when it completes.
protected static void	fgAction(jakarta.ws.rs.container.AsyncResponse response, BackgroundSupport.BackgroundAction action)	Run the action immediately and wrap it into the response.

Methods inherited from class java.lang.Object

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

Constructor Details

BackgroundSupport

public BackgroundSupport()

Method Details

bgAction

protected void bgAction(jakarta.ws.rs.container.AsyncResponse response,
 BackgroundSupport.BackgroundAction action)

Run the action in the background and wrap it into the response when it completes.

Parameters:

response - The asynchronous response.

action - The action that generates a Response

bgAction

protected void bgAction(jakarta.ws.rs.container.AsyncResponse response,
 Permit permit,
 BackgroundSupport.BackgroundAction action)

Run the action in the background and wrap it into the response when it completes.

Parameters:

response - The asynchronous response.

permit - The permissions granted to the asynchronous task from the context that asked for it to happen.

action - The action that generates a Response

fgAction

protected static void fgAction(jakarta.ws.rs.container.AsyncResponse response,
 BackgroundSupport.BackgroundAction action)

Run the action immediately and wrap it into the response.

Parameters:

response - The asynchronous response.

action - The action that generates a Response