History

Jason Tedor f1670a3845 Rename UserError The top-level class Throwable represents all errors and exceptions in Java. This hierarchy is divided into Error and Exception, the former being serious problems that applications should not try to catch and the latter representing exceptional conditions that an application might want to catch and handle. This commit renames org.elasticsearch.cli.UserError to org.elasticsearch.UserException to make its name consistent with where it falls in this hierarchy. Relates elastic/elasticsearch#2701 Original commit: elastic/x-pack-elasticsearch@589e159ec0		2016-07-04 19:22:46 -04:00
..
base	Fix order of modifiers	2016-07-01 16:54:53 +02:00
licensor	Rename UserError	2016-07-04 19:22:46 -04:00
README.md	reorganize directory layout	2015-12-03 16:22:37 +01:00
build.gradle	disable license headers check for x-plugins, until we figure out what it should do	2015-12-18 13:27:52 -05:00

README.md

elasticsearch-license

Elasticsearch Licensing core, tools and plugin

Core

Contains core data structures, utilities used by Licensor and Plugin.

See core/ and core-shaded/

Licensor

Contains a collection of tools to generate key-pairs, licenses and validate licenses.

See licensor/

see [wiki] (https://github.com/elasticsearch/elasticsearch-license/wiki) for documentation on [Licensing Tools Usage & Reference] (https://github.com/elasticsearch/elasticsearch-license/wiki/License-Tools-Usage-&-Reference)

Plugin

NOTE: The license plugin has to be packaged with the right public key when being deployed to public repositories in maven or uploaded to s3. Use -Dkeys.path=<PATH_TO_KEY_DIR> with maven command to package the plugin with a specified key.

See plugin/

see [Getting Started] (https://github.com/elasticsearch/elasticsearch-license/blob/master/docs/getting-started.asciidoc) to install license plugin.

see [Licensing REST APIs] (https://github.com/elasticsearch/elasticsearch-license/blob/master/docs/license.asciidoc) to use the license plugin from an elasticsearch deployment.

see [wiki] (https://github.com/elasticsearch/elasticsearch-license/wiki) for documentation on

[License Plugin Consumer Interface] (https://github.com/elasticsearch/elasticsearch-license/wiki/License---Consumer-Interface)
[License Plugin Release Process] (https://github.com/elasticsearch/elasticsearch-license/wiki/Plugin-Release-Process)
[License Plugin Design] (https://github.com/elasticsearch/elasticsearch-license/wiki/License-Plugin--Design)