org.elasticsearch.plugin.package-info Maven / Gradle / Ivy

Go to download

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

Elasticsearch subproject :libs:elasticsearch-plugin-api

There is a newer version: 8.17.0

Show newest version

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

/**
 * An api used by plugin developers to implement custom Elasticsearch plugins.
 * The package convention in plugin apis is as follows:
 * 
 *       The root package is org.elasticsearch.plugin
 *       Specialised API jars have their name following the root package.
 *           Interfaces and annotations used by plugin developers should be placed under it.
 *           i.e. org.elasticsearch.plugin.analysis
 *      
 *       packages which are not meant to be used by plugin developers should be under internal package suffix
 *           i.e org.elasticsearch.plugin.analysis.internal
 *      
 * 
 */
package org.elasticsearch.plugin;