Package de.cxp.ocs.elasticsearch

Class ElasticsearchSuggestDataProvider

java.lang.Object
de.cxp.ocs.elasticsearch.ElasticsearchSuggestDataProvider
All Implemented Interfaces:
AbstractDataProvider<SuggestData>, SuggestDataProvider
public class ElasticsearchSuggestDataProvider extends Object implements SuggestDataProvider

  • Constructor Details

    • ElasticsearchSuggestDataProvider

      public ElasticsearchSuggestDataProvider()

  • Method Details

    • configure

      public void configure(Map<String,Object> config)
      Description copied from interface: AbstractDataProvider

      This method is always called directly after instantiating the data provider with its no-args-constructor. The given configuration is passed through the QuerySuggestManager and might be empty.

      If this data provider is unusable due to missing configuration, it should throw an Exception, so it will be dropped

      Specified by:
      configure in interface AbstractDataProvider<SuggestData>
      Parameters:
      config - specific data provider configuration (never null, but may be empty)

    • hasData

      public boolean hasData(String indexName)
      Description copied from interface: AbstractDataProvider

      Respond with 'true' if this provider is generally able to provide data for the requested index. This is a quick check when initializing the suggesters, so it should not take too long.

      It's also possible to return a static "true" here and do the expensive availability check at the getLastDataModTime method, which is called async. If getLastDataModTime returns a value < 0, data update are canceled as well.

      Specified by:
      hasData in interface AbstractDataProvider<SuggestData>
      Parameters:
      indexName - identifier for the requested data
      Returns:
      if data is available

    • getLastDataModTime

      public long getLastDataModTime(String indexName) throws IOException
      Description copied from interface: AbstractDataProvider

      Get the timestamp from when the data was modified the last time. For every change of that timestamp, the data will be pulled and indexed into suggest index.

      Setting the timestamp at the data is optional, but if it is set there, it MUST be the same timestamp, otherwise the data is rejected. This feature is used to avoid potential concurrency issues.

      If data is not available at all, a value < 0 should be returned.

      Specified by:
      getLastDataModTime in interface AbstractDataProvider<SuggestData>
      Parameters:
      indexName - identifier for the requested data
      Returns:
      unix timestamp in millis
      Throws:
      IOException - if resource is not available

    • loadData

      public SuggestData loadData(String indexName) throws IOException
      Specified by:
      loadData in interface AbstractDataProvider<SuggestData>
      Parameters:
      indexName - identifier for the requested data
      Returns:
      suggest data
      Throws:
      IOException - if data couldn't be loaded