IndexConfigProviderContext (Plugin Shared 16.24.0-SNAPSHOT API)

All Superinterfaces:: PluginBaseConfigContext, PluginBaseConfigFileContext, PluginBaseContext

public interface IndexConfigProviderContext
extends PluginBaseContext, PluginBaseConfigContext

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<String>`	`getProfile()`
`Optional<String>`	`getProfileWithView()`	When the plugin is called for a profile, this will be set to the profile and view value which is used in the profile parameter in the modern UI.
`Optional<byte[]>`	`readCollectionConfigFile(String... pathsBelowConf)`	May be used to read a file from the current collection's configuration directory.

Methods inherited from interface com.funnelback.plugin.PluginBaseConfigContext
getConfigKeysMatchingPattern, getConfigKeysWithPrefix, getConfigSetting

Methods inherited from interface com.funnelback.plugin.PluginBaseConfigFileContext
pluginConfigurationFile, pluginConfigurationFileAsBytes

Methods inherited from interface com.funnelback.plugin.PluginBaseContext
getCollectionName, getSearchHome

- Method Detail
  - getProfileWithView
```
Optional<String> getProfileWithView()
```
    When the plugin is called for a profile, this will be set to the profile and view value which is used in the profile parameter in the modern UI. This also matches the profile folder used on disk in the collection configuration.
    
    Returns:
    
    Empty when not running on a profile otherwise the profile and view.
  - getProfile
```
Optional<String> getProfile()
```
    Returns:
    
    Empty when not running on a profile otherwise the profile this is being run.
  - readCollectionConfigFile
```
Optional<byte[]> readCollectionConfigFile(String... pathsBelowConf)
                                   throws IOException
```
    May be used to read a file from the current collection's configuration directory.
    
    Parameters:
    
    pathsBelowConf - The path below the current collection's configuration directory e.g. List.of("collection.cfg") to read $SEARCH_HOME/conf/$COLLECTION/collection.cfg
    
    Returns:
    
    if the file is present the bytes of that file, otherwise empty.
    
    Throws:
    
    IOException