PluginBaseConfigFileContext (Plugin Shared 16.24.0-SNAPSHOT API)

All Known Subinterfaces:

IndexConfigProviderContext, PluginBaseConfigContext, PluginGatherContext, SearchLifeCycleContext, SetupContext, StartUrlProviderContext
```
public interface PluginBaseConfigFileContext
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<String>`	`pluginConfigurationFile(String filename)`	Reads a configuration file for the currently running plugin as a UTF-8 String.
`Optional<byte[]>`	`pluginConfigurationFileAsBytes(String filename)`	Reads a configuration file for the currently running plugin.

- Method Detail
  - pluginConfigurationFileAsBytes
```
Optional<byte[]> pluginConfigurationFileAsBytes(String filename)
```
    Reads a configuration file for the currently running plugin. The configuration file read is for the currently running plugin and either the data source or search package the plugin is currently running on. When a plugin is run during a search, this will be the results page (profile) the search is running on. Plugins can not read the configuration files for other plugins.
    
    Parameters:
    
    filename - the name of the configuration file to read.
    
    Returns:
    
    empty if the file doesn't exist, otherwise the contents of the file.
  - pluginConfigurationFile
```
Optional<String> pluginConfigurationFile(String filename)
```
    Reads a configuration file for the currently running plugin as a UTF-8 String. See: pluginConfigurationFileAsBytes(String)
    
    Parameters:
    
    filename - the name of the configuration file to read.
    
    Returns:
    
    empty if the file doesn't exist, otherwise the contents of the file.