ome.smuggler.web.imports

Class ImportController

java.lang.Object

ome.smuggler.web.imports.ImportController

@RestController
 @RequestMapping(value="/ome/import")
 @Scope(value="request")
public class ImportController
extends java.lang.Object

Enqueues a message to request OMERO imports.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ImportUrl

Constructor Summary

Constructors

Constructor and Description
ImportController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<java.lang.Object>	enqueue(ImportRequest[] data) Adds the given requests to the import queue.

Methods inherited from class java.lang.Object

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

Field Detail

ImportUrl

public static final java.lang.String ImportUrl

See Also:

Constant Field Values

Constructor Detail

ImportController

public ImportController()

Method Detail

enqueue

@RequestMapping(method=POST,
                consumes="application/json",
                produces="application/json")
public org.springframework.http.ResponseEntity<java.lang.Object> enqueue(@RequestBody
                                                                                                                                                                                                ImportRequest[] data)

Adds the given requests to the import queue.

The requested imports will be queued and will be processed as soon as resources are available; this method returns immediately so that the client doesn't have to wait for the imports to complete.

An outcome notification will be sent to the email address specified in the requests. (For now we assume all requests have the same email address, but going forward this method should work even with possibly unrelated import requests.) This notification is just a one-liner success message when all the submitted data are imported successfully into OMERO. Otherwise, if some of the data failed to import, then a more detailed message is sent that specifies which imports failed and which succeeded.

Each request must contain a valid OMERO session key that the client has acquired before hand; the corresponding OMERO session will be used to import the data and then closed by the server. The same session key may be shared by any of the submitted requests.

This method returns a 200 HTTP message when:

• The input array is null or empty or only contains null elements. In this case the body of the message is a JSON empty array.
• The input array contains some non-null requests and each of them is valid according to the fields specification of ImportRequest. (This method filters out any null element and only processes non-null objects.) The body of the returned message is a JSON-serialised array of ImportResponses, one response for each (non-null) request. Note that the returned response objects may be in a different order than the one of the requests passed into this method's input array.

This method returns a 400 HTTP message when:

• The input array contains some non-null requests but some of them fails validation. In this case, the body of the message is a JSON-serialised instance of Error which details the detected validation errors for each request that didn't pass validation.

Parameters:

data - details what image data to import.

Returns:

either an Error or an array of ImportResponses.