Package com.funnelback.plugin.index.mock

Class MockIndexConfigProviderContext

java.lang.Object

com.funnelback.plugin.index.mock.MockIndexConfigProviderContext

All Implemented Interfaces:

PluginConfigurationFileSettingMock, com.funnelback.plugin.index.IndexConfigProviderContext, com.funnelback.plugin.PluginBaseConfigContext, com.funnelback.plugin.PluginBaseConfigFileContext, com.funnelback.plugin.PluginBaseContext

public class MockIndexConfigProviderContext
extends Object
implements com.funnelback.plugin.index.IndexConfigProviderContext, PluginConfigurationFileSettingMock

A mock IndexConfigProviderContext that may be used when testig the IndexingConfigProvider. Example:

 MockIndexConfigProviderContext mockContext = new MockIndexConfigProviderContext();
 // Set collection or profile config setting 'foo=bar'.
 mockContext.setConfigSetting("foo", "bar");
 
 // This conext is for a profile and the method being tested needs to know the
 // profile name, so set that with the mock.
 mockContext.setProfile(Optional.of("dummy-profile"));
 

Field Summary

Fields

Modifier and Type	Field	Description
private String	collectionName
private MapBackedConfig	mapBackedConfig
private MapBackedPluginConfigurationFiles	mapBackedPluginConfigurationFiles
private @NonNull Optional<String>	profile
private @NonNull Optional<String>	profileWithView
private File	searchHome

Constructor Summary

Constructors

Constructor	Description
MockIndexConfigProviderContext()

Method Summary

Modifier and Type	Method	Description
String	getCollectionName()
Set<String>	getConfigKeys()
Map<String,List<String>>	getConfigKeysMatchingPattern(String pattern)
Set<String>	getConfigKeysWithPrefix(String prefix)
String	getConfigSetting(String key)
@NonNull Optional<String>	getProfile()
@NonNull Optional<String>	getProfileWithView()
File	getSearchHome()
Optional<String>	pluginConfigurationFile(String filename)
Optional<byte[]>	pluginConfigurationFileAsBytes(String filename)
Optional<byte[]>	readCollectionConfigFile(String... pathsBelowConf)
void	setCollectionName(String collectionName)
void	setConfigSetting(String key, String value)
void	setPlugingConfigurationFileContent(String filename, String content)	Sets the content of a plugin configuration file on the mock.
void	setPlugingConfigurationFileContentAsBytes(String filename, byte[] content)	Sets the content of a plugin configuration file on the mock.
void	setProfile(@NonNull Optional<String> profile)
void	setProfileWithView(@NonNull Optional<String> profileWithView)
void	setSearchHome(File searchHome)

Methods inherited from class java.lang.Object

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

Field Detail

searchHome

private File searchHome

collectionName

private String collectionName

profileWithView

@NonNull
private @NonNull Optional<String> profileWithView

profile

@NonNull
private @NonNull Optional<String> profile

mapBackedConfig

private final MapBackedConfig mapBackedConfig

mapBackedPluginConfigurationFiles

private final MapBackedPluginConfigurationFiles mapBackedPluginConfigurationFiles

Constructor Detail

MockIndexConfigProviderContext

public MockIndexConfigProviderContext()

Method Detail

readCollectionConfigFile

public Optional<byte[]> readCollectionConfigFile(String... pathsBelowConf)
                                          throws IOException

Specified by:

readCollectionConfigFile in interface com.funnelback.plugin.index.IndexConfigProviderContext

Throws:

IOException

getSearchHome

public File getSearchHome()

Specified by:

getSearchHome in interface com.funnelback.plugin.PluginBaseContext

setSearchHome

public void setSearchHome(File searchHome)

getCollectionName

public String getCollectionName()

Specified by:

getCollectionName in interface com.funnelback.plugin.PluginBaseContext

setCollectionName

public void setCollectionName(String collectionName)

getProfileWithView

@NonNull
public @NonNull Optional<String> getProfileWithView()

Specified by:

getProfileWithView in interface com.funnelback.plugin.index.IndexConfigProviderContext

setProfileWithView

public void setProfileWithView(@NonNull
                               @NonNull Optional<String> profileWithView)

getProfile

@NonNull
public @NonNull Optional<String> getProfile()

Specified by:

getProfile in interface com.funnelback.plugin.index.IndexConfigProviderContext

setProfile

public void setProfile(@NonNull
                       @NonNull Optional<String> profile)

setConfigSetting

public void setConfigSetting(String key,
                             String value)

getConfigSetting

public String getConfigSetting(String key)

Specified by:

getConfigSetting in interface com.funnelback.plugin.PluginBaseConfigContext

getConfigKeys

public Set<String> getConfigKeys()

getConfigKeysWithPrefix

public Set<String> getConfigKeysWithPrefix(String prefix)

Specified by:

getConfigKeysWithPrefix in interface com.funnelback.plugin.PluginBaseConfigContext

getConfigKeysMatchingPattern

public Map<String,List<String>> getConfigKeysMatchingPattern(String pattern)

Specified by:

getConfigKeysMatchingPattern in interface com.funnelback.plugin.PluginBaseConfigContext

setPlugingConfigurationFileContent

public void setPlugingConfigurationFileContent(String filename,
                                               String content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContent in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

setPlugingConfigurationFileContentAsBytes

public void setPlugingConfigurationFileContentAsBytes(String filename,
                                                      byte[] content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContentAsBytes in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

pluginConfigurationFileAsBytes

public Optional<byte[]> pluginConfigurationFileAsBytes(String filename)

Specified by:

pluginConfigurationFileAsBytes in interface com.funnelback.plugin.PluginBaseConfigFileContext

pluginConfigurationFile

public Optional<String> pluginConfigurationFile(String filename)

Specified by:

pluginConfigurationFile in interface com.funnelback.plugin.PluginBaseConfigFileContext