omero.api

Class _JobHandleDisp

java.lang.Object

Ice.ObjectImpl

omero.api._JobHandleDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _JobHandleOperations, _JobHandleOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, JobHandle, ServiceInterface, StatefulServiceInterface

Direct Known Subclasses:

_JobHandleTie

public abstract class _JobHandleDisp
extends Ice.ObjectImpl
implements JobHandle

Allows submission of asynchronous jobs.

NOTE: The calling order for the service is as follows:

1. submit or attach
2. any of the other methods
3. close

Calling close does not cancel or otherwise change the Job state. See cancelJob.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.JobHandle

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_JobHandleDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___attach(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___cancelJob(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getJob(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___jobError(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___jobFinished(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___jobMessage(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___jobRunning(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___jobStatus(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setMessage(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setStatus(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setStatusAndMessage(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___submit(JobHandle __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
void	activate_async(AMD_StatefulServiceInterface_activate __cb) Load a service implementation from disk if it was previously passivated.
void	attach_async(AMD_JobHandle_attach __cb, long jobId) Returns the current JobStatus for the Job id.
void	cancelJob_async(AMD_JobHandle_cancelJob __cb) Marks a job for cancellation.
void	close_async(AMD_StatefulServiceInterface_close __cb) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
void	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
void	getJob_async(AMD_JobHandle_getJob __cb) Returns the current Job
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
void	jobError_async(AMD_JobHandle_jobError __cb) Returns true if the Job has thrown an error.
void	jobFinished_async(AMD_JobHandle_jobFinished __cb) Returns null if the Job is not finished, otherwise the RTime for when it completed.
void	jobMessage_async(AMD_JobHandle_jobMessage __cb) Returns the current message for job.
void	jobRunning_async(AMD_JobHandle_jobRunning __cb) Returns true if the Job is running, i.e.
void	jobStatus_async(AMD_JobHandle_jobStatus __cb) Returns the current JobStatus.
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb) Causes the blitz server to store the service implementation to disk to free memory.
void	setMessage_async(AMD_JobHandle_setMessage __cb, java.lang.String message) Sets the job's message string, and returns the previous value.
void	setStatus_async(AMD_JobHandle_setStatus __cb, java.lang.String status) Updates the JobStatus for the current job.
void	setStatusAndMessage_async(AMD_JobHandle_setStatusAndMessage __cb, java.lang.String status, RString message) Like setStatus but also sets the message.
void	submit_async(AMD_JobHandle_submit __cb, Job job) Submits a Job and returns its database id.

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface omero.api._JobHandleOperations

attach_async, cancelJob_async, getJob_async, jobError_async, jobFinished_async, jobMessage_async, jobRunning_async, jobStatus_async, setMessage_async, setStatus_async, setStatusAndMessage_async, submit_async

Methods inherited from interface omero.api._StatefulServiceInterfaceOperations

activate_async, close_async, getCurrentEventContext_async, passivate_async

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_JobHandleDisp

public _JobHandleDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

attach_async

public final void attach_async(AMD_JobHandle_attach __cb,
                               long jobId)
                        throws ServerError

Returns the current JobStatus for the Job id.

Specified by:

attach_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ApiUsageException - if the Job does not exist.

ServerError

cancelJob_async

public final void cancelJob_async(AMD_JobHandle_cancelJob __cb)
                           throws ServerError

Marks a job for cancellation. Not every processor will check for the cancelled flag for a running job, but no non-running job will start if it has been cancelled.

Specified by:

cancelJob_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getJob_async

public final void getJob_async(AMD_JobHandle_getJob __cb)
                        throws ServerError

Returns the current Job

Specified by:

getJob_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

jobError_async

public final void jobError_async(AMD_JobHandle_jobError __cb)
                          throws ServerError

Returns true if the Job has thrown an error.

Specified by:

jobError_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

jobFinished_async

public final void jobFinished_async(AMD_JobHandle_jobFinished __cb)
                             throws ServerError

Returns null if the Job is not finished, otherwise the RTime for when it completed.

Specified by:

jobFinished_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

jobMessage_async

public final void jobMessage_async(AMD_JobHandle_jobMessage __cb)
                            throws ServerError

Returns the current message for job. May be set during processing.

Specified by:

jobMessage_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

jobRunning_async

public final void jobRunning_async(AMD_JobHandle_jobRunning __cb)
                            throws ServerError

Returns true if the Job is running, i.e. has an attached process.

Specified by:

jobRunning_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

jobStatus_async

public final void jobStatus_async(AMD_JobHandle_jobStatus __cb)
                           throws ServerError

Returns the current JobStatus. Will never return null.

Specified by:

jobStatus_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setMessage_async

public final void setMessage_async(AMD_JobHandle_setMessage __cb,
                                   java.lang.String message)
                            throws ServerError

Sets the job's message string, and returns the previous value.

Specified by:

setMessage_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setStatus_async

public final void setStatus_async(AMD_JobHandle_setStatus __cb,
                                  java.lang.String status)
                           throws ServerError

Updates the JobStatus for the current job. The previous status is returned as a string. If the status is CANCELLED, this method is equivalent to cancelJob.

Specified by:

setStatus_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setStatusAndMessage_async

public final void setStatusAndMessage_async(AMD_JobHandle_setStatusAndMessage __cb,
                                            java.lang.String status,
                                            RString message)
                                     throws ServerError

Like setStatus but also sets the message.

Specified by:

setStatusAndMessage_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

submit_async

public final void submit_async(AMD_JobHandle_submit __cb,
                               Job job)
                        throws ServerError

Submits a Job and returns its database id. The only fields directly on status which are editable are message, scheduledFor and status. The latter two must be sensible.

Specified by:

submit_async in interface _JobHandleOperationsNC

Parameters:

__cb - The callback object for the operation.

job - Not null

Throws:

ServerError

activate_async

public final void activate_async(AMD_StatefulServiceInterface_activate __cb)
                          throws ServerError

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

Specified by:

activate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

close_async

public final void close_async(AMD_StatefulServiceInterface_close __cb)
                       throws ServerError

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

Specified by:

close_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getCurrentEventContext_async

public final void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb)
                                        throws ServerError

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Specified by:

getCurrentEventContext_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

passivate_async

public final void passivate_async(AMD_StatefulServiceInterface_passivate __cb)
                           throws ServerError

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

Specified by:

passivate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___submit

public static Ice.DispatchStatus ___submit(JobHandle __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___attach

public static Ice.DispatchStatus ___attach(JobHandle __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___getJob

public static Ice.DispatchStatus ___getJob(JobHandle __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___jobStatus

public static Ice.DispatchStatus ___jobStatus(JobHandle __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___jobFinished

public static Ice.DispatchStatus ___jobFinished(JobHandle __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___jobMessage

public static Ice.DispatchStatus ___jobMessage(JobHandle __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___jobRunning

public static Ice.DispatchStatus ___jobRunning(JobHandle __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___jobError

public static Ice.DispatchStatus ___jobError(JobHandle __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___cancelJob

public static Ice.DispatchStatus ___cancelJob(JobHandle __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___setStatus

public static Ice.DispatchStatus ___setStatus(JobHandle __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___setMessage

public static Ice.DispatchStatus ___setMessage(JobHandle __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___setStatusAndMessage

public static Ice.DispatchStatus ___setStatusAndMessage(JobHandle __obj,
                                                        IceInternal.Incoming __inS,
                                                        Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl