Initial version for testing

[lnyng]

To run the project in eclipse, add server imagej-server.yml to the program arguments in run configuration. The first token is a dropwizard command to run the server, and the second specifies the name of the configuration file. Also remember to set the tmpDir variable in imagej-server.yml.

APIs (try Postman if not already):

• curl localhost:8080/modules

  Returns a list of modules

• curl localhost:8080/modules/{id}

  Returns detailed information of a module

• curl -XPOST -H "Content-Type: application/json" -d '{"inputMap":{INPUTS}}' localhost:8080/modules/{id}

  Executes a module with inputs from json

• curl -F "file=@PATH/TO/IMAGE" localhost:8080/io/file

  Uploads an image to server. id of the uploaded image will be return in form of {"id":"_img_ID"} The id will be used in module execution to represent the image.

• curl -XPOST localhost:8080/io/_img_ID?ext=EXTENSION

  Request download of image specified by ID. The image will be saved into a file in imagej-server side with EXTENSION. The filename is returned.

• curl localhost:8080/io/FILENAME

  Download the image with FILENAME form the server. The FILENAME must be the return value from the request download API call.

Notes and memo:

• Ops that need to be initialized are not working when run as module. See the HACK in ModulesResource
• The converters from Number to NumericType could be refined and considered moving to other projects such as Scijava.
• The Mixins is the initial attempt for providing json annotation to java types that we could not modify. More Mixins should be implemented for serializing complex types (potentially also for deserializing).
• Do we have better ways to do the I/O? such that no file is needed to store to the disk?
• It might be a good idea for the client to provide optional language-neutral type information for module execution, so that we can support more complex data structures without too much guessing. This would also solve the problem of nested special object (i.e. List<Integer> could not be converted into List<IntType> even with converter between Integer and IntType).
• What test framework should be used?
• Might need to add logging/debug info
• The module information should be improved. The inputs outputs names are not very informative.
• The current design of setting inputs/getting outputs could easily break if those names are changed. Should we just assume they will never change, or should those libraries (i.e. Ops) also take care of all the client implementation?

[ctrueden]

@0x00B1 Could you please have a look and let us know what you think? We think this is getting really close to being usable for calling ImageJ routines from CellProfiler in a nice way!

[ctrueden]

I cleaned up the big commit, splitting out the individual parts. All commits compile with passing tests, so I'm merging it. Much improved master branch! Thanks for your efforts, @lnyng!