DATAES-38 : Add/Remove/Get Alias Support

Author: mohsinh

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchOperations.java

@@ -21,6 +21,7 @@
 import org.springframework.data.elasticsearch.core.query.*;
 
 import java.util.List;
+import java.util.Set;
 
 /**
  * ElasticsearchOperations
@@ -319,4 +320,27 @@ public interface ElasticsearchOperations {
 	 */
 	<T> Page<T> moreLikeThis(MoreLikeThisQuery query, Class<T> clazz);
 
+    /**
+     * adding new alias
+     *
+     * @param query
+     * @return
+     */
+     Boolean addAlias(AliasQuery query);
+
+    /**
+     * removing previously created alias
+     *
+     * @param query
+     * @return
+     */
+     Boolean removeAlias(AliasQuery query);
+
+    /**
+     * get all the alias pointing to specified index
+     *
+     * @param indexName
+     * @return
+     */
+     Set<String> queryForAlias(String indexName);
 }

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplate.java

@@ -16,6 +16,8 @@
 package org.springframework.data.elasticsearch.core;
 
 import org.apache.commons.collections.CollectionUtils;
+import org.elasticsearch.action.admin.cluster.state.ClusterStateRequest;
+import org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequestBuilder;
 import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
 import org.elasticsearch.action.admin.indices.mapping.delete.DeleteMappingRequest;
 import org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequestBuilder;
@@ -59,6 +61,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import static org.apache.commons.collections.CollectionUtils.isNotEmpty;
 import static org.apache.commons.lang.StringUtils.isBlank;
@@ -544,6 +547,35 @@ public <T> void refresh(Class<T> clazz, boolean waitForOperation) {
                 .refresh(refreshRequest(persistentEntity.getIndexName()).force(waitForOperation)).actionGet();
     }
 
+    public Boolean addAlias(AliasQuery query) {
+        Assert.notNull(query.getIndexName(), "No index defined for Alias");
+        Assert.notNull(query.getAliasName(), "No alias defined");
+        IndicesAliasesRequestBuilder indicesAliasesRequestBuilder = null;
+        if(query.getFilterBuilder() != null) {
+            indicesAliasesRequestBuilder = client.admin().indices().prepareAliases().addAlias(query.getIndexName(), query.getAliasName(), query.getFilterBuilder());
+        } else if(query.getFilter() != null) {
+            indicesAliasesRequestBuilder = client.admin().indices().prepareAliases().addAlias(query.getIndexName(), query.getAliasName(), query.getFilter());
+        } else {
+            indicesAliasesRequestBuilder = client.admin().indices().prepareAliases().addAlias(query.getIndexName(), query.getAliasName());
+        }
+        return indicesAliasesRequestBuilder.execute().actionGet().isAcknowledged();
+    }
+
+    public Boolean removeAlias(AliasQuery query) {
+        Assert.notNull(query.getIndexName(), "No index defined for Alias");
+        Assert.notNull(query.getAliasName(), "No alias defined");
+        return client.admin().indices().prepareAliases().removeAlias(query.getIndexName(), query.getAliasName())
+                .execute().actionGet().isAcknowledged();
+    }
+
+    public Set<String> queryForAlias(String indexName) {
+        ClusterStateRequest clusterStateRequest = Requests.clusterStateRequest()
+                .filterRoutingTable(true)
+                .filterNodes(true)
+                .filteredIndices(indexName);
+        return client.admin().cluster().state(clusterStateRequest).actionGet().getState().getMetaData().aliases().keySet();
+    }
+
     private ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz) {
         Assert.isTrue(clazz.isAnnotationPresent(Document.class), "Unable to identify index name. " + clazz.getSimpleName()
                 + " is not a Document. Make sure the document class is annotated with @Document(indexName=\"foo\")");

src/main/java/org/springframework/data/elasticsearch/core/query/AliasBuilder.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2013 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.elasticsearch.core.query;
+
+import org.elasticsearch.index.query.FilterBuilder;
+
+import java.util.Map;
+/**
+ *
+ * @author Mohsin Husen
+ */
+public class AliasBuilder {
+
+    private String indexName;
+    private String aliasName;
+    private FilterBuilder filterBuilder;
+    private Map<String, Object> filter;
+
+    public AliasBuilder withIndexName(String indexName){
+        this.indexName = indexName;
+        return this;
+    }
+
+    public AliasBuilder withAliasName(String aliasName){
+        this.aliasName = aliasName;
+        return this;
+    }
+
+    public AliasBuilder withFilterBuilder(FilterBuilder filterBuilder){
+        this.filterBuilder = filterBuilder;
+        return this;
+    }
+
+    public  AliasBuilder withFilter(Map<String, Object> filter){
+        this.filter = filter;
+        return this;
+    }
+
+    public AliasQuery build(){
+        AliasQuery aliasQuery = new AliasQuery();
+        aliasQuery.setIndexName(indexName);
+        aliasQuery.setAliasName(aliasName);
+        aliasQuery.setFilterBuilder(filterBuilder);
+        aliasQuery.setFilter(filter);
+        return aliasQuery;
+    }
+}

src/main/java/org/springframework/data/elasticsearch/core/query/AliasQuery.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2013 the original author or authors.
+ *
+ * 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.
+ */
+package org.springframework.data.elasticsearch.core.query;
+import org.elasticsearch.index.query.FilterBuilder;
+import java.util.Map;
+/**
+ *  AliasQuery is useful for creating new alias or deleting existing ones
+ *
+ * @author Mohsin Husen
+ */
+public class AliasQuery {
+
+    private String indexName;
+    private String aliasName;
+    private FilterBuilder filterBuilder;
+    private Map<String, Object> filter;
+
+    public String getIndexName() {
+        return indexName;
+    }
+
+    public void setIndexName(String indexName) {
+        this.indexName = indexName;
+    }
+
+    public String getAliasName() {
+        return aliasName;
+    }
+
+    public void setAliasName(String aliasName) {
+        this.aliasName = aliasName;
+    }
+
+    public FilterBuilder getFilterBuilder() {
+        return filterBuilder;
+    }
+
+    public void setFilterBuilder(FilterBuilder filterBuilder) {
+        this.filterBuilder = filterBuilder;
+    }
+
+    public Map<String, Object> getFilter() {
+        return filter;
+    }
+
+    public void setFilter(Map<String, Object> filter) {
+        this.filter = filter;
+    }
+}

src/test/java/org/springframework/data/elasticsearch/config/EnableElasticsearchRepositoriesTests.java

@@ -46,7 +46,7 @@ static class Config {
 
 		@Bean
 		public ElasticsearchOperations elasticsearchTemplate() {
-			return new ElasticsearchTemplate(nodeBuilder().local(true).clusterName("testCluster").node().client());
+			return new ElasticsearchTemplate(nodeBuilder().local(true).clusterName("testCluster2").node().client());
 		}
 	}
 

src/test/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplateTests.java

@@ -39,6 +39,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Set;
 
 import static org.apache.commons.lang.RandomStringUtils.randomNumeric;
 import static org.elasticsearch.index.query.FilterBuilders.boolFilter;
@@ -858,4 +859,40 @@ public void shouldDeleteDocumentBySpecifiedTypeUsingDeleteQuery() {
         assertThat(sampleEntities.getTotalElements(), equalTo(0L));
     }
 
+    @Test
+    public void shouldAddAlias(){
+        // given
+        elasticsearchTemplate.createIndex(SampleEntity.class);
+        AliasQuery aliasQuery = new AliasBuilder()
+                .withIndexName("test-index")
+                .withAliasName("test-alias").build();
+        // when
+        elasticsearchTemplate.addAlias(aliasQuery);
+        // then
+        Set<String> aliases = elasticsearchTemplate.queryForAlias("test-index");
+        assertThat(aliases, is(notNullValue()));
+        assertThat(aliases.contains("test-alias"), is(true));
+    }
+
+    @Test
+    public void shouldRemoveAlias(){
+        // given
+        elasticsearchTemplate.createIndex(SampleEntity.class);
+        String indexName = "test-index";
+        String aliasName = "test-alias";
+        AliasQuery aliasQuery = new AliasBuilder()
+                .withIndexName(indexName)
+                .withAliasName(aliasName).build();
+        // when
+        elasticsearchTemplate.addAlias(aliasQuery);
+        Set<String> aliases = elasticsearchTemplate.queryForAlias(indexName);
+        assertThat(aliases, is(notNullValue()));
+        assertThat(aliases.contains(aliasName), is(true));
+        // then
+        elasticsearchTemplate.removeAlias(aliasQuery);
+        aliases = elasticsearchTemplate.queryForAlias(indexName);
+        assertThat(aliases, is(notNullValue()));
+        assertThat(aliases.size(), is(0));
+    }
+
 }