Class OpenExchangeRatesOrgProvider

  • All Implemented Interfaces:

    public class OpenExchangeRatesOrgProvider
    extends Object
    implements ExchangeRateProvider
    Exchange Rates Provider for CurrencyField and CurrencyFieldType capable of fetching & parsing the freely available exchange rates from

    Configuration Options:

    • ratesFileLocation - A file path or absolute URL specifying the JSON data to load (mandatory)
    • refreshInterval - How frequently (in minutes) to reload the exchange rate data (default: 1440)

    Disclaimer: This data is collected from various providers and provided free of charge for informational purposes only, with no guarantee whatsoever of accuracy, validity, availability or fitness for any purpose; use at your own risk. Other than that - have fun, and please share/watch/fork if you think data like this should be free!

    See Also: JSON Data Format
    • Field Detail

      • ratesFileLocation

        protected String ratesFileLocation
      • refreshIntervalSeconds

        protected int refreshIntervalSeconds
      • resourceLoader

        protected org.apache.lucene.util.ResourceLoader resourceLoader
      • rates

        protected org.apache.solr.schema.OpenExchangeRatesOrgProvider.OpenExchangeRates rates
    • Constructor Detail

      • OpenExchangeRatesOrgProvider

        public OpenExchangeRatesOrgProvider()
    • Method Detail

      • getExchangeRate

        public double getExchangeRate​(String sourceCurrencyCode,
                                      String targetCurrencyCode)
        Returns the currently known exchange rate between two currencies. The rates are fetched from the freely available JSON, hourly updated. All rates are symmetrical with base currency being USD by default.
        Specified by:
        getExchangeRate in interface ExchangeRateProvider
        sourceCurrencyCode - The source currency being converted from.
        targetCurrencyCode - The target currency being converted to.
        The exchange rate.
        org.apache.solr.common.SolrException - if the requested currency pair cannot be found
      • hashCode

        public int hashCode()
        hashCode in class Object
      • reload

        public boolean reload()
                       throws org.apache.solr.common.SolrException
        Description copied from interface: ExchangeRateProvider
        Ask the currency provider to explicitly reload/refresh its configuration. If this does not make sense for a particular provider, simply do nothing
        Specified by:
        reload in interface ExchangeRateProvider
        true if reload of rates succeeded, else false
        org.apache.solr.common.SolrException - if there is a problem reloading
      • init

        public void init​(Map<String,​String> params)
                  throws org.apache.solr.common.SolrException
        Description copied from interface: ExchangeRateProvider
        Initializes the provider by passing in a set of key/value configs as a map. Note that the map also contains other fieldType parameters, so make sure to avoid name clashes.

        Important: Custom config params must be removed from the map before returning

        Specified by:
        init in interface ExchangeRateProvider
        params - a @Map of key/value config params to initialize the provider
      • inform

        public void inform​(org.apache.lucene.util.ResourceLoader loader)
                    throws org.apache.solr.common.SolrException
        Description copied from interface: ExchangeRateProvider
        Passes a ResourceLoader, used to read config files from e.g. ZooKeeper. Implementations not needing resource loader can implement this as NOOP.

        Typically called after init

        Specified by:
        inform in interface ExchangeRateProvider
        loader - a @ResourceLoader instance