omero.grid

Interface _ImportProcessOperations

All Superinterfaces:

_ServiceInterfaceOperations, _StatefulServiceInterfaceOperations

All Known Subinterfaces:

ImportProcess

All Known Implementing Classes:

_ImportProcessDisp, _ImportProcessTie, ManagedImportProcessI

public interface _ImportProcessOperations
extends _StatefulServiceInterfaceOperations

User configuration options. These are likely set in the UI before the import is initiated.

Method Summary

Modifier and Type	Method and Description
HandlePrx	getHandle(Ice.Current __current) Reacquire the handle which was returned by verifyUpload.
ImportSettings	getImportSettings(Ice.Current __current)
RawFileStorePrx	getUploader(int i, Ice.Current __current) Step 1: Returns a RawFileStore that can be used to upload one of the used files.
long	getUploadOffset(int i, Ice.Current __current) In case an upload must be resumed, this provides the location of the last successful upload.
HandlePrx	verifyUpload(java.util.List<java.lang.String> hash, Ice.Current __current) Step 2: Passes a set of client-side calculated hashes to the server for verifying that all of the files were correctly uploaded.

Methods inherited from interface omero.api._StatefulServiceInterfaceOperations

activate_async, close_async, getCurrentEventContext_async, passivate_async

Method Detail

getUploader

RawFileStorePrx getUploader(int i,
                            Ice.Current __current)
                     throws ServerError

Step 1: Returns a RawFileStore that can be used to upload one of the used files. The index is the same as the used file listed in ImportLocation. omero.api.RawFileStore.close should be called once all data has been transferred. If the file must be re-written, call getUploader with the same index again. Once all uploads have been completed, verifyUpload should be called to initiate background processing

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

verifyUpload

HandlePrx verifyUpload(java.util.List<java.lang.String> hash,
                       Ice.Current __current)
                throws ServerError

Step 2: Passes a set of client-side calculated hashes to the server for verifying that all of the files were correctly uploaded. If this passes then a Handle proxy is returned, which completes all the necessary import steps. A successful import will return an ImportResponse. Otherwise, some ERR will be returned.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getUploadOffset

long getUploadOffset(int i,
                     Ice.Current __current)
              throws ServerError

In case an upload must be resumed, this provides the location of the last successful upload.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getHandle

HandlePrx getHandle(Ice.Current __current)
             throws ServerError

Reacquire the handle which was returned by verifyUpload. This is useful in case a new client is re-attaching to a running import. From the Handle instance, the original ImportRequest can also be found.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

getImportSettings

ImportSettings getImportSettings(Ice.Current __current)