org.elasticsearch.plugins.Plugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch
Elasticsearch subproject :server
There is a newer version: 8.15.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.plugins;

import org.elasticsearch.common.component.LifecycleComponent;
import org.elasticsearch.common.inject.Module;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.index.CloseableIndexComponent;

import java.util.Collection;

/**
 * An extension point allowing to plug in custom functionality.
 * 
 * A plugin can be dynamically injected with {@link Module} by implementing onModule(AnyModule) method
 * removing the need to override {@link #processModule(org.elasticsearch.common.inject.Module)} and check using
 * instanceof.
 */
public interface Plugin {

    /**
     * The name of the plugin.
     */
    String name();

    /**
     * The description of the plugin.
     */
    String description();

    /**
     * Node level modules (classes, will automatically be created).
     */
    Collection> modules();

    /**
     * Node level modules (instances)
     *
     * @param settings The node level settings.
     */
    Collection modules(Settings settings);

    /**
     * Node level services that will be automatically started/stopped/closed.
     */
    Collection> services();

    /**
     * Per index modules.
     */
    Collection> indexModules();

    /**
     * Per index modules.
     */
    Collection indexModules(Settings settings);

    /**
     * Per index services that will be automatically closed.
     */
    Collection> indexServices();

    /**
     * Per index shard module.
     */
    Collection> shardModules();

    /**
     * Per index shard module.
     */
    Collection shardModules(Settings settings);

    /**
     * Per index shard service that will be automatically closed.
     */
    Collection> shardServices();

    /**
     * Process a specific module. Note, its simpler to implement a custom onModule(AnyModule module)
     * method, which will be automatically be called by the relevant type.
     */
    void processModule(Module module);

    /**
     * Additional node settings loaded by the plugin
     */
    Settings additionalSettings();
}