Skip to content

Commit 310bda1

Browse files
martijnvgmartijnvg
committed
Refactor AliasOrIndex abstraction.
In order to prepare the `AliasOrIndex` abstraction for the introduction of data streams, the abstraction needs to be made more flexible, because currently it really can be only an alias or an index. * Introduced a `AliasOrIndex.Type` enum to indicate what a `AliasOrIndex` instance is. * Replaced the `isAlias()`` method that returns a boolean with the `getType()`` method that returns the new Type enum. * Moved `getWriteIndex()`` up from the `AliasOrIndex.Alias` to the `AliasOrIndex` interface. * Moved `g`etAliasName()`` up from the `AliasOrIndex.Alias` to the `AliasOrIndex` interface and renamed it to `getName()``. * Removed unnecessary casting to `AliasOrIndex.Alias` by just checking the `getType()`` method. Finally `AliasOrIndex` should be renamed to reflect that it can be more than just an index or alias, since in the near future it can also be a data stream. The name AliasOrIndexOrDataStream is not appealing to me. We can rename it to `Namespace`, but that sounds to generic to me. `ResolvedIndicesExpression` sounds better to me, since it reflects more what it is (an expression from api that has been resolved to alias/index/datasteam), but the name itself is a bit on the long side. Relates to elastic#53100
1 parent c334b20 commit 310bda1

File tree

14 files changed

+93
-81
lines changed

14 files changed

+93
-81
lines changed

‎server/src/main/java/org/elasticsearch/action/admin/indices/rollover/TransportRolloverAction.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ protected void masterOperation(Task task, final RolloverRequest rolloverRequest,
113113
final ActionListener<RolloverResponse> listener) {
114114
final MetaData metaData = state.metaData();
115115
validate(metaData, rolloverRequest);
116-
final AliasOrIndex.Alias alias = (AliasOrIndex.Alias) metaData.getAliasAndIndexLookup().get(rolloverRequest.getAlias());
116+
final AliasOrIndex alias = metaData.getAliasAndIndexLookup().get(rolloverRequest.getAlias());
117117
final IndexMetaData indexMetaData = alias.getWriteIndex();
118-
final AliasMetaData aliasMetaData = indexMetaData.getAliases().get(alias.getAliasName());
118+
final AliasMetaData aliasMetaData = indexMetaData.getAliases().get(alias.getName());
119119
final boolean explicitWriteIndex = Boolean.TRUE.equals(aliasMetaData.writeIndex());
120120
final String sourceProvidedName = indexMetaData.getSettings().get(IndexMetaData.SETTING_INDEX_PROVIDED_NAME,
121121
indexMetaData.getIndex().getName());
@@ -267,12 +267,11 @@ static void validate(MetaData metaData, RolloverRequest request) {
267267
if (aliasOrIndex == null) {
268268
throw new IllegalArgumentException("source alias does not exist");
269269
}
270-
if (aliasOrIndex.isAlias() == false) {
270+
if (aliasOrIndex.getType() != AliasOrIndex.Type.ALIAS) {
271271
throw new IllegalArgumentException("source alias is a concrete index");
272272
}
273-
final AliasOrIndex.Alias alias = (AliasOrIndex.Alias) aliasOrIndex;
274-
if (alias.getWriteIndex() == null) {
275-
throw new IllegalArgumentException("source alias [" + alias.getAliasName() + "] does not point to a write index");
273+
if (aliasOrIndex.getWriteIndex() == null) {
274+
throw new IllegalArgumentException("source alias [" + aliasOrIndex.getName() + "] does not point to a write index");
276275
}
277276
}
278277

‎server/src/main/java/org/elasticsearch/action/bulk/TransportBulkAction.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -280,17 +280,15 @@ static boolean resolvePipelines(final DocWriteRequest<?> originalRequest, final
280280
// check the alias for the index request (this is how normal index requests are modeled)
281281
if (indexMetaData == null && indexRequest.index() != null) {
282282
AliasOrIndex indexOrAlias = metaData.getAliasAndIndexLookup().get(indexRequest.index());
283-
if (indexOrAlias != null && indexOrAlias.isAlias()) {
284-
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) indexOrAlias;
285-
indexMetaData = alias.getWriteIndex();
283+
if (indexOrAlias != null) {
284+
indexMetaData = indexOrAlias.getWriteIndex();
286285
}
287286
}
288287
// check the alias for the action request (this is how upserts are modeled)
289288
if (indexMetaData == null && originalRequest.index() != null) {
290289
AliasOrIndex indexOrAlias = metaData.getAliasAndIndexLookup().get(originalRequest.index());
291-
if (indexOrAlias != null && indexOrAlias.isAlias()) {
292-
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) indexOrAlias;
293-
indexMetaData = alias.getWriteIndex();
290+
if (indexOrAlias != null) {
291+
indexMetaData = indexOrAlias.getWriteIndex();
294292
}
295293
}
296294
if (indexMetaData != null) {

‎server/src/main/java/org/elasticsearch/cluster/metadata/AliasOrIndex.java

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,36 @@
4040
public interface AliasOrIndex {
4141

4242
/**
43-
* @return whether this an alias or concrete index
43+
* @return the type of the namespace
4444
*/
45-
boolean isAlias();
45+
Type getType();
46+
47+
/**
48+
* @return the name of the namespace
49+
*/
50+
String getName();
4651

4752
/**
4853
* @return All {@link IndexMetaData} of all concrete indices this alias is referring to
4954
* or if this is a concrete index its {@link IndexMetaData}
5055
*/
5156
List<IndexMetaData> getIndices();
5257

58+
@Nullable
59+
IndexMetaData getWriteIndex();
60+
5361
/**
5462
* @return whether this alias/index is hidden or not
5563
*/
5664
boolean isHidden();
5765

66+
enum Type {
67+
68+
INDEX,
69+
ALIAS
70+
71+
}
72+
5873
/**
5974
* Represents an concrete index and encapsulates its {@link IndexMetaData}
6075
*/
@@ -67,15 +82,25 @@ public Index(IndexMetaData indexMetaData) {
6782
}
6883

6984
@Override
70-
public boolean isAlias() {
71-
return false;
85+
public String getName() {
86+
return concreteIndex.getIndex().getName();
87+
}
88+
89+
@Override
90+
public Type getType() {
91+
return Type.INDEX;
7292
}
7393

7494
@Override
7595
public List<IndexMetaData> getIndices() {
7696
return Collections.singletonList(concreteIndex);
7797
}
7898

99+
@Override
100+
public IndexMetaData getWriteIndex() {
101+
return concreteIndex;
102+
}
103+
79104
@Override
80105
public boolean isHidden() {
81106
return INDEX_HIDDEN_SETTING.get(concreteIndex.getSettings());
@@ -100,11 +125,11 @@ public Alias(AliasMetaData aliasMetaData, IndexMetaData indexMetaData) {
100125
}
101126

102127
@Override
103-
public boolean isAlias() {
104-
return true;
128+
public Type getType() {
129+
return Type.ALIAS;
105130
}
106131

107-
public String getAliasName() {
132+
public String getName() {
108133
return aliasName;
109134
}
110135

@@ -131,7 +156,7 @@ public boolean isHidden() {
131156
* and filters)
132157
*/
133158
public Iterable<Tuple<String, AliasMetaData>> getConcreteIndexAndAliasMetaDatas() {
134-
return () -> new Iterator<Tuple<String,AliasMetaData>>() {
159+
return () -> new Iterator<>() {
135160

136161
int index = 0;
137162

‎server/src/main/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolver.java

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -194,19 +194,18 @@ Index[] concreteIndices(Context context, String... indexExpressions) {
194194
} else {
195195
continue;
196196
}
197-
} else if (aliasOrIndex.isAlias() && context.getOptions().ignoreAliases()) {
197+
} else if (aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS && context.getOptions().ignoreAliases()) {
198198
if (failNoIndices) {
199199
throw aliasesNotSupportedException(expression);
200200
} else {
201201
continue;
202202
}
203203
}
204204

205-
if (aliasOrIndex.isAlias() && context.isResolveToWriteIndex()) {
206-
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) aliasOrIndex;
207-
IndexMetaData writeIndex = alias.getWriteIndex();
205+
if (aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS && context.isResolveToWriteIndex()) {
206+
IndexMetaData writeIndex = aliasOrIndex.getWriteIndex();
208207
if (writeIndex == null) {
209-
throw new IllegalArgumentException("no write index is defined for alias [" + alias.getAliasName() + "]." +
208+
throw new IllegalArgumentException("no write index is defined for alias [" + aliasOrIndex.getName() + "]." +
210209
" The write index may be explicitly disabled using is_write_index=false or the alias points to multiple" +
211210
" indices without one being designated as a write index");
212211
}
@@ -458,7 +457,7 @@ public Map<String, Set<String>> resolveSearchRouting(ClusterState state, @Nullab
458457

459458
for (String expression : resolvedExpressions) {
460459
AliasOrIndex aliasOrIndex = state.metaData().getAliasAndIndexLookup().get(expression);
461-
if (aliasOrIndex != null && aliasOrIndex.isAlias()) {
460+
if (aliasOrIndex != null && aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS) {
462461
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) aliasOrIndex;
463462
for (Tuple<String, AliasMetaData> item : alias.getConcreteIndexAndAliasMetaDatas()) {
464463
String concreteIndex = item.v1();
@@ -725,7 +724,7 @@ private Set<String> innerResolve(Context context, List<String> expressions, Indi
725724
AliasOrIndex aliasOrIndex = metaData.getAliasAndIndexLookup().get(expression);
726725
if (aliasOrIndex == null) {
727726
throw indexNotFoundException(expression);
728-
} else if (aliasOrIndex.isAlias() && options.ignoreAliases()) {
727+
} else if (aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS && options.ignoreAliases()) {
729728
throw aliasesNotSupportedException(expression);
730729
}
731730
}
@@ -768,7 +767,7 @@ private static void validateAliasOrIndex(String expression) {
768767
private static boolean aliasOrIndexExists(IndicesOptions options, MetaData metaData, String expression) {
769768
AliasOrIndex aliasOrIndex = metaData.getAliasAndIndexLookup().get(expression);
770769
//treat aliases as unavailable indices when ignoreAliases is set to true (e.g. delete index and update aliases api)
771-
return aliasOrIndex != null && (options.ignoreAliases() == false || aliasOrIndex.isAlias() == false);
770+
return aliasOrIndex != null && (options.ignoreAliases() == false || aliasOrIndex.getType() != AliasOrIndex.Type.ALIAS);
772771
}
773772

774773
private static IndexNotFoundException indexNotFoundException(String expression) {
@@ -797,7 +796,7 @@ public static Map<String, AliasOrIndex> matches(Context context, MetaData metaDa
797796
// Can only happen if the expressions was initially: '-*'
798797
if (context.getOptions().ignoreAliases()) {
799798
return metaData.getAliasAndIndexLookup().entrySet().stream()
800-
.filter(e -> e.getValue().isAlias() == false)
799+
.filter(e -> e.getValue().getType() != AliasOrIndex.Type.ALIAS)
801800
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
802801
} else {
803802
return metaData.getAliasAndIndexLookup();
@@ -818,7 +817,7 @@ private static Map<String, AliasOrIndex> suffixWildcard(Context context, MetaDat
818817
SortedMap<String,AliasOrIndex> subMap = metaData.getAliasAndIndexLookup().subMap(fromPrefix, toPrefix);
819818
if (context.getOptions().ignoreAliases()) {
820819
return subMap.entrySet().stream()
821-
.filter(entry -> entry.getValue().isAlias() == false)
820+
.filter(entry -> entry.getValue().getType() != AliasOrIndex.Type.ALIAS)
822821
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
823822
}
824823
return subMap;
@@ -829,7 +828,7 @@ private static Map<String, AliasOrIndex> otherWildcard(Context context, MetaData
829828
return metaData.getAliasAndIndexLookup()
830829
.entrySet()
831830
.stream()
832-
.filter(e -> context.getOptions().ignoreAliases() == false || e.getValue().isAlias() == false)
831+
.filter(e -> context.getOptions().ignoreAliases() == false || e.getValue().getType() != AliasOrIndex.Type.ALIAS)
833832
.filter(e -> Regex.simpleMatch(pattern, e.getKey()))
834833
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
835834
}
@@ -842,7 +841,7 @@ private static Set<String> expand(Context context, IndexMetaData.State excludeSt
842841
AliasOrIndex aliasOrIndex = entry.getValue();
843842

844843
if (aliasOrIndex.isHidden() == false || includeHidden || implicitHiddenMatch(aliasOrIndexName, expression)) {
845-
if (context.isPreserveAliases() && aliasOrIndex.isAlias()) {
844+
if (context.isPreserveAliases() && aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS) {
846845
expand.add(aliasOrIndexName);
847846
} else {
848847
for (IndexMetaData meta : aliasOrIndex.getIndices()) {

‎server/src/main/java/org/elasticsearch/cluster/metadata/MetaData.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ public CoordinationMetaData coordinationMetaData() {
265265
public boolean hasAlias(String alias) {
266266
AliasOrIndex aliasOrIndex = getAliasAndIndexLookup().get(alias);
267267
if (aliasOrIndex != null) {
268-
return aliasOrIndex.isAlias();
268+
return aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS;
269269
} else {
270270
return false;
271271
}
@@ -532,15 +532,14 @@ public String resolveWriteIndexRouting(@Nullable String routing, String aliasOrI
532532
}
533533

534534
AliasOrIndex result = getAliasAndIndexLookup().get(aliasOrIndex);
535-
if (result == null || result.isAlias() == false) {
535+
if (result == null || result.getType() != AliasOrIndex.Type.ALIAS) {
536536
return routing;
537537
}
538-
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) result;
539-
IndexMetaData writeIndex = alias.getWriteIndex();
538+
IndexMetaData writeIndex = result.getWriteIndex();
540539
if (writeIndex == null) {
541540
throw new IllegalArgumentException("alias [" + aliasOrIndex + "] does not have a write index");
542541
}
543-
AliasMetaData aliasMd = writeIndex.getAliases().get(alias.getAliasName());
542+
AliasMetaData aliasMd = writeIndex.getAliases().get(result.getName());
544543
if (aliasMd.indexRouting() != null) {
545544
if (aliasMd.indexRouting().indexOf(',') != -1) {
546545
throw new IllegalArgumentException("index/alias [" + aliasOrIndex + "] provided with routing value ["
@@ -569,7 +568,7 @@ public String resolveIndexRouting(@Nullable String routing, String aliasOrIndex)
569568
}
570569

571570
AliasOrIndex result = getAliasAndIndexLookup().get(aliasOrIndex);
572-
if (result == null || result.isAlias() == false) {
571+
if (result == null || result.getType() != AliasOrIndex.Type.ALIAS) {
573572
return routing;
574573
}
575574
AliasOrIndex.Alias alias = (AliasOrIndex.Alias) result;
@@ -1327,14 +1326,15 @@ private SortedMap<String, AliasOrIndex> buildAliasAndIndexLookup() {
13271326
if (alias == null) {
13281327
return new AliasOrIndex.Alias(aliasMetaData, indexMetaData);
13291328
} else {
1330-
assert alias instanceof AliasOrIndex.Alias : alias.getClass().getName();
1329+
assert alias.getType() == AliasOrIndex.Type.ALIAS : alias.getClass().getName();
13311330
((AliasOrIndex.Alias) alias).addIndex(indexMetaData);
13321331
return alias;
13331332
}
13341333
});
13351334
}
13361335
}
1337-
aliasAndIndexLookup.values().stream().filter(AliasOrIndex::isAlias)
1336+
aliasAndIndexLookup.values().stream()
1337+
.filter(aliasOrIndex -> aliasOrIndex.getType() == AliasOrIndex.Type.ALIAS)
13381338
.forEach(alias -> ((AliasOrIndex.Alias) alias).computeAndValidateAliasProperties());
13391339
return aliasAndIndexLookup;
13401340
}

0 commit comments

Comments
 (0)