Interface CompanyIndexConfigurationContributor


public interface CompanyIndexConfigurationContributor
Implement this interface to contribute mappings and settings to company indexes in the search engine.
  • Method Details

    • contributeMappings

      void contributeMappings(long companyId, MappingsHelper mappingsHelper)
      Adds search engine mappings via the provided MappingsHelper.

      Implementations of this method should use the MappingsHelper.putMappings(String) method to add the desired mappings to the search engine.

      Parameters:
      companyId - the company ID of the index targeted by the new mappings.
      mappingsHelper - An instance of MappingsHelper used to apply search engine mappings.
    • contributeSettings

      void contributeSettings(long companyId, SettingsHelper settingsHelper)
      Adds search engine settings via the provided SettingsHelper.

      Implementations of this method should use the SettingsHelper.put(String, String) method to add the desired settings to the search engine.

      Parameters:
      companyId - the company ID of the index targeted by the new settings.
      settingsHelper - An instance of SettingsHelper used to apply search engine settings.