Dicoogle Plugin - Sample

This is a Dicoogle plugin to serve as an example. Those that are interested in developing a new plugin may use this one as a template.

Getting Started

Installing and running Dicoogle

1. Make sure that you have Java installed in your system. Versions 8 and 11 are known to work.
2. Go to https://www.dicoogle.com/downloads and get version 3 of Dicoogle
3. Extract your contents to its own directory (e.g. "~/dicoogle" or "C:\dicoogle", depending on the platform).
4. Run Dicoogle with: sh DicoogleClient.sh (OSX / Linux) or DicoogleClient.bat (Windows).
5. You should see your web browser opening the Dicoogle user interface. Is it running? You're ok!

Downloading and building the plugin

Maven is required in order to build the project. An IDE with Maven support such as Netbeans may also help.

1. Clone the git repository at https://github.com/bioinformatics-ua/dicoogle-plugin-sample.git

2. Go to the project's base directory in a command line and run mvn package. Alternatively, open the Maven project of the plugin with your IDE, then force it to build your project.

3. If the building task is successful, you will have a new shaded jar (with the necessary dependencies) in the target folder (e.g. target/dicoogle-plugin-sample-3.1.0.jar)

Developing your own plugin based on this sample

The first class to look into is RSIPluginSet. It is the main entry point for everything else. Once modified to suit your needs, build the plugin again and re-deploy it to Dicoogle (see below).

Be sure to consult the Dicoogle Learning Pack for more information.

Using your plugin

1. Copy your plugin's built jar (target/dicoogle-plugin-sample-3.1.0.jar) to the "Plugins" folder inside the root folder of Dicoogle.

2. Run Dicoogle. The plugin will be automatically included.

Available content

• RSIIndexer : a sample indexer, only logs the DIM contents of files
• RSIStorage : a sample storage service, keeps files in memory buffers
• RSIQuery : a sample query provider, returns random data on request
• RSIJettyPlugin : a sample plugin for providing web services, holds RSIWebService
• RSIWebService : a sample web service in the form of a servlet, serves a web page and a few other services
• RSIRestPlugin : a sample Restlet server resource, provides dummy data
• Sample HTML5 content and consuming web service: helps you to build a web app

Web service plugin sample and Web App:

To test the webservice plugin, you may open your browser and navigate to these URLs:

• http://localhost:8080/sample/hello?uid=1111
• http://localhost:8080/dashboardSample
• http://localhost:8080/ext/dicoogle-test (restlet)

You may also use the built-in Dicoogle services for testing other plugins:

• GET http://localhost:8080/search?query=test&provider=dicoogle-plugin-sample to test the query provider
  • Note: You will need to record dicoogle-plugin-sample as a DIM provider first. In confs/server.xml, add the query provider in config/archive/dim-providers like this:

    <config>
      <!-- ... -->
      <archive>
        <!-- ... -->
        <dim-providers>
          <dim-provider>dicoogle-plugin-sample</dim-provider>
        </dim-providers>
        <!-- ... -->

    Then restart Dicoogle. Remember to remove the provider from the list after testing if you do not want to keep it.
• POST http://localhost:8080/management/tasks/index?plugin=dicoogle-plugin-sample&uri=<file:/path/to/DICOM/dir> to test the indexer

Platforms

Dicoogle has been tested in:

• Windows
• Linux
• Mac OS X

For more information, please visit https://www.dicoogle.com