OmeroBlitz API

omero::grid::ManagedRepository

Overview

[ "ami" ] interface ManagedRepository extends Repository

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

Operation Index

importFileset

Returns an ImportProcess which can be used to upload files.

importPaths

For clients without access to Bio-Formats, the simplified {@code importPaths} method allows passing solely the absolute path of the files to be uploaded (no directories) and all configuration happens server-side.

listImports

List imports that are currently running in this importer.

listChecksumAlgorithms

Return the list of checksum algorithms supported by this repository for verifying the integrity of uploaded files.

suggestChecksumAlgorithm

Suggest a checksum algorithm to use for ImportSettings::checksumAlgorithm according to the preferences set by the server administrator.

verifyChecksums

Verify the checksum for the original files identified by the given IDs.

setChecksumAlgorithm

Set the checksum algorithm for the original files identified by the given IDs and calculate their checksum accordingly.

Operations

ImportProcess* importFileset(model::Fileset fs, ImportSettings settings) throws ServerError

Returns an ImportProcess which can be used to upload files. On ImportProcess::verifyUpload, an cmd::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 cmd::Handle::getResponse returns a non-null value, the handle instance can and must be closed.

ImportProcess* importPaths(api::StringSet filePaths) throws ServerError

For clients without access to Bio-Formats, the simplified {@code 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 model::Fileset and ImportSettings is of course lost.

ImportProcessList listImports() throws ServerError

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

api::ChecksumAlgorithmList listChecksumAlgorithms()

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.

model::ChecksumAlgorithm suggestChecksumAlgorithm(api::ChecksumAlgorithmList supported)

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.

api::LongList verifyChecksums(api::LongList ids) 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.

api::LongList setChecksumAlgorithm(model::ChecksumAlgorithm hasher, api::LongList ids) 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.