Merge remote-tracking branch 'upstream/master' into index-lifecycle

Author: talevy

CONTRIBUTING.md

@@ -159,7 +159,9 @@ Please follow these formatting guidelines:
 
 * Java indent is 4 spaces
 * Line width is 140 characters
-* Line width for code snippets that are included in the documentation (the ones surrounded by `// tag` and `// end` comments) is 76 characters
+* Lines of code surrounded by `// tag` and `// end` comments are included in the
+documentation and should only be 76 characters wide not counting
+leading indentation
 * The rest is left to Java coding standards
 * Disable “auto-format on save” to prevent unnecessary format changes. This makes reviews much harder as it generates unnecessary formatting changes. If your IDE supports formatting only modified chunks that is fine to do.
 * Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause the build to fail. This can be done automatically by your IDE:

buildSrc/src/main/resources/checkstyle_suppressions.xml

@@ -0,0 +1,136 @@
+/*
+ * 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.client;
+
+import org.elasticsearch.ElasticsearchException;
+import org.elasticsearch.action.support.nodes.BaseNodesResponse;
+import org.elasticsearch.common.Nullable;
+import org.elasticsearch.common.ParseField;
+import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.ToXContent;
+import org.elasticsearch.common.xcontent.XContentBuilder;
+import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.rest.action.RestActions;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * A utility class to parse the Nodes Header returned by
+ * {@link RestActions#buildNodesHeader(XContentBuilder, ToXContent.Params, BaseNodesResponse)}.
+ */
+public final class NodesResponseHeader {
+
+    public static final ParseField TOTAL = new ParseField("total");
+    public static final ParseField SUCCESSFUL = new ParseField("successful");
+    public static final ParseField FAILED = new ParseField("failed");
+    public static final ParseField FAILURES = new ParseField("failures");
+
+    @SuppressWarnings("unchecked")
+    public static final ConstructingObjectParser<NodesResponseHeader, Void> PARSER =
+        new ConstructingObjectParser<>("nodes_response_header", true,
+            (a) -> {
+                int i = 0;
+                int total = (Integer) a[i++];
+                int successful = (Integer) a[i++];
+                int failed = (Integer) a[i++];
+                List<ElasticsearchException> failures = (List<ElasticsearchException>) a[i++];
+                return new NodesResponseHeader(total, successful, failed, failures);
+            });
+
+    static {
+        PARSER.declareInt(ConstructingObjectParser.constructorArg(), TOTAL);
+        PARSER.declareInt(ConstructingObjectParser.constructorArg(), SUCCESSFUL);
+        PARSER.declareInt(ConstructingObjectParser.constructorArg(), FAILED);
+        PARSER.declareObjectArray(ConstructingObjectParser.optionalConstructorArg(),
+            (p, c) -> ElasticsearchException.fromXContent(p), FAILURES);
+    }
+
+    private final int total;
+    private final int successful;
+    private final int failed;
+    private final List<ElasticsearchException> failures;
+
+    public NodesResponseHeader(int total, int successful, int failed, @Nullable List<ElasticsearchException> failures) {
+        this.total = total;
+        this.successful = successful;
+        this.failed = failed;
+        this.failures = failures == null ? Collections.emptyList() : failures;
+    }
+
+    public static NodesResponseHeader fromXContent(XContentParser parser, Void context) throws IOException {
+        return PARSER.parse(parser, context);
+    }
+
+    /** the total number of nodes that the operation was carried on */
+    public int getTotal() {
+        return total;
+    }
+
+    /** the number of nodes that the operation has failed on */
+    public int getFailed() {
+        return failed;
+    }
+
+    /** the number of nodes that the operation was successful on */
+    public int getSuccessful() {
+        return successful;
+    }
+
+    /**
+     * Get the failed node exceptions.
+     *
+     * @return Never {@code null}. Can be empty.
+     */
+    public List<ElasticsearchException> getFailures() {
+        return failures;
+    }
+
+    /**
+     * Determine if there are any node failures in {@link #failures}.
+     *
+     * @return {@code true} if {@link #failures} contains at least 1 exception.
+     */
+    public boolean hasFailures() {
+        return failures.isEmpty() == false;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        NodesResponseHeader that = (NodesResponseHeader) o;
+        return total == that.total &&
+            successful == that.successful &&
+            failed == that.failed &&
+            Objects.equals(failures, that.failures);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(total, successful, failed, failures);
+    }
+
+}

client/rest-high-level/src/main/java/org/elasticsearch/client/NodesResponseHeader.java

@@ -262,6 +262,18 @@ private static Request getStyleRequest(String method, GetRequest getRequest) {
 
         return request;
     }
+    
+    static Request sourceExists(GetRequest getRequest) {
+        Request request = new Request(HttpHead.METHOD_NAME, endpoint(getRequest.index(), getRequest.type(), getRequest.id(), "_source"));
+
+        Params parameters = new Params(request);
+        parameters.withPreference(getRequest.preference());
+        parameters.withRouting(getRequest.routing());
+        parameters.withRefresh(getRequest.refresh());
+        parameters.withRealtime(getRequest.realtime());
+        // Version params are not currently supported by the source exists API so are not passed
+        return request;
+    }    
 
     static Request multiGet(MultiGetRequest multiGetRequest) throws IOException {
         Request request = new Request(HttpPost.METHOD_NAME, "/_mget");

client/rest-high-level/src/main/java/org/elasticsearch/client/RequestConverters.java

@@ -739,6 +739,32 @@ public final void existsAsync(GetRequest getRequest, RequestOptions options, Act
                 emptySet());
     }
 
+    /**
+     * Checks for the existence of a document with a "_source" field. Returns true if it exists, false otherwise.
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source">Source exists API 
+     * on elastic.co</a>
+     * @param getRequest the request
+     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @return <code>true</code> if the document and _source field exists, <code>false</code> otherwise
+     * @throws IOException in case there is a problem sending the request
+     */
+    public boolean existsSource(GetRequest getRequest, RequestOptions options) throws IOException {
+        return performRequest(getRequest, RequestConverters::sourceExists, options, RestHighLevelClient::convertExistsResponse, emptySet());
+    }     
+    
+    /**
+     * Asynchronously checks for the existence of a document with a "_source" field. Returns true if it exists, false otherwise.
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source">Source exists API 
+     * on elastic.co</a>
+     * @param getRequest the request
+     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @param listener the listener to be notified upon request completion
+     */
+    public final void existsSourceAsync(GetRequest getRequest, RequestOptions options, ActionListener<Boolean> listener) {
+        performRequestAsync(getRequest, RequestConverters::sourceExists, options, RestHighLevelClient::convertExistsResponse, listener,
+                emptySet());
+    }    
+    
     /**
      * Index a document using the Index API.
      * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html">Index API on elastic.co</a>

client/rest-high-level/src/main/java/org/elasticsearch/client/RestHighLevelClient.java

@@ -20,17 +20,19 @@
 package org.elasticsearch.client;
 
 import org.elasticsearch.action.ActionListener;
+import org.elasticsearch.client.security.ClearRolesCacheRequest;
+import org.elasticsearch.client.security.ClearRolesCacheResponse;
 import org.elasticsearch.client.security.DeleteRoleRequest;
 import org.elasticsearch.client.security.DeleteRoleResponse;
 import org.elasticsearch.client.security.PutRoleMappingRequest;
 import org.elasticsearch.client.security.PutRoleMappingResponse;
 import org.elasticsearch.client.security.DisableUserRequest;
+import org.elasticsearch.client.security.EmptyResponse;
 import org.elasticsearch.client.security.EnableUserRequest;
 import org.elasticsearch.client.security.GetSslCertificatesRequest;
 import org.elasticsearch.client.security.GetSslCertificatesResponse;
 import org.elasticsearch.client.security.PutUserRequest;
 import org.elasticsearch.client.security.PutUserResponse;
-import org.elasticsearch.client.security.EmptyResponse;
 import org.elasticsearch.client.security.ChangePasswordRequest;
 import org.elasticsearch.client.security.DeleteRoleMappingRequest;
 import org.elasticsearch.client.security.DeleteRoleMappingResponse;
@@ -170,6 +172,36 @@ public void disableUserAsync(DisableUserRequest request, RequestOptions options,
             EmptyResponse::fromXContent, listener, emptySet());
     }
 
+    /**
+     * Clears the native roles cache for a set of roles.
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html">
+     * the docs</a> for more.
+     *
+     * @param request the request with the roles for which the cache should be cleared.
+     * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @return the response from the enable user call
+     * @throws IOException in case there is a problem sending the request or parsing back the response
+     */
+    public ClearRolesCacheResponse clearRolesCache(ClearRolesCacheRequest request, RequestOptions options) throws IOException {
+        return restHighLevelClient.performRequestAndParseEntity(request, SecurityRequestConverters::clearRolesCache, options,
+            ClearRolesCacheResponse::fromXContent, emptySet());
+    }
+
+    /**
+     * Clears the native roles cache for a set of roles asynchronously.
+     * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html">
+     * the docs</a> for more.
+     *
+     * @param request  the request with the roles for which the cache should be cleared.
+     * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
+     * @param listener the listener to be notified upon request completion
+     */
+    public void clearRolesCacheAsync(ClearRolesCacheRequest request, RequestOptions options,
+                                     ActionListener<ClearRolesCacheResponse> listener) {
+        restHighLevelClient.performRequestAsyncAndParseEntity(request, SecurityRequestConverters::clearRolesCache, options,
+            ClearRolesCacheResponse::fromXContent, listener, emptySet());
+    }
+
     /**
      * Synchronously retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
      * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html">

client/rest-high-level/src/main/java/org/elasticsearch/client/SecurityClient.java

@@ -22,6 +22,7 @@
 import org.apache.http.client.methods.HttpDelete;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.methods.HttpPut;
+import org.elasticsearch.client.security.ClearRolesCacheRequest;
 import org.elasticsearch.client.security.DeleteRoleMappingRequest;
 import org.elasticsearch.client.security.DeleteRoleRequest;
 import org.elasticsearch.client.security.PutRoleMappingRequest;
@@ -97,6 +98,15 @@ private static Request setUserEnabled(SetUserEnabledRequest setUserEnabledReques
         return request;
     }
 
+    static Request clearRolesCache(ClearRolesCacheRequest disableCacheRequest) {
+        String endpoint = new RequestConverters.EndpointBuilder()
+            .addPathPartAsIs("_xpack/security/role")
+            .addCommaSeparatedPathParts(disableCacheRequest.names())
+            .addPathPart("_clear_cache")
+            .build();
+        return new Request(HttpPost.METHOD_NAME, endpoint);
+    }
+
     static Request deleteRoleMapping(DeleteRoleMappingRequest deleteRoleMappingRequest) {
         final String endpoint = new RequestConverters.EndpointBuilder()
             .addPathPartAsIs("_xpack/security/role_mapping")

client/rest-high-level/src/main/java/org/elasticsearch/client/SecurityRequestConverters.java

@@ -0,0 +1,65 @@
+/*
+ * 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.client.security;
+
+import org.elasticsearch.client.Validatable;
+
+import java.util.Arrays;
+
+/**
+ * The request used to clear the cache for native roles stored in an index.
+ */
+public final class ClearRolesCacheRequest implements Validatable {
+
+    private final String[] names;
+
+    /**
+     * Sets the roles for which caches will be evicted. When not set all the roles will be evicted from the cache.
+     *
+     * @param names    The role names
+     */
+    public ClearRolesCacheRequest(String... names) {
+        this.names = names;
+    }
+
+    /**
+     * @return an array of role names that will have the cache evicted or <code>null</code> if all
+     */
+    public String[] names() {
+        return names;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        ClearRolesCacheRequest that = (ClearRolesCacheRequest) o;
+        return Arrays.equals(names, that.names);
+    }
+
+    @Override
+    public int hashCode() {
+        return Arrays.hashCode(names);
+    }
+}