omero.grid

Interface _ManagedRepositoryOperations

All Superinterfaces:

_RepositoryOperations

All Known Subinterfaces:

ManagedRepository

All Known Implementing Classes:

_ManagedRepositoryDisp, _ManagedRepositoryTie, ManagedRepositoryI

public interface _ManagedRepositoryOperations
extends _RepositoryOperations

FS-enabled repository which can convert uploaded files into Images by using Bio-Formats to import them.

Method Summary

Modifier and Type	Method and Description
ImportProcessPrx	importFileset(Fileset fs, ImportSettings settings, Ice.Current __current) Returns an ImportProcess which can be used to upload files.
ImportProcessPrx	importPaths(java.util.List<java.lang.String> filePaths, Ice.Current __current) For clients without access to Bio-Formats, the simplified importPaths method allows passing solely the absolute path of the files to be uploaded (no directories) and all configuration happens server-side.
java.util.List<ChecksumAlgorithm>	listChecksumAlgorithms(Ice.Current __current) Return the list of checksum algorithms supported by this repository for verifying the integrity of uploaded files.
java.util.List<ImportProcessPrx>	listImports(Ice.Current __current) List imports that are currently running in this importer.
java.util.List<java.lang.Long>	setChecksumAlgorithm(ChecksumAlgorithm hasher, java.util.List<java.lang.Long> ids, Ice.Current __current) Set the checksum algorithm for the original files identified by the given IDs and calculate their checksum accordingly.
ChecksumAlgorithm	suggestChecksumAlgorithm(java.util.List<ChecksumAlgorithm> supported, Ice.Current __current) Suggest a checksum algorithm to use for ImportSettings.checksumAlgorithm according to the preferences set by the server administrator.
java.util.List<java.lang.Long>	verifyChecksums(java.util.List<java.lang.Long> ids, Ice.Current __current) Verify the checksum for the original files identified by the given IDs.

Methods inherited from interface omero.grid._RepositoryOperations

deletePaths, file, fileById, fileExists, list, listFiles, makeDir, mimetype, register, root, treeList

Method Detail

importFileset

ImportProcessPrx importFileset(Fileset fs,
                               ImportSettings settings,
                               Ice.Current __current)
                        throws ServerError

Returns an ImportProcess which can be used to upload files. On _ImportProcessOperations.verifyUpload(java.util.List<java.lang.String>, Ice.Current), an Handle will be returned which can be watched for knowing when the server-side import is complete. Client paths set in the fileset entries must /-separate their components. Once the upload is complete, the ImportProcess must be closed. Once _HandleOperations.getResponse(Ice.Current) returns a non-null value, the handle instance can and must be closed.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

importPaths

ImportProcessPrx importPaths(java.util.List<java.lang.String> filePaths,
                             Ice.Current __current)
                      throws ServerError

For clients without access to Bio-Formats, the simplified importPaths method allows passing solely the absolute path of the files to be uploaded (no directories) and all configuration happens server-side. Much of the functionality provided via Fileset and ImportSettings is of course lost.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

listImports

java.util.List<ImportProcessPrx> listImports(Ice.Current __current)
                                      throws ServerError

List imports that are currently running in this importer. These will be limited based on user/group membership for the Fileset object which is being created by the import. If the user has write permissions for the fileset, then the import will be included.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

listChecksumAlgorithms

java.util.List<ChecksumAlgorithm> listChecksumAlgorithms(Ice.Current __current)

Return the list of checksum algorithms supported by this repository for verifying the integrity of uploaded files. They are named as ""algorithm-integer"", integer being the bit width of the resulting hash code. It is possible for the same algorithm to be offered with different bit widths. They are listed in descending order of preference, as set by the server administrator, and any of them may be specified for ImportSettings.checksumAlgorithm.

Parameters:

__current - The Current object for the invocation.

suggestChecksumAlgorithm

ChecksumAlgorithm suggestChecksumAlgorithm(java.util.List<ChecksumAlgorithm> supported,
                                           Ice.Current __current)

Suggest a checksum algorithm to use for ImportSettings.checksumAlgorithm according to the preferences set by the server administrator. Provide a list of the algorithms supported by the client, and the server will report which of them is most preferred by the server, or return null if none of them are supported.

Parameters:

__current - The Current object for the invocation.

verifyChecksums

java.util.List<java.lang.Long> verifyChecksums(java.util.List<java.lang.Long> ids,
                                               Ice.Current __current)
                                        throws ServerError

Verify the checksum for the original files identified by the given IDs. The files must be in this repository. Returns the IDs of the original files whose checksums do not match the file on disk.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError

setChecksumAlgorithm

java.util.List<java.lang.Long> setChecksumAlgorithm(ChecksumAlgorithm hasher,
                                                    java.util.List<java.lang.Long> ids,
                                                    Ice.Current __current)
                                             throws ServerError

Set the checksum algorithm for the original files identified by the given IDs and calculate their checksum accordingly. The files must be in this repository. Existing checksums are checked before being changed. If a checksum does not match, ServerError will be thrown; in this case some other files may already have had their checksum algorithm set. Returns the IDs of the original files that did not already have a checksum set for the given algorithm.

Parameters:

__current - The Current object for the invocation.

Throws:

ServerError