diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/AbstractCatAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/AbstractCatAction.java index f4ec80f56d5..95873b8878c 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/AbstractCatAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/AbstractCatAction.java @@ -37,11 +37,11 @@ public abstract class AbstractCatAction extends BaseRestHandler { super(settings, controller, client); } - abstract void doRequest(final RestRequest request, final RestChannel channel, final Client client); + protected abstract void doRequest(final RestRequest request, final RestChannel channel, final Client client); - abstract void documentation(StringBuilder sb); + protected abstract void documentation(StringBuilder sb); - abstract Table getTableWithHeader(final RestRequest request); + protected abstract Table getTableWithHeader(final RestRequest request); @Override public void handleRequest(final RestRequest request, final RestChannel channel, final Client client) throws Exception { diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestAliasAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestAliasAction.java index 06f766f936f..3d2b283714f 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestAliasAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestAliasAction.java @@ -49,7 +49,7 @@ public class RestAliasAction extends AbstractCatAction { @Override - void doRequest(final RestRequest request, final RestChannel channel, final Client client) { + protected void doRequest(final RestRequest request, final RestChannel channel, final Client client) { final GetAliasesRequest getAliasesRequest = request.hasParam("alias") ? new GetAliasesRequest(request.param("alias")) : new GetAliasesRequest(); @@ -65,13 +65,13 @@ public class RestAliasAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/aliases\n"); sb.append("/_cat/aliases/{alias}\n"); } @Override - Table getTableWithHeader(RestRequest request) { + protected Table getTableWithHeader(RestRequest request) { final Table table = new Table(); table.startHeaders(); table.addCell("alias", "alias:a;desc:alias name"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestAllocationAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestAllocationAction.java index c25ccbe5ed0..fd2971190ff 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestAllocationAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestAllocationAction.java @@ -52,7 +52,7 @@ public class RestAllocationAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/allocation\n"); } @@ -83,7 +83,7 @@ public class RestAllocationAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { final Table table = new Table(); table.startHeaders(); table.addCell("shards", "alias:s;text-align:right;desc:number of shards on node"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestCountAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestCountAction.java index 8813fe63b46..554465bbbb9 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestCountAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestCountAction.java @@ -48,7 +48,7 @@ public class RestCountAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/count\n"); sb.append("/_cat/count/{index}\n"); } @@ -76,7 +76,7 @@ public class RestCountAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("epoch", "alias:t,time;desc:seconds since 1970-01-01 00:00:00, that the count was executed"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestFielddataAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestFielddataAction.java index a99eec12810..a881f72104b 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestFielddataAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestFielddataAction.java @@ -53,7 +53,7 @@ public class RestFielddataAction extends AbstractCatAction { } @Override - void doRequest(final RestRequest request, final RestChannel channel, final Client client) { + protected void doRequest(final RestRequest request, final RestChannel channel, final Client client) { final NodesStatsRequest nodesStatsRequest = new NodesStatsRequest("data:true"); nodesStatsRequest.clear(); @@ -70,13 +70,13 @@ public class RestFielddataAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/fielddata\n"); sb.append("/_cat/fielddata/{fields}\n"); } @Override - Table getTableWithHeader(RestRequest request) { + protected Table getTableWithHeader(RestRequest request) { Table table = new Table(); table.startHeaders() .addCell("id", "desc:node id") diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java index eb35da99d21..bc5920b7db9 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java @@ -48,7 +48,7 @@ public class RestHealthAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/health\n"); } @@ -65,7 +65,7 @@ public class RestHealthAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table t = new Table(); t.startHeaders(); t.addCell("epoch", "alias:t,time;desc:seconds since 1970-01-01 00:00:00"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java index 3a5ea802b28..3530e889e9d 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java @@ -62,7 +62,7 @@ public class RestIndicesAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/indices\n"); sb.append("/_cat/indices/{index}\n"); } @@ -103,7 +103,7 @@ public class RestIndicesAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("health", "alias:h;desc:current health status"); @@ -115,7 +115,7 @@ public class RestIndicesAction extends AbstractCatAction { table.addCell("docs.deleted", "alias:dd,docsDeleted;text-align:right;desc:deleted docs"); table.addCell("creation.date", "alias:cd;default:false;desc:index creation date (millisecond value)"); - table.addCell("creation.date.string", "alias:cds;default:false;desc:index creation date (as string)"); + table.addCell("creation.date.string", "alias:cds;default:false;desc:index creation date (as string)"); table.addCell("store.size", "sibling:pri;alias:ss,storeSize;text-align:right;desc:store size of primaries & replicas"); table.addCell("pri.store.size", "text-align:right;desc:store size of primaries"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestMasterAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestMasterAction.java index 92628ef5496..7c2f4ef61a3 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestMasterAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestMasterAction.java @@ -42,7 +42,7 @@ public class RestMasterAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/master\n"); } @@ -62,7 +62,7 @@ public class RestMasterAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders() .addCell("id", "desc:node id") diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodeAttrsAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodeAttrsAction.java index 48cbf8809b2..c9d3a2dcd62 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodeAttrsAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodeAttrsAction.java @@ -50,7 +50,7 @@ public class RestNodeAttrsAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/nodeattrs\n"); } @@ -84,7 +84,7 @@ public class RestNodeAttrsAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("node", "default:true;alias:name;desc:node name"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java index fe447b2d9d8..1bc43b4c1b4 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestNodesAction.java @@ -73,7 +73,7 @@ public class RestNodesAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/nodes\n"); } @@ -107,7 +107,7 @@ public class RestNodesAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("id", "default:false;alias:id,nodeId;desc:unique node id"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestPendingClusterTasksAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestPendingClusterTasksAction.java index 4bb144246b2..136997c5c89 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestPendingClusterTasksAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestPendingClusterTasksAction.java @@ -40,7 +40,7 @@ public class RestPendingClusterTasksAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/pending_tasks\n"); } @@ -59,7 +59,7 @@ public class RestPendingClusterTasksAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table t = new Table(); t.startHeaders(); t.addCell("insertOrder", "alias:o;text-align:right;desc:task insertion order"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestPluginsAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestPluginsAction.java index d9170a75c41..058a93bf6b9 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestPluginsAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestPluginsAction.java @@ -47,7 +47,7 @@ public class RestPluginsAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/plugins\n"); } @@ -74,7 +74,7 @@ public class RestPluginsAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("id", "default:false;desc:unique node id"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestRecoveryAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestRecoveryAction.java index e2d277819e0..9d58f8f74df 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestRecoveryAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestRecoveryAction.java @@ -58,7 +58,7 @@ public class RestRecoveryAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/recovery\n"); sb.append("/_cat/recovery/{index}\n"); } @@ -79,7 +79,7 @@ public class RestRecoveryAction extends AbstractCatAction { } @Override - Table getTableWithHeader(RestRequest request) { + protected Table getTableWithHeader(RestRequest request) { Table t = new Table(); t.startHeaders() .addCell("index", "alias:i,idx;desc:index name") diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java index 0a9c02f4fd7..972a1bc0110 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestSegmentsAction.java @@ -49,7 +49,7 @@ public class RestSegmentsAction extends AbstractCatAction { } @Override - void doRequest(final RestRequest request, final RestChannel channel, final Client client) { + protected void doRequest(final RestRequest request, final RestChannel channel, final Client client) { final String[] indices = Strings.splitStringByCommaToArray(request.param("index")); final ClusterStateRequest clusterStateRequest = new ClusterStateRequest(); @@ -75,13 +75,13 @@ public class RestSegmentsAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/segments\n"); sb.append("/_cat/segments/{index}\n"); } @Override - Table getTableWithHeader(RestRequest request) { + protected Table getTableWithHeader(RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("index", "default:true;alias:i,idx;desc:index name"); diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestShardsAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestShardsAction.java index 76698efcaa6..c6df5ee562f 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestShardsAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestShardsAction.java @@ -50,7 +50,7 @@ public class RestShardsAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/shards\n"); sb.append("/_cat/shards/{index}\n"); } @@ -78,7 +78,7 @@ public class RestShardsAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders() .addCell("index", "default:true;alias:i,idx;desc:index name") diff --git a/core/src/main/java/org/elasticsearch/rest/action/cat/RestThreadPoolAction.java b/core/src/main/java/org/elasticsearch/rest/action/cat/RestThreadPoolAction.java index b5848379a61..c4d241f027f 100644 --- a/core/src/main/java/org/elasticsearch/rest/action/cat/RestThreadPoolAction.java +++ b/core/src/main/java/org/elasticsearch/rest/action/cat/RestThreadPoolAction.java @@ -112,7 +112,7 @@ public class RestThreadPoolAction extends AbstractCatAction { } @Override - void documentation(StringBuilder sb) { + protected void documentation(StringBuilder sb) { sb.append("/_cat/thread_pool\n"); } @@ -146,7 +146,7 @@ public class RestThreadPoolAction extends AbstractCatAction { } @Override - Table getTableWithHeader(final RestRequest request) { + protected Table getTableWithHeader(final RestRequest request) { Table table = new Table(); table.startHeaders(); table.addCell("id", "default:false;alias:nodeId;desc:unique node id"); diff --git a/qa/configured-plugin/LICENSE.txt b/qa/configured-plugin/LICENSE.txt new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/qa/configured-plugin/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/qa/configured-plugin/NOTICE.txt b/qa/configured-plugin/NOTICE.txt new file mode 100644 index 00000000000..48809049486 --- /dev/null +++ b/qa/configured-plugin/NOTICE.txt @@ -0,0 +1,8 @@ +Elasticsearch +Copyright 2009-2015 Elasticsearch + +This product includes software developed by The Apache Software +Foundation (http://www.apache.org/). + +The LICENSE and NOTICE files for all dependencies may be found in the licenses/ +directory. diff --git a/qa/configured-plugin/README.md b/qa/configured-plugin/README.md new file mode 100644 index 00000000000..679224e0a93 --- /dev/null +++ b/qa/configured-plugin/README.md @@ -0,0 +1,25 @@ +Example Configured Plugin for Elasticsearch +=========================================== + +```sh +bin/plugin install configured_example +``` + +License +------- + + This software is licensed under the Apache 2 license, quoted below. + + Copyright 2009-2014 Elasticsearch + + Licensed 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. diff --git a/qa/configured-plugin/pom.xml b/qa/configured-plugin/pom.xml new file mode 100644 index 00000000000..1a0eadf3b50 --- /dev/null +++ b/qa/configured-plugin/pom.xml @@ -0,0 +1,39 @@ + + + 4.0.0 + + + org.elasticsearch.plugin + elasticsearch-plugin + 2.0.0-beta1-SNAPSHOT + ../plugins + + + elasticsearch-example-configured + QA: Elasticsearch Example Configured Plugin + Plugin used to test plugins that install configuration. + + + org.elasticsearch.plugin.configured.ConfiguredExamplePlugin + configured_example + false + + + + + + + + org.apache.maven.plugins + maven-assembly-plugin + + + src/main/assemblies/plugin.xml + + + + + + diff --git a/qa/configured-plugin/rest-api-spec/api/cat.configured_example.json b/qa/configured-plugin/rest-api-spec/api/cat.configured_example.json new file mode 100644 index 00000000000..4744ac5fc18 --- /dev/null +++ b/qa/configured-plugin/rest-api-spec/api/cat.configured_example.json @@ -0,0 +1,24 @@ +{ + "cat.configured_example": { + "documentation": "", + "methods": ["GET"], + "url": { + "path": "/_cat/configured_example", + "paths": ["/_cat/configured_example"], + "parts": {}, + "params": { + "help": { + "type": "boolean", + "description": "Return help information", + "default": false + }, + "v": { + "type": "boolean", + "description": "Verbose mode. Display column headers", + "default": true + } + } + }, + "body": null + } +} diff --git a/qa/configured-plugin/rest-api-spec/test/configured_example/10_basic.yaml b/qa/configured-plugin/rest-api-spec/test/configured_example/10_basic.yaml new file mode 100644 index 00000000000..378d3a3c0a1 --- /dev/null +++ b/qa/configured-plugin/rest-api-spec/test/configured_example/10_basic.yaml @@ -0,0 +1,23 @@ +--- +"Help": + - do: + cat.configured_example: + help: true + + - match: + $body: | + /^ test .+ \n + $/ + +--- +"Data": + + - do: + cat.configured_example: + v: false + + - match: + $body: | + /^ + foo \s+ + $/ diff --git a/qa/configured-plugin/src/main/assemblies/plugin.xml b/qa/configured-plugin/src/main/assemblies/plugin.xml new file mode 100644 index 00000000000..f1f9e0f04b1 --- /dev/null +++ b/qa/configured-plugin/src/main/assemblies/plugin.xml @@ -0,0 +1,32 @@ + + + plugin + + zip + + false + + + ${elasticsearch.tools.directory}/plugin-metadata/plugin-descriptor.properties + + true + + + + + src/main/config + config + + + + + / + true + true + true + + org.elasticsearch:elasticsearch + + + + diff --git a/qa/configured-plugin/src/main/config/example.yaml b/qa/configured-plugin/src/main/config/example.yaml new file mode 100644 index 00000000000..097569ad4cf --- /dev/null +++ b/qa/configured-plugin/src/main/config/example.yaml @@ -0,0 +1 @@ +test: foo diff --git a/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatAction.java b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatAction.java new file mode 100644 index 00000000000..214e8c523b0 --- /dev/null +++ b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatAction.java @@ -0,0 +1,79 @@ +/* + * 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.plugin.configured; + +import org.elasticsearch.client.Client; +import org.elasticsearch.common.Table; +import org.elasticsearch.common.inject.Inject; +import org.elasticsearch.common.settings.Settings; +import org.elasticsearch.rest.*; +import org.elasticsearch.rest.action.cat.AbstractCatAction; +import org.elasticsearch.rest.action.support.RestTable; + +import static org.elasticsearch.rest.RestRequest.Method.GET; + +/** + * Example of adding a cat action with a plugin. + */ +public class ConfiguredExampleCatAction extends AbstractCatAction { + private final ConfiguredExamplePluginConfiguration config; + + @Inject + public ConfiguredExampleCatAction(Settings settings, RestController controller, + Client client, ConfiguredExamplePluginConfiguration config) { + super(settings, controller, client); + this.config = config; + controller.registerHandler(GET, "/_cat/configured_example", this); + } + + @Override + protected void doRequest(final RestRequest request, final RestChannel channel, final Client client) { + Table table = getTableWithHeader(request); + table.startRow(); + table.addCell(config.getTestConfig()); + table.endRow(); + try { + channel.sendResponse(RestTable.buildResponse(table, channel)); + } catch (Throwable e) { + try { + channel.sendResponse(new BytesRestResponse(channel, e)); + } catch (Throwable e1) { + logger.error("failed to send failure response", e1); + } + } + } + + @Override + protected void documentation(StringBuilder sb) { + sb.append(documentation()); + } + + public static String documentation() { + return "/_cat/configured_example\n"; + } + + @Override + protected Table getTableWithHeader(RestRequest request) { + final Table table = new Table(); + table.startHeaders(); + table.addCell("test", "desc:test"); + table.endHeaders(); + return table; + } +} diff --git a/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePlugin.java b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePlugin.java new file mode 100644 index 00000000000..b5cffa45b4b --- /dev/null +++ b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePlugin.java @@ -0,0 +1,62 @@ +/* + * 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.plugin.configured; + +import org.elasticsearch.common.inject.AbstractModule; +import org.elasticsearch.common.inject.Inject; +import org.elasticsearch.common.inject.Module; +import org.elasticsearch.common.inject.multibindings.Multibinder; +import org.elasticsearch.common.settings.Settings; +import org.elasticsearch.plugins.AbstractPlugin; +import org.elasticsearch.rest.action.cat.AbstractCatAction; + +import java.util.ArrayList; +import java.util.Collection; + +/** + * Example configured plugin. + */ +public class ConfiguredExamplePlugin extends AbstractPlugin { + @Override + public String name() { + return "configured-example"; + } + + @Override + public String description() { + return "Example of a configured plugin"; + } + + @Override + public Collection> modules() { + Collection> classes = new ArrayList<>(); + classes.add(ConfiguredExampleModule.class); + return classes; + } + + public static class ConfiguredExampleModule extends AbstractModule { + @Override + protected void configure() { + bind(ConfiguredExamplePluginConfiguration.class).asEagerSingleton(); + Multibinder catActionMultibinder = Multibinder.newSetBinder(binder(), AbstractCatAction.class); + catActionMultibinder.addBinding().to(ConfiguredExampleCatAction.class).asEagerSingleton(); + } + } +} diff --git a/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginConfiguration.java b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginConfiguration.java new file mode 100644 index 00000000000..04fc3017b50 --- /dev/null +++ b/qa/configured-plugin/src/main/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginConfiguration.java @@ -0,0 +1,80 @@ +/* + * 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.plugin.configured; + +import org.elasticsearch.ElasticsearchParseException; +import org.elasticsearch.common.inject.AbstractModule; +import org.elasticsearch.common.inject.Inject; +import org.elasticsearch.common.inject.Module; +import org.elasticsearch.common.inject.multibindings.Multibinder; +import org.elasticsearch.common.inject.name.Names; +import org.elasticsearch.common.xcontent.XContentParser; +import org.elasticsearch.common.xcontent.yaml.YamlXContent; +import org.elasticsearch.common.logging.ESLogger; +import org.elasticsearch.common.logging.Loggers; +import org.elasticsearch.env.Environment; +import org.elasticsearch.plugins.AbstractPlugin; +import org.elasticsearch.rest.action.cat.AbstractCatAction; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Collection; + +import static org.elasticsearch.common.io.Streams.copyToString; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.nio.file.Files.newBufferedReader; + +/** + * Example configuration. + */ +public class ConfiguredExamplePluginConfiguration { + private String test = "not set in config"; + + @Inject + public ConfiguredExamplePluginConfiguration(Environment env) throws IOException { + // The directory part of the location matches the artifactId of this plugin + Path configFile = env.configFile().resolve("example-configured/example.yaml"); + String contents = copyToString(newBufferedReader(configFile, UTF_8)); + XContentParser parser = YamlXContent.yamlXContent.createParser(contents); + + String currentFieldName = null; + XContentParser.Token token = parser.nextToken(); + assert token == XContentParser.Token.START_OBJECT; + while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) { + if (token == XContentParser.Token.FIELD_NAME) { + currentFieldName = parser.currentName(); + } else if (token.isValue()) { + if ("test".equals(currentFieldName)) { + test = parser.text(); + } else { + throw new ElasticsearchParseException("Unrecognized config key: {}", currentFieldName); + } + } else { + throw new ElasticsearchParseException("Unrecognized config key: {}", currentFieldName); + } + } + } + + public String getTestConfig() { + return test; + } +} diff --git a/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatActionTest.java b/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatActionTest.java new file mode 100644 index 00000000000..249b4b098c5 --- /dev/null +++ b/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExampleCatActionTest.java @@ -0,0 +1,32 @@ +/* + * 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.plugin.configured; + +import org.elasticsearch.rest.RestController; +import org.elasticsearch.test.ESTestCase; + +import static org.hamcrest.Matchers.containsString; + +public class ConfiguredExampleCatActionTest extends ESTestCase { + public void testDocumentation() { + // Intentionally perfunctory just to have something to demonstrate + assertThat(ConfiguredExampleCatAction.documentation(), containsString("configured_example")); + } +} diff --git a/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginRestIT.java b/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginRestIT.java new file mode 100644 index 00000000000..0dc3863bdff --- /dev/null +++ b/qa/configured-plugin/src/test/java/org/elasticsearch/plugin/configured/ConfiguredExamplePluginRestIT.java @@ -0,0 +1,40 @@ +/* + * 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.plugin.configured; + +import com.carrotsearch.randomizedtesting.annotations.Name; +import com.carrotsearch.randomizedtesting.annotations.ParametersFactory; +import org.elasticsearch.test.rest.ESRestTestCase; +import org.elasticsearch.test.rest.RestTestCandidate; +import org.elasticsearch.test.rest.parser.RestTestParseException; + +import java.io.IOException; + +public class ConfiguredExamplePluginRestIT extends ESRestTestCase { + + public ConfiguredExamplePluginRestIT(@Name("yaml") RestTestCandidate testCandidate) { + super(testCandidate); + } + + @ParametersFactory + public static Iterable parameters() throws IOException, RestTestParseException { + return ESRestTestCase.createParameters(0, 1); + } +}