[DE-384] search-alias views (#461)

* [DE-157] added support to inBackground parameter in ArangoSearch links

* ViewType.SEARCH_ALIAS

* SearchAlias sync

* SearchAlias async

* SearchAlias sync tests

* disabled ArangoSearchTest for 3.10 cluster

* SearchAlias async tests

(cherry picked from commit 2d175b0)

Author: rashtao

src/main/java/com/arangodb/ArangoDatabase.java

@@ -25,6 +25,7 @@
 import com.arangodb.model.*;
 import com.arangodb.model.arangosearch.AnalyzerDeleteOptions;
 import com.arangodb.model.arangosearch.ArangoSearchCreateOptions;
+import com.arangodb.model.arangosearch.SearchAliasCreateOptions;
 
 import javax.annotation.concurrent.ThreadSafe;
 import java.util.Collection;
@@ -640,14 +641,23 @@ public interface ArangoDatabase extends ArangoSerdeAccessor {
     ArangoView view(String name);
 
     /**
-     * Returns a {@code ArangoSearch} instance for the given ArangoSearch view name.
+     * Returns a {@link ArangoSearch} instance for the given view name.
      *
      * @param name Name of the view
      * @return ArangoSearch view handler
      * @since ArangoDB 3.4.0
      */
     ArangoSearch arangoSearch(String name);
 
+    /**
+     * Returns a {@link SearchAlias} instance for the given view name.
+     *
+     * @param name Name of the view
+     * @return SearchAlias view handler
+     * @since ArangoDB 3.10
+     */
+    SearchAlias searchAlias(String name);
+
     /**
      * Creates a view of the given {@code type}, then returns view information from the server.
      *
@@ -670,6 +680,19 @@ public interface ArangoDatabase extends ArangoSerdeAccessor {
      */
     ViewEntity createArangoSearch(String name, ArangoSearchCreateOptions options);
 
+    /**
+     * Creates a SearchAlias view with the given {@code options}, then returns view information from the server.
+     *
+     * @param name    The name of the view
+     * @param options Additional options, can be null
+     * @return information about the view
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     * @since ArangoDB 3.10
+     */
+    ViewEntity createSearchAlias(String name, SearchAliasCreateOptions options) throws ArangoDBException;
+
     /**
      * Creates an Analyzer
      *

src/main/java/com/arangodb/ArangoSearch.java

@@ -31,7 +31,7 @@
  * Interface for operations on ArangoDB view level for ArangoSearch views.
  *
  * @author Mark Vollmary
- * @see <a href="https://www.arangodb.com/docs/stable/http/views.html">View API Documentation</a>
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">View API Documentation</a>
  * @since ArangoDB 3.4.0
  */
 @ThreadSafe

src/main/java/com/arangodb/SearchAlias.java

@@ -0,0 +1,92 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2018 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb;
+
+import com.arangodb.entity.ViewEntity;
+import com.arangodb.entity.arangosearch.SearchAliasPropertiesEntity;
+import com.arangodb.model.arangosearch.SearchAliasCreateOptions;
+import com.arangodb.model.arangosearch.SearchAliasPropertiesOptions;
+
+/**
+ * Interface for operations on ArangoDB view level for SearchAlias views.
+ *
+ * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html">View API Documentation</a>
+ * @since ArangoDB 3.10
+ */
+public interface SearchAlias extends ArangoView {
+
+    /**
+     * Creates a view, then returns view information from the server.
+     *
+     * @return information about the view
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     */
+    ViewEntity create() throws ArangoDBException;
+
+    /**
+     * Creates a view with the given {@code options}, then returns view information from the server.
+     *
+     * @param options Additional options, can be null
+     * @return information about the view
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     */
+    ViewEntity create(SearchAliasCreateOptions options) throws ArangoDBException;
+
+    /**
+     * Reads the properties of the specified view.
+     *
+     * @return properties of the view
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#read-properties-of-a-view">API
+     * Documentation</a>
+     */
+    SearchAliasPropertiesEntity getProperties() throws ArangoDBException;
+
+    /**
+     * Partially changes properties of the view.
+     *
+     * @param options properties to change
+     * @return properties of the view
+     * @throws ArangoDBException
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/views-search-alias.html#partially-changes-properties-of-a-search-alias-view">API
+     * Documentation</a>
+     */
+    SearchAliasPropertiesEntity updateProperties(SearchAliasPropertiesOptions options) throws ArangoDBException;
+
+    /**
+     * Changes properties of the view.
+     *
+     * @param options properties to change
+     * @return properties of the view
+     * @throws ArangoDBException
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/views-search-alias.html#changes-properties-of-a-search-alias-view">API
+     * Documentation</a>
+     */
+    SearchAliasPropertiesEntity replaceProperties(SearchAliasPropertiesOptions options) throws ArangoDBException;
+
+}

src/main/java/com/arangodb/async/ArangoDatabaseAsync.java

@@ -27,6 +27,7 @@
 import com.arangodb.model.*;
 import com.arangodb.model.arangosearch.AnalyzerDeleteOptions;
 import com.arangodb.model.arangosearch.ArangoSearchCreateOptions;
+import com.arangodb.model.arangosearch.SearchAliasCreateOptions;
 
 import javax.annotation.concurrent.ThreadSafe;
 import java.util.Collection;
@@ -670,14 +671,23 @@ CompletableFuture<GraphEntity> createGraph(
     ArangoViewAsync view(String name);
 
     /**
-     * Returns a {@code ArangoSearchAsync} instance for the given ArangoSearch view name.
+     * Returns a {@link ArangoSearchAsync} instance for the given ArangoSearch view name.
      *
      * @param name Name of the view
      * @return ArangoSearch view handler
      * @since ArangoDB 3.4.0
      */
     ArangoSearchAsync arangoSearch(String name);
 
+    /**
+     * Returns a {@link SearchAliasAsync} instance for the given view name.
+     *
+     * @param name Name of the view
+     * @return SearchAlias view handler
+     * @since ArangoDB 3.10
+     */
+    SearchAliasAsync searchAlias(String name);
+
     /**
      * Creates a view of the given {@code type}, then returns view information from the server.
      *
@@ -700,6 +710,18 @@ CompletableFuture<GraphEntity> createGraph(
      */
     CompletableFuture<ViewEntity> createArangoSearch(String name, ArangoSearchCreateOptions options);
 
+    /**
+     * Creates a SearchAlias view with the given {@code options}, then returns view information from the server.
+     *
+     * @param name    The name of the view
+     * @param options Additional options, can be null
+     * @return information about the view
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     * @since ArangoDB 3.10
+     */
+    CompletableFuture<ViewEntity> createSearchAlias(String name, SearchAliasCreateOptions options);
+
     /**
      * Creates an Analyzer
      *

src/main/java/com/arangodb/async/ArangoSearchAsync.java

@@ -32,7 +32,7 @@
  * Interface for operations on ArangoDB view level for ArangoSearch views.
  *
  * @author Mark Vollmary
- * @see <a href="https://www.arangodb.com/docs/stable/http/views.html">View API Documentation</a>
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">View API Documentation</a>
  * @since ArangoDB 3.4.0
  */
 @ThreadSafe

src/main/java/com/arangodb/async/SearchAliasAsync.java

@@ -0,0 +1,89 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2018 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.async;
+
+import com.arangodb.entity.ViewEntity;
+import com.arangodb.entity.arangosearch.SearchAliasPropertiesEntity;
+import com.arangodb.model.arangosearch.SearchAliasCreateOptions;
+import com.arangodb.model.arangosearch.SearchAliasPropertiesOptions;
+
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Interface for operations on ArangoDB view level for SearchAlias views.
+ *
+ * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html">View API Documentation</a>
+ * @since ArangoDB 3.10
+ */
+public interface SearchAliasAsync extends ArangoViewAsync {
+
+    /**
+     * Creates a view, then returns view information from the server.
+     *
+     * @return information about the view
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     */
+    CompletableFuture<ViewEntity> create();
+
+    /**
+     * Creates a view with the given {@code options}, then returns view information from the server.
+     *
+     * @param options Additional options, can be null
+     * @return information about the view
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#create-a-search-alias-view">API
+     * Documentation</a>
+     */
+    CompletableFuture<ViewEntity> create(SearchAliasCreateOptions options);
+
+    /**
+     * Reads the properties of the specified view.
+     *
+     * @return properties of the view
+     * @see <a href="https://www.arangodb.com/docs/stable/http/views-search-alias.html#read-properties-of-a-view">API
+     * Documentation</a>
+     */
+    CompletableFuture<SearchAliasPropertiesEntity> getProperties();
+
+    /**
+     * Partially changes properties of the view.
+     *
+     * @param options properties to change
+     * @return properties of the view
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/views-search-alias.html#partially-changes-properties-of-a-search-alias-view">API
+     * Documentation</a>
+     */
+    CompletableFuture<SearchAliasPropertiesEntity> updateProperties(SearchAliasPropertiesOptions options);
+
+    /**
+     * Changes properties of the view.
+     *
+     * @param options properties to change
+     * @return properties of the view
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/views-search-alias.html#changes-properties-of-a-search-alias-view">API
+     * Documentation</a>
+     */
+    CompletableFuture<SearchAliasPropertiesEntity> replaceProperties(SearchAliasPropertiesOptions options);
+
+}

src/main/java/com/arangodb/async/internal/ArangoDatabaseAsyncImpl.java

@@ -34,6 +34,7 @@
 import com.arangodb.model.*;
 import com.arangodb.model.arangosearch.AnalyzerDeleteOptions;
 import com.arangodb.model.arangosearch.ArangoSearchCreateOptions;
+import com.arangodb.model.arangosearch.SearchAliasCreateOptions;
 import com.arangodb.velocystream.Request;
 
 import java.util.Collection;
@@ -428,6 +429,11 @@ public ArangoSearchAsync arangoSearch(final String name) {
         return new ArangoSearchAsyncImpl(this, name);
     }
 
+    @Override
+    public SearchAliasAsync searchAlias(String name) {
+        return new SearchAliasAsyncImpl(this, name);
+    }
+
     @Override
     public CompletableFuture<ViewEntity> createView(final String name, final ViewType type) {
         return executor.execute(createViewRequest(name, type), ViewEntity.class);
@@ -439,6 +445,11 @@ public CompletableFuture<ViewEntity> createArangoSearch(final String name,
         return executor.execute(createArangoSearchRequest(name, options), ViewEntity.class);
     }
 
+    @Override
+    public CompletableFuture<ViewEntity> createSearchAlias(String name, SearchAliasCreateOptions options) {
+        return executor.execute(createSearchAliasRequest(name, options), ViewEntity.class);
+    }
+
     @Override
     public CompletableFuture<SearchAnalyzer> createSearchAnalyzer(SearchAnalyzer analyzer) {
         return executor.execute(createAnalyzerRequest(analyzer), SearchAnalyzer.class);