ome.smuggler.web.imports

Class ImportRequest

java.lang.Object

ome.smuggler.web.imports.ImportRequest

public class ImportRequest
extends java.lang.Object

Web clients use instances of this class to request an import. This is just a data transfer object whose sole purpose is to facilitate the transfer of information from the client to the server.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	annotationIds Any optional annotation ID's to attach to the image being imported.
java.lang.String	datasetId If the image is to be imported into an existing OMERO dataset, then this field specifies its ID; leave out otherwise.
java.lang.String	description Optional field for the image or plate description to use.
java.lang.String	experimenterEmail The email address to send an outcome notification to.
java.lang.String	name Optional field for the image or plate name to use.
java.lang.String	omeroHost The hostname or IP address of the machine running the OMERO server in which the data will be imported.
java.lang.String	omeroPort The port of the OMERO server.
java.lang.String	screenId If the image is to be imported into an existing OMERO screen, then this field specifies its ID; leave out otherwise.
java.lang.String	sessionKey Mandatory field to identify the OMERO session to use for the import.
java.lang.String	targetUri The URI of the file or directory containing the data to import.
java.lang.String[][]	textAnnotations Any optional image annotations to attach to the image being imported.

Constructor Summary

Constructors

Constructor and Description
ImportRequest()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

experimenterEmail

public java.lang.String experimenterEmail

The email address to send an outcome notification to. This should normally be the email address of the user who requested the import so that on completion the system can send them an email indicating success or failure to import the data.

targetUri

public java.lang.String targetUri

The URI of the file or directory containing the data to import. This is a mandatory field and must be either

• a "file:" URI pointing to the file on the machine where the data to import sits (if the host part is missing, the path is assumed to be that of a file on the same machine where this server runs); or
• if both client and server run on the same machine, a local path to the data to import.

So the server can handle both local and remote imports. But in the case of a remote import, the client has to specify a file URI with a host part (e.g. file://box/with/fat/file), a suitable remote mount must exist locally (on the same machine where this server runs), and the server needs to be configured so that it can translate remote paths to local ones. This kind of set up can be quite involved, but has the advantage that a single import server can pull image data from multiple acquisition workstations.

See Also:

File URI scheme

omeroHost

public java.lang.String omeroHost

The hostname or IP address of the machine running the OMERO server in which the data will be imported. This is a mandatory field.

omeroPort

public java.lang.String omeroPort

The port of the OMERO server. This is an optional field and must parse to a non-negative integer if specified. Defaults to 4064.

sessionKey

public java.lang.String sessionKey

Mandatory field to identify the OMERO session to use for the import. The client must acquire a session before submitting an import request as this server will never accept user names and passwords to run an import. The server will take care of closing the session.

name

public java.lang.String name

Optional field for the image or plate name to use.

description

public java.lang.String description

Optional field for the image or plate description to use.

datasetId

public java.lang.String datasetId

If the image is to be imported into an existing OMERO dataset, then this field specifies its ID; leave out otherwise. If this field is specified, then it must parse to a non-negative long. Also, this field and the screenId are mutually exclusive, it is only allowed to specify one.

See Also:

screenId

screenId

public java.lang.String screenId

If the image is to be imported into an existing OMERO screen, then this field specifies its ID; leave out otherwise. If this field is specified, then it must parse to a non-negative long. Also, this field and the datasetId are mutually exclusive, it is only allowed to specify one.

See Also:

datasetId

textAnnotations

public java.lang.String[][] textAnnotations

Any optional image annotations to attach to the image being imported. Each entry is an array-stored pair [namespace, text] with both strings having length at least one. Any entry not conforming to this format will cause a validation error.

annotationIds

public java.lang.String[] annotationIds

Any optional annotation ID's to attach to the image being imported. If given, this array must contain a list of values that parse to a non-negative long in order to pass validation.

Constructor Detail

ImportRequest

public ImportRequest()