public interface IRequest
Request hierarchy. All request implementations
handled by the server must also be instances of IRequest,
which defines the lifecycle methods needed for processing.| Modifier and Type | Method and Description |
|---|---|
void |
buildResponse(int step,
java.lang.Object object)
Post-transaction chance to map from the return value of
step(int) to a Response object. |
void |
finish()
Method within the transaction boundaries after all processing has
occurred.
|
java.util.Map<java.lang.String,java.lang.String> |
getCallContext()
Returns the desired call context for this request.
|
omero.cmd.Response |
getResponse()
Returns the current response value.
|
void |
init(Helper helper)
Method called within the transaction boundaries before any processing occurs.
|
java.lang.Object |
step(int step)
Single uncancellable action which will be performed by this IRequest.
|
java.util.Map<java.lang.String,java.lang.String> getCallContext()
Map as desired.void init(Helper helper) throws HandleI.Cancel
Status object by calling Helper#setSteps(int). This count
will define how many times the {@link #step(int)} method will be called.
The {@link Helper} instance passed in contains those resources needed by
IRequests to interact with data and should be stored for later use.HandleI.Canceljava.lang.Object step(int step)
throws HandleI.Cancel
buildResponse(int, Object) for conversion and storage.i - HandleI.Cancelvoid finish()
throws HandleI.Cancel
HandleI.Cancel will still rollback the current
transaction.HandleI.Cancelvoid buildResponse(int step,
java.lang.Object object)
step(int) to a Response object.i - object - omero.cmd.Response getResponse()