Package org.imixs.workflow.importer

Class DocumentImportController

java.lang.Object
org.imixs.workflow.engine.scheduler.SchedulerController
org.imixs.workflow.importer.DocumentImportController
All Implemented Interfaces:
Serializable
@Named @ViewScoped public class DocumentImportController extends org.imixs.workflow.engine.scheduler.SchedulerController
The DocumentImportController is used to configure the import scheduler.

The configuration is based on the default scheduler

The configuration object holds a item named 'sources'. This item contains a list of options (Map). These source definitions are consumed by ImportObserver implementations. This is an generic extension for custom implementations. There are different import adapters already defined like EmailImportAdapter or the FTPImportAdatper to process a single import source.

Sources are organized in the item 'sources' in a ordered list of Map objects. Internally the map objects are converted into ItemCollection to simplify the handling in JSF forms.

Each source object has a internal index number (pos) to identify the source unique. The sources can be reordered by calling the method up() and down().

Version:
1.0
Author:
rsoika
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.imixs.workflow.ItemCollection
    source
     
    protected List<org.imixs.workflow.ItemCollection>
    sources
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentImportController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSource()
    Adds a new filter option.
    String
    getName()
     
    String
    getSchedulerClass()
    Returns the sepa scheduler class name
    org.imixs.workflow.ItemCollection
    getSource()
    Returns the currently selected source
    List<org.imixs.workflow.ItemCollection>
    getSources()
    Returns a list of all source objects
    void
    init()
    This method initializes the default sync date
    void
    moveSourceDown(int index)
    Moves the current source object one position down in the list of sources
    void
    moveSourceUp(int index)
    Moves the current source object one position up in the list of sources
    void
    removeSource(int index)
    Removes an option by index
    void
    saveConfiguration()
     
    void
    selectSource(int index)
    Selects the current source by index
    void
    setSource(org.imixs.workflow.ItemCollection source)
     
    void
    setSources(List<org.imixs.workflow.ItemCollection> sources)
     

    Methods inherited from class org.imixs.workflow.engine.scheduler.SchedulerController

    getConfiguration, getSchedulerService, millisToShortDHMS, refresh, restartScheduler, setConfiguration, setName, setSchedulerClass, startScheduler, stopScheduler

    Methods inherited from class java.lang.Object

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

  • Field Details

    • sources

      protected List<org.imixs.workflow.ItemCollection> sources

    • source

      protected org.imixs.workflow.ItemCollection source

  • Constructor Details

    • DocumentImportController

      public DocumentImportController()

  • Method Details

    • init

      @PostConstruct public void init()
      This method initializes the default sync date
      Overrides:
      init in class org.imixs.workflow.engine.scheduler.SchedulerController

    • getName

      public String getName()
      Overrides:
      getName in class org.imixs.workflow.engine.scheduler.SchedulerController

    • getSchedulerClass

      public String getSchedulerClass()
      Returns the sepa scheduler class name
      Overrides:
      getSchedulerClass in class org.imixs.workflow.engine.scheduler.SchedulerController

    • saveConfiguration

      public void saveConfiguration()
      Overrides:
      saveConfiguration in class org.imixs.workflow.engine.scheduler.SchedulerController

    • getSources

      public List<org.imixs.workflow.ItemCollection> getSources()
      Returns a list of all source objects
      Returns:

    • setSources

      public void setSources(List<org.imixs.workflow.ItemCollection> sources)

    • getSource

      public org.imixs.workflow.ItemCollection getSource()
      Returns the currently selected source
      Returns:

    • setSource

      public void setSource(org.imixs.workflow.ItemCollection source)

    • addSource

      public void addSource()
      Adds a new filter option. The type of the option (FTP|IMAP) must be specified.

    • selectSource

      public void selectSource(int index)
      Selects the current source by index
      Parameters:
      optionName -

    • removeSource

      public void removeSource(int index)
      Removes an option by index
      Parameters:
      optionName -

    • moveSourceDown

      public void moveSourceDown(int index)
      Moves the current source object one position down in the list of sources
      Parameters:
      optionName -

    • moveSourceUp

      public void moveSourceUp(int index)
      Moves the current source object one position up in the list of sources
      Parameters:
      optionName -