From 74c7b5a197b1a0df3dceef7aad9610bfb9046c1f Mon Sep 17 00:00:00 2001 From: javanna Date: Tue, 27 Jan 2015 19:22:06 +0100 Subject: [PATCH] Internal: add AliasesRequest interface to mark requests that manage aliases We currently have the IndicesRequest interface to mark indices related requests and be able to retrieve the indices they relate to in a generic way. This commit introduces a similar abstraction for requests that manage aliases, to be able to retrieve/replace the aliases they relate to. Also, IndicesAliasesRequest becomes a CompositeIndicesRequest, as it allows to perform multiple operations (e.g. add/remote multiple aliases). Each single operation (AliasActions) implements now the newly introduced AliasesRequest. AliasesRequest is also implemented by GetAliasesRequest, which allows to retrieve aliases information. Closes #9460 --- .../elasticsearch/action/AliasesRequest.java | 44 +++++++++ .../indices/alias/IndicesAliasesRequest.java | 90 ++++++++++--------- .../alias/IndicesAliasesRequestBuilder.java | 9 +- .../alias/TransportIndicesAliasesAction.java | 9 +- .../indices/alias/get/GetAliasesRequest.java | 11 ++- .../cluster/metadata/MetaData.java | 4 +- .../alias/put/RestIndexPutAliasAction.java | 5 +- .../aliases/IndexAliasesTests.java | 11 +-- 8 files changed, 116 insertions(+), 67 deletions(-) create mode 100644 src/main/java/org/elasticsearch/action/AliasesRequest.java diff --git a/src/main/java/org/elasticsearch/action/AliasesRequest.java b/src/main/java/org/elasticsearch/action/AliasesRequest.java new file mode 100644 index 00000000000..6e45af0cf84 --- /dev/null +++ b/src/main/java/org/elasticsearch/action/AliasesRequest.java @@ -0,0 +1,44 @@ +/* + * 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.action; + +/** + * Needs to be implemented by all {@link org.elasticsearch.action.ActionRequest} subclasses that relate to + * one or more indices and one or more aliases. Meant to be used for aliases management requests (e.g. add/remove alias, + * get aliases) that hold aliases and indices in separate fields. + * Allows to retrieve which indices and aliases the action relates to. + */ +public interface AliasesRequest extends IndicesRequest.Replaceable { + + /** + * Returns the array of aliases that the action relates to + */ + String[] aliases(); + + /** + * Sets the array of aliases that the action relates to + */ + AliasesRequest aliases(String[] aliases); + + /** + * Returns true if wildcards expressions among aliases should be resolved, false otherwise + */ + boolean expandAliasesWildcards(); +} diff --git a/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequest.java b/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequest.java index 85df3efd8a8..769d0389449 100644 --- a/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequest.java +++ b/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequest.java @@ -22,8 +22,9 @@ package org.elasticsearch.action.admin.indices.alias; import com.carrotsearch.hppc.cursors.ObjectCursor; import com.google.common.collect.ImmutableList; import com.google.common.collect.Lists; -import org.elasticsearch.ElasticsearchIllegalArgumentException; import org.elasticsearch.action.ActionRequestValidationException; +import org.elasticsearch.action.AliasesRequest; +import org.elasticsearch.action.CompositeIndicesRequest; import org.elasticsearch.action.IndicesRequest; import org.elasticsearch.action.support.IndicesOptions; import org.elasticsearch.action.support.master.AcknowledgedRequest; @@ -39,7 +40,10 @@ import org.elasticsearch.common.util.CollectionUtils; import org.elasticsearch.index.query.FilterBuilder; import java.io.IOException; -import java.util.*; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Map; import static org.elasticsearch.action.ValidateActions.addValidationError; import static org.elasticsearch.cluster.metadata.AliasAction.readAliasAction; @@ -47,11 +51,13 @@ import static org.elasticsearch.cluster.metadata.AliasAction.readAliasAction; /** * A request to add/remove aliases for one or more indices. */ -public class IndicesAliasesRequest extends AcknowledgedRequest implements IndicesRequest { +public class IndicesAliasesRequest extends AcknowledgedRequest implements CompositeIndicesRequest { private List allAliasActions = Lists.newArrayList(); - - private IndicesOptions indicesOptions = IndicesOptions.fromOptions(false, false, true, false); + + //indices options that require every specified index to exist, expand wildcards only to open indices and + //don't allow that no indices are resolved from wildcard expressions + private static final IndicesOptions INDICES_OPTIONS = IndicesOptions.fromOptions(false, false, true, false); public IndicesAliasesRequest() { @@ -64,11 +70,11 @@ public class IndicesAliasesRequest extends AcknowledgedRequest finalIndices = new ArrayList<>(); - for (String index : indices) { - if (index != null) { - finalIndices.add(index); - } - } - this.indices = finalIndices.toArray(new String[finalIndices.size()]); + + @Override + public AliasActions indices(String... indices) { + this.indices = indices; + return this; } - - public void aliases(String... aliases) { + + @Override + public AliasActions aliases(String... aliases) { this.aliases = aliases; + return this; } - + + @Override public String[] aliases() { return aliases; } - + + @Override + public boolean expandAliasesWildcards() { + //remove operations support wildcards among aliases, add operations don't + return aliasAction.actionType() == Type.REMOVE; + } + + @Override public String[] indices() { return indices; } + @Override + public IndicesOptions indicesOptions() { + return INDICES_OPTIONS; + } + public AliasAction aliasAction() { return aliasAction; } public String[] concreteAliases(MetaData metaData, String concreteIndex) { - if (aliasAction.actionType() == Type.REMOVE) { + if (expandAliasesWildcards()) { //for DELETE we expand the aliases String[] indexAsArray = {concreteIndex}; ImmutableOpenMap> aliasMetaData = metaData.findAliases(aliases, indexAsArray); @@ -295,32 +309,21 @@ public class IndicesAliasesRequest extends AcknowledgedRequest indices = Lists.newArrayList(); - for (AliasActions aliasActions : aliasActions()) { - if (!CollectionUtils.isEmpty(aliasActions.indices())) { - Collections.addAll(indices, aliasActions.indices); - } - } - return indices.toArray(new String[indices.size()]); - } - @Override public void readFrom(StreamInput in) throws IOException { super.readFrom(in); @@ -341,14 +344,17 @@ public class IndicesAliasesRequest extends AcknowledgedRequest subRequests() { + return allAliasActions; + } } diff --git a/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequestBuilder.java b/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequestBuilder.java index f9877fff2f1..3052949227b 100644 --- a/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequestBuilder.java +++ b/src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesRequestBuilder.java @@ -51,7 +51,7 @@ public class IndicesAliasesRequestBuilder extends AcknowledgedRequestBuilder implements IndicesRequest.Replaceable { +public class GetAliasesRequest extends MasterNodeReadOperationRequest implements AliasesRequest { private String[] indices = Strings.EMPTY_ARRAY; private String[] aliases = Strings.EMPTY_ARRAY; @@ -55,6 +55,7 @@ public class GetAliasesRequest extends MasterNodeReadOperationRequest { return mapBuilder.build(); } - private boolean matchAllAliases(final String[] aliases) { + private static boolean matchAllAliases(final String[] aliases) { for (String alias : aliases) { - if (alias.equals("_all")) { + if (alias.equals(ALL)) { return true; } } diff --git a/src/main/java/org/elasticsearch/rest/action/admin/indices/alias/put/RestIndexPutAliasAction.java b/src/main/java/org/elasticsearch/rest/action/admin/indices/alias/put/RestIndexPutAliasAction.java index 2dcaf976afc..227deb11918 100644 --- a/src/main/java/org/elasticsearch/rest/action/admin/indices/alias/put/RestIndexPutAliasAction.java +++ b/src/main/java/org/elasticsearch/rest/action/admin/indices/alias/put/RestIndexPutAliasAction.java @@ -29,7 +29,10 @@ import org.elasticsearch.common.inject.Inject; import org.elasticsearch.common.settings.Settings; import org.elasticsearch.common.xcontent.XContentFactory; import org.elasticsearch.common.xcontent.XContentParser; -import org.elasticsearch.rest.*; +import org.elasticsearch.rest.BaseRestHandler; +import org.elasticsearch.rest.RestChannel; +import org.elasticsearch.rest.RestController; +import org.elasticsearch.rest.RestRequest; import org.elasticsearch.rest.action.support.AcknowledgedRestListener; import java.util.Map; diff --git a/src/test/java/org/elasticsearch/aliases/IndexAliasesTests.java b/src/test/java/org/elasticsearch/aliases/IndexAliasesTests.java index f09c1cb1532..3b7f7c55643 100644 --- a/src/test/java/org/elasticsearch/aliases/IndexAliasesTests.java +++ b/src/test/java/org/elasticsearch/aliases/IndexAliasesTests.java @@ -762,11 +762,9 @@ public class IndexAliasesTests extends ElasticsearchIntegrationTest { assertAcked(admin().indices().prepareAliases().addAliasAction(AliasAction.newAddAliasAction(null, "alias1"))); fail("create alias should have failed due to null index"); } catch (ElasticsearchIllegalArgumentException e) { - assertThat("Exception text does not contain \"Property [index] was either missing or null\"", - e.getMessage().contains("Property [index] was either missing or null"), - equalTo(true)); + assertThat("Exception text does not contain \"Alias action [add]: [index] may not be empty string\"", + e.getMessage(), containsString("Alias action [add]: [index] may not be empty string")); } - } @Test @@ -781,9 +779,8 @@ public class IndexAliasesTests extends ElasticsearchIntegrationTest { assertAcked(admin().indices().prepareAliases().addAlias((String) null, "empty-alias")); fail("create alias should have failed due to null index"); } catch (ElasticsearchIllegalArgumentException e) { - assertThat("Exception text does not contain \"Property [index] was either missing or null\"", - e.getMessage().contains("Property [index] was either missing or null"), - equalTo(true)); + assertThat("Exception text does not contain \"Alias action [add]: [index] may not be empty string\"", + e.getMessage(), containsString("Alias action [add]: [index] may not be empty string")); } }