ome.services.blitz.repo

Class ManagedImportRequestI

java.lang.Object

Ice.ObjectImpl

omero.cmd.Request

omero.grid.ImportRequest

ome.services.blitz.repo.ManagedImportRequestI

All Implemented Interfaces:

Ice.Object, Serializable, Cloneable, IRequest

public class ManagedImportRequestI
extends omero.grid.ImportRequest
implements IRequest

Wrapper around FilesetJobLink instances which need to be handled on the server-side. This will primarily provide the step-location required by Handle by calling back to the ManagedImportProcessI object.

Since:

5.0.0

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
omero.cmd.HandlePrx	handle Set by ManagedImportProcessI when verifyUpload has been called.

Fields inherited from class omero.grid.ImportRequest

__ids, activity, clientUuid, location, logFile, process, repoUuid, settings

Constructor Summary

Constructors

Constructor and Description
ManagedImportRequestI(Registry reg, TileSizes sizes, RepositoryDao dao, OMEROWrapper wrapper, String token)

Method Summary

Modifier and Type	Method and Description
void	buildResponse(int step, Object object) Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.
void	finish() Method within the transaction boundaries after all processing has occurred.
Object	generateThumbnails(omero.model.ThumbnailGenerationJob tgj)
Map<String,String>	getCallContext() Returns the desired call context for this request.
omero.cmd.Response	getResponse() Returns the current response value.
Map<String,List<omero.model.IObject>>	importMetadata(omero.model.MetadataImportJob mij) Uses the OMEROMetadataStoreClient to save all metadata for the current image provided.
Object	index(omero.model.IndexingJob ij)
void	init(Helper helper) Method called within the transaction boundaries before any processing occurs.
MessageDigest	parseData(String fileName, int series, ImportSize size) Parse the binary data to generate min/max values and allow an md to be calculated.
Object	pixelData(omero.model.PixelDataJob pdj)
protected void	registerKeepAlive() If the setResources(Resources) has been called with a non-null value, then create an Resources.Entry which will ping the ServiceFactoryPrx instance periodically to keep the import from timing out.
Object	script(omero.model.ScriptJob sj)
void	setCallContext(Map<String,String> callContext)
void	setResources(Resources resources) Late injection to not break the constructor
Object	step(int step) Single uncancellable action which will be performed by this IRequest.

Methods inherited from class omero.grid.ImportRequest

__readImpl, __writeImpl, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __collocDispatch, __dispatch, __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

Field Detail

handle

public omero.cmd.HandlePrx handle

Set by ManagedImportProcessI when verifyUpload has been called.

Constructor Detail

ManagedImportRequestI

public ManagedImportRequestI(Registry reg,
                             TileSizes sizes,
                             RepositoryDao dao,
                             OMEROWrapper wrapper,
                             String token)

Method Detail

setResources

public void setResources(Resources resources)

Late injection to not break the constructor

setCallContext

public void setCallContext(Map<String,String> callContext)

Parameters:

callContext - the call context to set

getCallContext

public Map<String,String> getCallContext()

Description copied from interface: IRequest

Returns the desired call context for this request. Some request implementations will require "omero.group":"-1" for example and will hard-code that value. Others may permit users to pass in the desired values which will be merged into the static Map as desired.

Specified by:

getCallContext in interface IRequest

Returns:

the call context for this request

init

public void init(Helper helper)

Description copied from interface: IRequest

Method called within the transaction boundaries before any processing occurs. Implementations must properly initialize the "step" field of the Status object by calling Helper.setSteps(int). This count will define how many times the IRequest.step(int) method will be called. The Helper instance passed in contains those resources needed by IRequests to interact with data and should be stored for later use.

Specified by:

init in interface IRequest

Parameters:

helper - the helper for this request

registerKeepAlive

protected void registerKeepAlive()

If the setResources(Resources) has been called with a non-null value, then create an Resources.Entry which will ping the ServiceFactoryPrx instance periodically to keep the import from timing out. This is especially important for autoClose imports since no other client is likely to keep them alive. If the ping fails, then the Resources.Entry returns null which will remove the instance for the Resources object. Otherwise, during cleanup() remove will be called explicitly.

step

public Object step(int step)

Description copied from interface: IRequest

Single uncancellable action which will be performed by this IRequest. The return value can be an ome.model object that is attached to the current thread and transaction. After processing and detachment from the transaction, the object will be passed to IRequest.buildResponse(int, Object) for conversion and storage.

Specified by:

step in interface IRequest

Parameters:

step - the step number

Returns:

an object to be used in building the response

finish

public void finish()
            throws HandleI.Cancel

Description copied from interface: IRequest

Method within the transaction boundaries after all processing has occurred. A thrown HandleI.Cancel will still rollback the current transaction.

Specified by:

finish in interface IRequest

Throws:

HandleI.Cancel - if this request is cancelled

buildResponse

public void buildResponse(int step,
                          Object object)

Description copied from interface: IRequest

Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.

Specified by:

buildResponse in interface IRequest

Parameters:

step - the step number

object - an object to be used in building the response

getResponse

public omero.cmd.Response getResponse()

Description copied from interface: IRequest

Returns the current response value. This method should be protected by synchronization where necessary, and should never raise an exception. It is also guaranteed to be called so that any state cleanup that is necessary can take place here.

Specified by:

getResponse in interface IRequest

Returns:

the response to this request

importMetadata

public Map<String,List<omero.model.IObject>> importMetadata(omero.model.MetadataImportJob mij)
                                                     throws Throwable

Uses the OMEROMetadataStoreClient to save all metadata for the current image provided.

Parameters:

mij - Object hosting metadata to save.

Returns:

the newly created Pixels id.

Throws:

FormatException - if there is an error parsing metadata.

IOException - if there is an error reading the file.

Throwable

pixelData

public Object pixelData(omero.model.PixelDataJob pdj)
                 throws Throwable

Throws:

Throwable

generateThumbnails

public Object generateThumbnails(omero.model.ThumbnailGenerationJob tgj)
                          throws Throwable

Throws:

Throwable

index

public Object index(omero.model.IndexingJob ij)

script

public Object script(omero.model.ScriptJob sj)

parseData

public MessageDigest parseData(String fileName,
                               int series,
                               ImportSize size)
                        throws FormatException,
                               IOException,
                               omero.ServerError

Parse the binary data to generate min/max values and allow an md to be calculated.

Parameters:

series -

Returns:

The SHA1 message digest for the binary data.

Throws:

FormatException

IOException

omero.ServerError