omero.cmd

Class HandleI

java.lang.Object

omero.cmd.HandleI

All Implemented Interfaces:

Runnable, omero.cmd._HandleOperations, IHandle, SessionAware, CloseableServant

public class HandleI
extends Object
implements omero.cmd._HandleOperations, IHandle, SessionAware

Servant for the handle proxy from the Command API. This is also a Runnable and is passed to a ThreadPool instance

 Transitions:

      +------------------o [FINISHED]
      |                        o
      |                        |
 (CREATED) ---o READY o===o RUNNING o===o CANCELLING ---o [CANCELLED]
      |           |                           o                o
      |           |---------------------------|                |
      +--------------------------------------------------------+

 

Since:

4.3.2

Author:

Josh Moore, josh at glencoesoftware.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HandleI.Cancel Signals that run() has noticed that the state diagram wants a cancellation or that the Request implementation wishes to stop execution.

Constructor Summary

Constructors

Constructor and Description
HandleI(int cancelTimeoutMs) Create a HandleI (at CREATED in the state diagram) with the given cancel timeout in milliseconds.

Method Summary

Modifier and Type	Method and Description
void	addCallback(omero.cmd.CmdCallbackPrx cb, Ice.Current __current)
boolean	cancel(Ice.Current __current)
void	close(Ice.Current current)
omero.cmd.Request	getRequest(Ice.Current __current)
omero.cmd.Response	getResponse(Ice.Current __current)
omero.cmd.Status	getStatus(Ice.Current __current)
void	initialize(Ice.Identity id, IRequest req, Map<String,String> ctx) Must be called on all instances exactly once before processing.
void	notifyCallbacks() Calls the proper notification on all callbacks based on the current position in the state diagram.
void	removeCallback(omero.cmd.CmdCallbackPrx cb, Ice.Current __current)
void	run() NB: Executes only if at CREATED in the state diagram.
void	setSession(SessionI session)
List<Object>	steps(SqlAction sql, org.hibernate.Session session, ServiceFactory sf)

Methods inherited from class java.lang.Object

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

Constructor Detail

HandleI

public HandleI(int cancelTimeoutMs)

Create a HandleI (at CREATED in the state diagram) with the given cancel timeout in milliseconds.

Parameters:

cancelTimeoutMs - the cancel timeout (in milliseconds)

Method Detail

setSession

public void setSession(SessionI session)
                throws omero.ServerError

Specified by:

setSession in interface SessionAware

Throws:

omero.ServerError

initialize

public void initialize(Ice.Identity id,
                       IRequest req,
                       Map<String,String> ctx)

Description copied from interface: IHandle

Must be called on all instances exactly once before processing.

Specified by:

initialize in interface IHandle

Parameters:

id - Ice identity of this instance. Cannot be null.

req - Request to be processed. Must also be an Request instance.

ctx - Possibly null call context which will be passed to Executor.execute(Map, ome.system.Principal, ome.services.util.Executor.Work)

addCallback

public void addCallback(omero.cmd.CmdCallbackPrx cb,
                        Ice.Current __current)

Specified by:

addCallback in interface omero.cmd._HandleOperations

removeCallback

public void removeCallback(omero.cmd.CmdCallbackPrx cb,
                           Ice.Current __current)

Specified by:

removeCallback in interface omero.cmd._HandleOperations

notifyCallbacks

public void notifyCallbacks()

Calls the proper notification on all callbacks based on the current position in the state diagram. If that is anything other than CANCELLED or FINISHED then CmdCallbackPrx.step(int, int) is called.

getRequest

public omero.cmd.Request getRequest(Ice.Current __current)

Specified by:

getRequest in interface omero.cmd._HandleOperations

getResponse

public omero.cmd.Response getResponse(Ice.Current __current)

Specified by:

getResponse in interface omero.cmd._HandleOperations

getStatus

public omero.cmd.Status getStatus(Ice.Current __current)

Specified by:

getStatus in interface omero.cmd._HandleOperations

cancel

public boolean cancel(Ice.Current __current)
               throws omero.LockTimeout

Specified by:

cancel in interface omero.cmd._HandleOperations

Throws:

omero.LockTimeout

close

public void close(Ice.Current current)

Specified by:

close in interface omero.cmd._HandleOperations

Specified by:

close in interface CloseableServant

run

public void run()

NB: Executes only if at CREATED in the state diagram.

Specified by:

run in interface Runnable

steps

public List<Object> steps(SqlAction sql,
                          org.hibernate.Session session,
                          ServiceFactory sf)
                   throws HandleI.Cancel

Throws:

HandleI.Cancel