Merge remote-tracking branch 'elastic/master' into zen2

Author: ywelsch

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

@@ -19,41 +19,59 @@
 
 package org.elasticsearch.client.ccr;
 
+import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.common.xcontent.ConstructingObjectParser;
 import org.elasticsearch.common.xcontent.ObjectParser;
 import org.elasticsearch.common.xcontent.XContentParser;
-import org.elasticsearch.common.xcontent.XContentParser.Token;
 
-import java.io.IOException;
+import java.util.AbstractMap;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.NavigableMap;
 import java.util.Objects;
+import java.util.TreeMap;
+import java.util.stream.Collectors;
 
 public final class GetAutoFollowPatternResponse {
 
-    public static GetAutoFollowPatternResponse fromXContent(final XContentParser parser) throws IOException {
-        final Map<String, Pattern> patterns = new HashMap<>();
-        for (Token token = parser.nextToken(); token != Token.END_OBJECT; token = parser.nextToken()) {
-            if (token == Token.FIELD_NAME) {
-                final String name = parser.currentName();
-                final Pattern pattern = Pattern.PARSER.parse(parser, null);
-                patterns.put(name, pattern);
-            }
-        }
-        return new GetAutoFollowPatternResponse(patterns);
+    static final ParseField PATTERNS_FIELD = new ParseField("patterns");
+    static final ParseField NAME_FIELD = new ParseField("name");
+    static final ParseField PATTERN_FIELD = new ParseField("pattern");
+
+    private static final ConstructingObjectParser<Map.Entry<String, Pattern>, Void> ENTRY_PARSER = new ConstructingObjectParser<>(
+        "get_auto_follow_pattern_response", args -> new AbstractMap.SimpleEntry<>((String) args[0], (Pattern) args[1]));
+
+    static {
+        ENTRY_PARSER.declareString(ConstructingObjectParser.constructorArg(), NAME_FIELD);
+        ENTRY_PARSER.declareObject(ConstructingObjectParser.constructorArg(), Pattern.PARSER, PATTERN_FIELD);
+    }
+
+    private static final ConstructingObjectParser<GetAutoFollowPatternResponse, Void> PARSER = new ConstructingObjectParser<>(
+        "get_auto_follow_pattern_response", args -> {
+            @SuppressWarnings("unchecked")
+            List<Map.Entry<String, Pattern>> entries = (List<Map.Entry<String, Pattern>>) args[0];
+            return new GetAutoFollowPatternResponse(new TreeMap<>(entries.stream()
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue))));
+    });
+
+    static {
+        PARSER.declareObjectArray(ConstructingObjectParser.constructorArg(), ENTRY_PARSER, PATTERNS_FIELD);
+    }
+
+    public static GetAutoFollowPatternResponse fromXContent(final XContentParser parser) {
+        return PARSER.apply(parser, null);
     }
 
-    private final Map<String, Pattern> patterns;
+    private final NavigableMap<String, Pattern> patterns;
 
-    GetAutoFollowPatternResponse(Map<String, Pattern> patterns) {
-        this.patterns = Collections.unmodifiableMap(patterns);
+    GetAutoFollowPatternResponse(NavigableMap<String, Pattern> patterns) {
+        this.patterns = Collections.unmodifiableNavigableMap(patterns);
     }
 
-    public Map<String, Pattern> getPatterns() {
+    public NavigableMap<String, Pattern> getPatterns() {
         return patterns;
     }
 

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

@@ -27,8 +27,9 @@
 
 import java.io.IOException;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.Map;
+import java.util.NavigableMap;
+import java.util.TreeMap;
 
 import static org.elasticsearch.client.ccr.PutAutoFollowPatternRequest.FOLLOW_PATTERN_FIELD;
 import static org.elasticsearch.client.ccr.PutAutoFollowPatternRequest.LEADER_PATTERNS_FIELD;
@@ -48,7 +49,7 @@ public void testFromXContent() throws IOException {
 
     private GetAutoFollowPatternResponse createTestInstance() {
         int numPatterns = randomIntBetween(0, 16);
-        Map<String, GetAutoFollowPatternResponse.Pattern> patterns = new HashMap<>(numPatterns);
+        NavigableMap<String, GetAutoFollowPatternResponse.Pattern> patterns = new TreeMap<>();
         for (int i = 0; i < numPatterns; i++) {
             GetAutoFollowPatternResponse.Pattern pattern = new GetAutoFollowPatternResponse.Pattern(
                 randomAlphaOfLength(4), Collections.singletonList(randomAlphaOfLength(4)), randomAlphaOfLength(4));
@@ -90,17 +91,26 @@ private GetAutoFollowPatternResponse createTestInstance() {
     public static void toXContent(GetAutoFollowPatternResponse response, XContentBuilder builder) throws IOException {
         builder.startObject();
         {
+            builder.startArray(GetAutoFollowPatternResponse.PATTERNS_FIELD.getPreferredName());
             for (Map.Entry<String, GetAutoFollowPatternResponse.Pattern> entry : response.getPatterns().entrySet()) {
-                builder.startObject(entry.getKey());
-                GetAutoFollowPatternResponse.Pattern pattern = entry.getValue();
-                builder.field(REMOTE_CLUSTER_FIELD.getPreferredName(), pattern.getRemoteCluster());
-                builder.field(LEADER_PATTERNS_FIELD.getPreferredName(), pattern.getLeaderIndexPatterns());
-                if (pattern.getFollowIndexNamePattern()!= null) {
-                    builder.field(FOLLOW_PATTERN_FIELD.getPreferredName(), pattern.getFollowIndexNamePattern());
+                builder.startObject();
+                {
+                    builder.field(GetAutoFollowPatternResponse.NAME_FIELD.getPreferredName(), entry.getKey());
+                    builder.startObject(GetAutoFollowPatternResponse.PATTERN_FIELD.getPreferredName());
+                    {
+                        GetAutoFollowPatternResponse.Pattern pattern = entry.getValue();
+                        builder.field(REMOTE_CLUSTER_FIELD.getPreferredName(), pattern.getRemoteCluster());
+                        builder.field(LEADER_PATTERNS_FIELD.getPreferredName(), pattern.getLeaderIndexPatterns());
+                        if (pattern.getFollowIndexNamePattern()!= null) {
+                            builder.field(FOLLOW_PATTERN_FIELD.getPreferredName(), pattern.getFollowIndexNamePattern());
+                        }
+                        entry.getValue().toXContentFragment(builder, ToXContent.EMPTY_PARAMS);
+                    }
+                    builder.endObject();
                 }
-                entry.getValue().toXContentFragment(builder, ToXContent.EMPTY_PARAMS);
                 builder.endObject();
             }
+            builder.endArray();
         }
         builder.endObject();
     }

client/rest-high-level/src/test/java/org/elasticsearch/client/ccr/GetAutoFollowPatternResponseTests.java

@@ -18,6 +18,15 @@ for the +{response}+ to be returned before continuing with code execution:
 include-tagged::{doc-tests-file}[{api}-execute]
 --------------------------------------------------
 
+Synchronous calls may throw an `IOException` in case of either failing to
+parse the REST response in the high-level REST client, the request times out
+or similar cases where there is no response coming back from the server.
+
+In cases where the server returns a `4xx` or `5xx` error code, the high-level
+client tries to parse the response body error details instead and then throws
+a generic `ElasticsearchException` and adds the original `ResponseException` as a
+suppressed exception to it.
+
 [id="{upid}-{api}-async"]
 ==== Asynchronous Execution
 
@@ -36,7 +45,8 @@ the execution completes
 The asynchronous method does not block and returns immediately. Once it is
 completed the `ActionListener` is called back using the `onResponse` method
 if the execution successfully completed or using the `onFailure` method if
-it failed.
+it failed. Failure scenarios and expected exceptions are the same as in the
+synchronous execution case.
 
 A typical listener for +{api}+ looks like:
 
@@ -45,4 +55,4 @@ A typical listener for +{api}+ looks like:
 include-tagged::{doc-tests-file}[{api}-execute-listener]
 --------------------------------------------------
 <1> Called when the execution is successfully completed.
-<2> Called when the whole +{request}+ fails.
+<2> Called when the whole +{request}+ fails.

docs/java-rest/high-level/execution.asciidoc

@@ -87,15 +87,19 @@ The API returns the following result:
 [source,js]
 --------------------------------------------------
 {
-  "my_auto_follow_pattern" :
-  {
-    "remote_cluster" : "remote_cluster",
-    "leader_index_patterns" :
-    [
-      "leader_index*"
-    ],
-    "follow_index_pattern" : "{{leader_index}}-follower"
-  }
+  "patterns": [
+    {
+      "name": "my_auto_follow_pattern",
+      "pattern": {
+        "remote_cluster" : "remote_cluster",
+        "leader_index_patterns" :
+        [
+          "leader_index*"
+        ],
+        "follow_index_pattern" : "{{leader_index}}-follower"
+      }
+    }
+  ]
 }
 --------------------------------------------------
 // TESTRESPONSE

docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc

@@ -1,30 +1,31 @@
 [role="xpack"]
+[testenv="gold"]
 [[security-files]]
-=== Security Files
+=== Security files
 
-{security} uses the following files:
+The {es} {security-features} use the following files:
 
-* `ES_PATH_CONF/roles.yml` defines the roles in use on the cluster
-  (read more <<roles-management-file, here>>).
+* `ES_PATH_CONF/roles.yml` defines the roles in use on the cluster. See
+{stack-ov}/defining-roles.html[Defining roles].
 
 * `ES_PATH_CONF/elasticsearch-users` defines the users and their hashed passwords for
-  the <<file-realm,`file` realm>>.
+  the `file` realm. See <<configuring-file-realm>>.
 
 * `ES_PATH_CONF/elasticsearch-users_roles` defines the user roles assignment for the
-  the <<file-realm, `file` realm>>.
+  the `file` realm. See <<configuring-file-realm>>.
 
 * `ES_PATH_CONF/role_mapping.yml` defines the role assignments for a
   Distinguished Name (DN) to a role. This allows for LDAP and Active Directory
-  groups and users and PKI users to be mapped to roles (read more
-  <<mapping-roles, here>>).
+  groups and users and PKI users to be mapped to roles. See
+  {stack-ov}/mapping-roles.html[Mapping users and groups to roles].
 
-* `ES_PATH_CONF/log4j2.properties` contains audit information (read more
-  <<logging-file, here>>).
+* `ES_PATH_CONF/log4j2.properties` contains audit information. See
+{stack-ov}/audit-log-output.html[Logfile audit output].
 
 [[security-files-location]]
 
-IMPORTANT:  Any files that {security} uses must be stored in the Elasticsearch
-            configuration directory. Elasticsearch runs with restricted permissions
+IMPORTANT:  Any files that the {security-features} use must be stored in the {es}
+            configuration directory. {es} runs with restricted permissions
             and is only permitted to read from the locations configured in the
             directory layout for enhanced security.