ome.services.blitz.impl

Class ScriptProcessI

java.lang.Object

ome.services.blitz.impl.AbstractAmdServant

ome.services.blitz.impl.ScriptProcessI

All Implemented Interfaces:

_ProcessOperations, _ScriptProcessOperations, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ScriptProcessI
extends AbstractAmdServant
implements _ScriptProcessOperations

Since:

Beta4.2

Field Summary

Fields inherited from class ome.services.blitz.impl.AbstractAmdServant

be, ctx, holder, invoker, service

Constructor Summary

Constructors

Constructor and Description
ScriptProcessI(ServiceFactoryI sf, Ice.Current current, InteractiveProcessorPrx processorPrx, _InteractiveProcessorOperations processor, ProcessPrx process)

Method Summary

Modifier and Type	Method and Description
int	_wait(Ice.Current __current) Blocks until poll() would return a non-null return code.
boolean	cancel(Ice.Current __current) Signal to the Process that it should terminate.
void	close(boolean detach, Ice.Current __current) Closes this process and frees server resources attached to it.
ScriptJob	getJob(Ice.Current __current) Returns the job which started this process.
ScriptProcessPrx	getProxy()
java.util.Map<java.lang.String,RType>	getResults(int waitSecs, Ice.Current __current) Returns the results immediately if present.
boolean	kill(Ice.Current __current) Terminate the Process immediately.
RInt	poll(Ice.Current __current) Returns the return code of the process, or null if unfinished.
void	registerCallback(ProcessCallbackPrx cb, Ice.Current __current) Add a callback for end-of-life events
java.lang.String	setMessage(java.lang.String message, Ice.Current __current) Sets the message on the ScriptJob object.
void	shutdown(Ice.Current __current) First attempts cancel() several times and finally resorts to kill to force the process to shutdown cleanly.
void	unregisterCallback(ProcessCallbackPrx cb, Ice.Current __current) Remove a callback for end-of-life events

Methods inherited from class ome.services.blitz.impl.AbstractAmdServant

activate_async, applyHardWiredInterceptors, callInvokerOnMappedArgs, callInvokerOnRawArgs, executorWorkCall, getCurrentEventContext_async, onSetOmeroContext, passivate_async, runnableCall, safeRunnableCall, setApplicationContext, setHolder

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptProcessI

public ScriptProcessI(ServiceFactoryI sf,
                      Ice.Current current,
                      InteractiveProcessorPrx processorPrx,
                      _InteractiveProcessorOperations processor,
                      ProcessPrx process)
               throws ServerError

Throws:

ServerError

Method Detail

getProxy

public ScriptProcessPrx getProxy()

close

public void close(boolean detach,
                  Ice.Current __current)
           throws ServerError

Description copied from interface: _ScriptProcessOperations

Closes this process and frees server resources attached to it. If the detach argument is True, then the background process will continue executing. The user can reconnect to the process via the IScript service. If the detach argument is False, then the background process will be shutdown immediately, and all intermediate results (stdout, stderr, ...) will be uploaded.

Specified by:

close in interface _ScriptProcessOperations

__current - The Current object for the invocation.

Throws:

ServerError

getJob

public ScriptJob getJob(Ice.Current __current)
                 throws ServerError

Description copied from interface: _ScriptProcessOperations

Returns the job which started this process. Several scheduling fields (submitted, scheduledFor, started, finished) may be of interest.

Specified by:

getJob in interface _ScriptProcessOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getResults

public java.util.Map<java.lang.String,RType> getResults(int waitSecs,
                                                        Ice.Current __current)
                                                 throws ServerError

Description copied from interface: _ScriptProcessOperations

Returns the results immediately if present. If the process is not yet finished, waits "waitSecs" before throwing an ApiUsageException. If poll has returned a non-null value, then this method will always return a non-null value.

Specified by:

getResults in interface _ScriptProcessOperations

__current - The Current object for the invocation.

Throws:

ServerError

setMessage

public java.lang.String setMessage(java.lang.String message,
                                   Ice.Current __current)
                            throws ServerError

Description copied from interface: _ScriptProcessOperations

Sets the message on the ScriptJob object. This value MAY be overwritten by the server if the script fails.

Specified by:

setMessage in interface _ScriptProcessOperations

__current - The Current object for the invocation.

Throws:

ServerError

_wait

public int _wait(Ice.Current __current)
          throws ServerError

Description copied from interface: _ProcessOperations

Blocks until poll() would return a non-null return code.

Specified by:

_wait in interface _ProcessOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

cancel

public boolean cancel(Ice.Current __current)
               throws ServerError

Description copied from interface: _ProcessOperations

Signal to the Process that it should terminate. This may be done "softly" for a given time period.

Specified by:

cancel in interface _ProcessOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

kill

public boolean kill(Ice.Current __current)

Description copied from interface: _ProcessOperations

Terminate the Process immediately.

Specified by:

kill in interface _ProcessOperations

Parameters:

__current - The Current object for the invocation.

poll

public RInt poll(Ice.Current __current)
          throws ServerError

Description copied from interface: _ProcessOperations

Returns the return code of the process, or null if unfinished.

Specified by:

poll in interface _ProcessOperations

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

registerCallback

public void registerCallback(ProcessCallbackPrx cb,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _ProcessOperations

Add a callback for end-of-life events

Specified by:

registerCallback in interface _ProcessOperations

__current - The Current object for the invocation.

Throws:

ServerError

shutdown

public void shutdown(Ice.Current __current)

Description copied from interface: _ProcessOperations

First attempts cancel() several times and finally resorts to kill to force the process to shutdown cleanly. This method doesn't return any value or throw an exception so that it can be called oneway.

Specified by:

shutdown in interface _ProcessOperations

Parameters:

__current - The Current object for the invocation.

unregisterCallback

public void unregisterCallback(ProcessCallbackPrx cb,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _ProcessOperations

Remove a callback for end-of-life events

Specified by:

unregisterCallback in interface _ProcessOperations

__current - The Current object for the invocation.

Throws:

ServerError