/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.index.query; import org.opensearch.action.support.IndicesOptions; import org.opensearch.cluster.metadata.IndexNameExpressionResolver; import org.opensearch.cluster.service.ClusterService; import org.opensearch.common.regex.Regex; import org.opensearch.transport.RemoteClusterAware; import java.util.function.Predicate; /** * A predicate that checks whether an index pattern matches the current search shard target. * * @opensearch.internal */ public class SearchIndexNameMatcher implements Predicate { private final String indexName; private final String clusterAlias; private final ClusterService clusterService; private final IndexNameExpressionResolver expressionResolver; /** * Creates a new index name matcher. * * @param indexName he name of the local index. * @param clusterAlias the cluster alias of this search shard target. If it is a local target, the alias * should be null or equal to {@link RemoteClusterAware#LOCAL_CLUSTER_GROUP_KEY}. * @param clusterService the cluster service. */ public SearchIndexNameMatcher( String indexName, String clusterAlias, ClusterService clusterService, IndexNameExpressionResolver expressionResolver ) { this.indexName = indexName; this.clusterAlias = RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY.equals(clusterAlias) ? null : clusterAlias; this.clusterService = clusterService; this.expressionResolver = expressionResolver; } /** * Given an index pattern, checks whether it matches against the current shard. * * If this shard represents a remote shard target, then in order to match the pattern contain * the separator ':', and must match on both the cluster alias and index name. */ public boolean test(String pattern) { int separatorIndex = pattern.indexOf(RemoteClusterAware.REMOTE_CLUSTER_INDEX_SEPARATOR); if (separatorIndex < 0) { return clusterAlias == null && matchesIndex(pattern); } else { String clusterPattern = pattern.substring(0, separatorIndex); String indexPattern = pattern.substring(separatorIndex + 1); return Regex.simpleMatch(clusterPattern, clusterAlias) && matchesIndex(indexPattern); } } private boolean matchesIndex(String pattern) { String[] concreteIndices = expressionResolver.concreteIndexNames( clusterService.state(), IndicesOptions.lenientExpandOpen(), true, pattern ); for (String index : concreteIndices) { if (Regex.simpleMatch(index, indexName)) { return true; } } return false; } }