info.sswap.ontologies.exec.api
Interface HotboxPoller

All Known Implementing Classes:
info.sswap.ontologies.exec.impl.ExecImpl, ExecServlet

public interface HotboxPoller

A hotbox poller polls (scans) a directory on a recurring interval (e.g. 5 seconds). If it finds a file in the hotbox directory that is younger (more recent) than an associated file in another directory, the poller initiates a process on the hotbox file.

In the context of the Exec package, a hotbox directory is polled for JSON files. New files are sent to the HTTP API /makeRDG for conversion into RDGs. This allows one to wrap a legcay program as a semantic web service by simply dropping an appropriately parameterized JSON RDG description into the hotbox directory.

Author:
Damian Gessler

Method Summary
 boolean isRunning()
          Check if the hotbox poller is running.
 void setInterval(int sleepSeconds)
          Set the delay interval between directory scans.
 void start()
          Start the hotbox directory polling.
 void stop()
          Stop the hotbox directory polling.
 

Method Detail

start

void start()
Start the hotbox directory polling.


setInterval

void setInterval(int sleepSeconds)
Set the delay interval between directory scans.

Parameters:
sleepSeconds - number of seconds to wait between polling

stop

void stop()
Stop the hotbox directory polling.


isRunning

boolean isRunning()
Check if the hotbox poller is running.

Returns:
true if running; false if stopped; e.g., because it was never started or because it was stopped (interrupted).


Copyright (c) 2011, iPlant Collaborative, University of Arizona, Cold Spring Harbor Laboratories, University of Texas at Austin.