Package org.sensorhub.api.module

Interface IModuleConfigRepository

public interface IModuleConfigRepository

Interface for the module configuration repository.

Since:
Sep 3, 2013

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(ModuleConfig... configList)
    Adds a module configuration to the repository An exception will be thrown if a module with the same id already exist
    void
    close()
    Closes the module config registry and release all resources associated to it
    void
    commit()
    Commits last configuration changes to the persistent store (if any)
    boolean
    contains(String moduleID)
    Checks if A module with the given ID exists
    ModuleConfig
    get(String moduleID)
    Retrieves the configuration of the module with the given id
    List<ModuleConfig>
    getAllModulesConfigurations()
     
    org.sensorhub.impl.module.ModuleClassFinder
    getModuleClassFinder()
     
    void
    remove(String... moduleIDs)
    Removes the module configuration with the given id from the repository
    void
    update(ModuleConfig... configList)
    Updates the module configuration with the given id in the repository If the id does not exist, the configuration entry is added with the add method

  • Method Details

    • getModuleClassFinder

      org.sensorhub.impl.module.ModuleClassFinder getModuleClassFinder()
      Returns:
      module class finder used to instantiate module config classes and implementation classes provided by this repository

    • getAllModulesConfigurations

      List<ModuleConfig> getAllModulesConfigurations()
      Returns:
      list of all modules configuration

    • contains

      boolean contains(String moduleID)
      Checks if A module with the given ID exists
      Parameters:
      moduleID -
      Returns:
      true if the given ID exists in the database

    • get

      ModuleConfig get(String moduleID)
      Retrieves the configuration of the module with the given id
      Parameters:
      moduleID - id of module
      Returns:
      configuration of the module with the given id

    • add

      void add(ModuleConfig... configList)
      Adds a module configuration to the repository An exception will be thrown if a module with the same id already exist
      Parameters:
      configList -

    • update

      void update(ModuleConfig... configList)
      Updates the module configuration with the given id in the repository If the id does not exist, the configuration entry is added with the add method
      Parameters:
      configList -

    • remove

      void remove(String... moduleIDs)
      Removes the module configuration with the given id from the repository
      Parameters:
      moduleIDs -

    • commit

      void commit()
      Commits last configuration changes to the persistent store (if any)

    • close

      void close()
      Closes the module config registry and release all resources associated to it