Elasticsearch5.5.1插件开发指南

Elasticsearch5.5.1插件开发指南

原文地址:

https://www.elastic.co/guide/en/elasticsearch/plugins/5.5/plugin-authors.html#_plugin_descriptor_file

本文为博主原创翻译,转载需请示。特别是http://www.mamicode.com/  码迷   这类垃圾网站。

Elasticsearch库包含了一些示例

一个包含Java代码的Java插件。这些例子提供了开始的必要的内容。关于如何编写插件的更多信息,我们建议查看本文中列出的插件,以获得灵感。

插件结构

所有插件文件必须在一个名为elasticsearch的目录下。

插件配置文件

所有的插件必须在elasticsearch的目录下有一个叫“plugin-descriptor.properties”的配置文件。具体的文件格式见链接:

https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/resources/plugin-descriptor.properties

插件必备配置信息


description


插件的简短描述


version


插件版本


name


插件名称


classname


插件的入口,需要实现plugin接口


java.version


插件采用的java版本信息


elasticsearch.version


匹配的elastic search版本

注意:在Elasticsearch目录中只有jar文件被添加到该插件的类路径中!如果您需要其他资源,请将它们打包到一个资源jar中。

插件生命周期

你必须在每一个新的Elasticsearch版本发布时更新插件版本。当插件被加载时,这个版本号就会被检查,所以Elasticsearch在当前插件匹配的Elasticsearch版本不一致时会报错。

测试你的插件

当测试一个Java插件时,如果是在plugins/目录下,会被自动加载的。可以通过

bin/elasticsearch-plugin install file:///path/to/your/plugin

来安装插件来测试。

Java安全权限

有些插件可能需要额外的安全许可。一个插件可以包含可选的plugin-security.policy文件,其中包含授予附加权限的grant语句声明。任何附加的权限都将显示给用户一个大的警告,并且在安装插件时必须要确认。因此,如果可能,最好避免请求任何伪造的权限!

如果你使用的是elasticsearch Gradle系统,请把这个文件放到src/main/plugin-metadata,并且它将会在单元测试中被应用。

请记住,Java安全模型是基于堆栈的,并且额外的权限只会被授予您的插件中的jar,因此您将在需要高级特权的操作上编写适当的安全代码。建议添加一个检查来防止未特权的代码(如脚本)获得升级的权限。例如

// ES permission you should check before doPrivileged() blocks

import org.elasticsearch.SpecialPermission;

SecurityManager sm = System.getSecurityManager();

if (sm != null) {

// unprivileged code such as scripts do not have SpecialPermission

sm.checkPermission(new SpecialPermission());

}

AccessController.doPrivileged(

// sensitive operation

);

自定义分词插件的例子

http://blog.csdn.net/u012332735/article/details/62422279

开发一个elasticsearch插件需要的流程如下:

- 实现TokenFilter类(org.apache.lucene.analysis包) 用于修改和扩展token的内容

- AbstractTokenFilterFactory(org.elasticsearch.index.analysis包) 用于生成TokenFilter的实际对象,工厂模式

- AnalyzerProvider(org.elasticsearch.index.analysis包) 用于提供Analyzer示例

- AnalysisModule(org.elasticsearch.index.analysis包) 利用guice注入分析插件的名称

- AbstractComponent(org.elasticsearch.common.component包) 核心组件,用于利用工厂来创建自定义的分析器(Analyzer)和过滤器(TokenFilter)

- AbstractModule(org.elasticsearch.common.inject包) 注入模块,告诉AbstractComponent生成怎样的实例

- AbstractPlugin(org.elasticsearch.plugins包) 告诉elasticsearch插件的

……………………………………………………………………

见原博客

http://blog.csdn.net/u012332735/article/details/62422279

 

时间: 2024-08-03 22:39:43

Elasticsearch5.5.1插件开发指南的相关文章

hdwiki中插件开发指南

插件就是为了满足个性化需求按照HDWiki插件开发规范编写的可插拔程序,虽然可以直接对HDWiki进行二次开发实现插件同样的功能,但是这样做势必影响到系统的升级和稳定性. 采用插件的方式,可以随时进行停用和卸载,而且对系统毫无影响. 插件类型 插件按照是否需要在前台显示,可以分为两类:前台展示类插件和非前台展示类插件.    插件举例:    1.百科联盟插件:只需要系统具有联盟同步和导入数据的功能,不需要在前台产生单独的频道,所以是非前台展示类插件.    2.互动摸摸插件:只需要后台管理,也

提醒我喝水chrome插件开发指南

起因 因为最近工作比较忙,经常忘记了喝水.作为一名前端开发人员,面对着浏览器工作是常态.所以这里为了解决这个痛点,面向前端开发人员写了一款浏览器插件.他的作用就是提醒喝水. 这里将半个小时设置为一个周期,大概和番茄工作法的原理一样.基本上集中注意力半个小时人也就累了.这个时候喝口水,舒缓一下紧张的神经.也作为一个休息的周期.为我们的工作继续高效的进行奠定了节奏. 成果 这是我做的浏览器插件 插件下载地址 开发思路 下面顺道介绍一下浏览器插件开发思路,编程不光要求理论还要有实践,撸起袖子直接干.

开发手册

当你看到这一章节时,你估计会骂我鸡婆.IoC,这个还要你来告诉我,我用SpringFramework已经很久啦.但我还是要说一下.IDEA整个组件结构是基于PicoContainer(http://www.picocontainer.org)的,PicoContainer是一个高效的嵌入式的DI容器.如果你有时间的话,我建议你花5分钟浏览一下PicoContainer,然后回到这篇文档来.     PicoContainer是有层次结构的,就是一个container可以包含子container,

Ehcache详细解读

Ehcache详细解读 Ehcache  是现在最流行的纯Java开源缓存框架,配置简单.结构清晰.功能强大,最初知道它,是从Hibernate的缓存开始的.网上中文的EhCache材料以简单介绍和配置方法居多,如果你有这方面的问题,请自行google:对于API,官网上介绍已经非常清楚,请参见官网:但是很少见到特性说明和对实现原理的分析,因此在这篇文章里面,我会详细介绍和分析EhCache的特性,加上一些自己的理解和思考,希望对缓存感兴趣的朋友有所收获. 一.特性一览 ,来自官网,简单翻译一下

【转】Ehcache详细解读

Ehcache 是现在最流行的纯Java开源缓存框架,配置简单.结构清晰.功能强大,最初知道它,是从Hibernate的缓存开始的.网上中文的EhCache材料 以简单介绍和配置方法居多,如果你有这方面的问题,请自行google:对于API,官网上介绍已经非常清楚,请参见官网:但是很少见到特性说明和对实现 原理的分析,因此在这篇文章里面,我会详细介绍和分析EhCache的特性,加上一些自己的理解和思考,希望对缓存感兴趣的朋友有所收获. 一.特性一览,来自官网,简单翻译一下: 1.快速轻量过去几年

淘宝异构数据源数据交换工具 DataX

淘宝异构数据源数据交换工具 DataX 阅读目录 DataX是什么? DataX用来解决什么? DataX特点? DataX结构模式(框架+插件) DataX在淘宝的运用 DataX是什么? DataX是一个在异构的数据库/文件系统之间高速交换数据的工具,实现了在任意的数据处理系统(RDBMS/Hdfs/Local filesystem)之间的数据交换,由淘宝数据平台部门完成. 回到顶部 DataX用来解决什么? 目前成熟的数据导入导出工具比较多,但是一般都只能用于数据导入或者导出,并且只能支持

ehcache详解

Ehcache是现在最流行的纯Java开 源缓存框架,配置简单.结构清晰.功能强大,最初知道它,是从Hibernate的缓存开始的.网上中文的EhCache材料以简单介绍和配置方法居多, 如果你有这方面的问题,请自行google:对于API,官网上介绍已经非常清楚,请参见官网:但是很少见到特性说明和对实现原理的分析,因此在这篇文章 里面,我会详细介绍和分析EhCache的特性,加上一些自己的理解和思考,希望对缓存感兴趣的朋友有所收获. 一.特性一览,来自官网,简单翻译一下: 1.快速轻量 过去几

Ehcache详细解读(转)

Ehcache 是现在最流行的纯Java开源缓存框架,配置简单.结构清晰.功能强大,最初知道它,是从Hibernate的缓存开始的.网上中文的EhCache材料 以简单介绍和配置方法居多,如果你有这方面的问题,请自行google:对于API,官网上介绍已经非常清楚,请参见官网:但是很少见到特性说明和对实现 原理的分析,因此在这篇文章里面,我会详细介绍和分析EhCache的特性,加上一些自己的理解和思考,希望对缓存感兴趣的朋友有所收获. 一.特性一览,来自官网,简单翻译一下: 1.快速轻量过去几年

Ehcache详细解读(转载)

Ehcache 是现在最流行的纯Java开源缓存框架,配置简单.结构清晰.功能强大,最初知道它,是从Hibernate的缓存开始的.网上中文的EhCache材料以简单介绍和配置方法居多,如果你有这方面的问题,请自行google:对于API,官网上介绍已经非常清楚,请参见官网:但是很少见到特性说明和对实现原理的分析,因此在这篇文章里面,我会详细介绍和分析EhCache的特性,加上一些自己的理解和思考,希望对缓存感兴趣的朋友有所收获. 一.特性一览,来自官网,简单翻译一下: 1.快速轻量过去几年,诸