PluginConfigFileReader (IAS release)

java.lang.Object

org.eso.ias.plugin.config.PluginConfigFileReader

All Implemented Interfaces:: PluginConfigGetter

public class PluginConfigFileReader extends Object implements PluginConfigGetter

Read the plugin configuration from a JSON file.

The configuration is read asynchronously by a dedicated thread.

Author:: acaproni

Constructor Summary

Constructors

Constructor

Description

PluginConfigFileReader(BufferedReader reader, String srcName)

Constructor.

PluginConfigFileReader(File file)

Constructor.

PluginConfigFileReader(String resourceName)

Constructor.
Method Summary

Modifier and Type

Method

Description

Future<PluginFileConfig>

getPluginConfig()

Submit the callable to read the JSON file asynchronously.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PluginConfigFileReader
  
  public PluginConfigFileReader(BufferedReader reader, String srcName)
  
  Constructor.
  
  Parameters:
  
  reader - The reader to read the JSON file with the configuration
  
  srcName - The name of the resource
- PluginConfigFileReader
  
  public PluginConfigFileReader(String resourceName) throws PluginConfigException
  
  Constructor.
  
  Parameters:
  
  resourceName - The name of the resource containing the JSON of the configuration
  
  Throws:
  
  PluginConfigException - in case of error accessing the resource
- PluginConfigFileReader
  
  public PluginConfigFileReader(File file) throws PluginConfigException, FileNotFoundException
  
  Constructor.
  
  Parameters:
  
  file - The file with the JSON configuration
  
  Throws:
  
  PluginConfigException - in case of error opening the file
  
  FileNotFoundException - If the passed file is not found
Method Details
- getPluginConfig
  
  public Future<PluginFileConfig> getPluginConfig() throws PluginConfigException
  
  Submit the callable to read the JSON file asynchronously.
  Specified by:
  
  getPluginConfig in interface PluginConfigGetter
  
  Returns:
  
  the Future to get the configuration produced by the thread
  
  Throws:
  
  PluginConfigException - in case of error getting the configuration
  
  See Also:
  
  PluginConfigGetter