org.elasticsearch.index.cache.IndexCacheModule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch - Open Source, Distributed, RESTful Search Engine

There is a newer version: 8.14.1

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.index.cache;

import org.elasticsearch.common.inject.AbstractModule;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.util.ExtensionPoint;
import org.elasticsearch.index.cache.bitset.BitsetFilterCache;
import org.elasticsearch.index.cache.query.QueryCache;
import org.elasticsearch.index.cache.query.index.IndexQueryCache;
import org.elasticsearch.index.cache.query.none.NoneQueryCache;

public class IndexCacheModule extends AbstractModule {

    public static final String INDEX_QUERY_CACHE = "index";
    public static final String NONE_QUERY_CACHE = "none";
    public static final String QUERY_CACHE_TYPE = "index.queries.cache.type";
    // for test purposes only
    public static final String QUERY_CACHE_EVERYTHING = "index.queries.cache.everything";
    public static final String QUERY_CACHE_TERM_QUERIES = "index.queries.cache.term_queries";

    private final Settings indexSettings;
    private final ExtensionPoint.SelectedType queryCaches;

    public IndexCacheModule(Settings settings) {
        this.indexSettings = settings;
        this.queryCaches = new ExtensionPoint.SelectedType<>("query_cache", QueryCache.class);

        registerQueryCache(INDEX_QUERY_CACHE, IndexQueryCache.class);
        registerQueryCache(NONE_QUERY_CACHE, NoneQueryCache.class);
    }

    public void registerQueryCache(String name, Class clazz) {
        queryCaches.registerExtension(name, clazz);
    }

    @Override
    protected void configure() {
        queryCaches.bindType(binder(), indexSettings, QUERY_CACHE_TYPE, INDEX_QUERY_CACHE);
        bind(BitsetFilterCache.class).asEagerSingleton();
        bind(IndexCache.class).asEagerSingleton();
    }
}