Package nl.knaw.dans.lib.util.inbox

Class Inbox

java.lang.Object
org.apache.commons.io.monitor.FileAlterationListenerAdaptor
nl.knaw.dans.lib.util.inbox.Inbox
All Implemented Interfaces:
io.dropwizard.lifecycle.Managed, org.apache.commons.io.monitor.FileAlterationListener
public class Inbox extends org.apache.commons.io.monitor.FileAlterationListenerAdaptor implements io.dropwizard.lifecycle.Managed

A managed inbox that monitors a directory for new files and directories, processes them using a provided task factory, and allows for custom file filtering. A managed inbox that monitors a directory for new files and/or directories, processes them using a provided task factory, and allows for custom file filtering. Note, however, that the inbox does not support recursive monitoring of subdirectories; it only processes files and directories directly within the specified inbox directory.

The inbox can be started and stopped, and it supports initial processing of existing items in the inbox.

  • Method Details

    • start

      public void start() throws Exception
      Specified by:
      start in interface io.dropwizard.lifecycle.Managed
      Throws:
      Exception

    • stop

      public void stop() throws Exception
      Specified by:
      stop in interface io.dropwizard.lifecycle.Managed
      Throws:
      Exception

    • onFileCreate

      public void onFileCreate(File file)
      Specified by:
      onFileCreate in interface org.apache.commons.io.monitor.FileAlterationListener
      Overrides:
      onFileCreate in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

    • onDirectoryCreate

      public void onDirectoryCreate(File directory)
      Specified by:
      onDirectoryCreate in interface org.apache.commons.io.monitor.FileAlterationListener
      Overrides:
      onDirectoryCreate in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

    • onStart

      public void onStart(org.apache.commons.io.monitor.FileAlterationObserver observer)
      Specified by:
      onStart in interface org.apache.commons.io.monitor.FileAlterationListener
      Overrides:
      onStart in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

    • onStop

      public void onStop(org.apache.commons.io.monitor.FileAlterationObserver observer)
      Specified by:
      onStop in interface org.apache.commons.io.monitor.FileAlterationListener
      Overrides:
      onStop in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor