/* * 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.action.search; import org.opensearch.Version; import org.opensearch.core.common.bytes.BytesReference; import org.opensearch.core.common.io.stream.ByteBufferStreamInput; import org.opensearch.common.io.stream.BytesStreamOutput; import org.opensearch.core.common.io.stream.NamedWriteableAwareStreamInput; import org.opensearch.core.common.io.stream.NamedWriteableRegistry; import org.opensearch.core.common.io.stream.StreamInput; import org.opensearch.core.common.io.stream.StreamOutput; import org.opensearch.core.common.Strings; import org.opensearch.core.index.shard.ShardId; import org.opensearch.search.SearchPhaseResult; import org.opensearch.search.SearchShardTarget; import org.opensearch.search.internal.AliasFilter; import org.opensearch.transport.RemoteClusterAware; import java.io.IOException; import java.nio.ByteBuffer; import java.util.Base64; import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; /** * Id for a serach context. * * @opensearch.internal */ public class SearchContextId { private final Map shards; private final Map aliasFilter; private SearchContextId(Map shards, Map aliasFilter) { this.shards = shards; this.aliasFilter = aliasFilter; } public Map shards() { return shards; } public Map aliasFilter() { return aliasFilter; } public static String encode(List searchPhaseResults, Map aliasFilter, Version version) { final Map shards = new HashMap<>(); for (SearchPhaseResult searchPhaseResult : searchPhaseResults) { final SearchShardTarget target = searchPhaseResult.getSearchShardTarget(); shards.put( target.getShardId(), new SearchContextIdForNode(target.getClusterAlias(), target.getNodeId(), searchPhaseResult.getContextId()) ); } try (BytesStreamOutput out = new BytesStreamOutput()) { out.setVersion(version); out.writeVersion(version); out.writeMap(shards, (o, k) -> k.writeTo(o), (o, v) -> v.writeTo(o)); out.writeMap(aliasFilter, StreamOutput::writeString, (o, v) -> v.writeTo(o)); return Base64.getUrlEncoder().encodeToString(BytesReference.toBytes(out.bytes())); } catch (IOException e) { throw new IllegalArgumentException(e); } } public static SearchContextId decode(NamedWriteableRegistry namedWriteableRegistry, String id) { final ByteBuffer byteBuffer; try { byteBuffer = ByteBuffer.wrap(Base64.getUrlDecoder().decode(id)); } catch (Exception e) { throw new IllegalArgumentException("invalid id: [" + id + "]", e); } try (StreamInput in = new NamedWriteableAwareStreamInput(new ByteBufferStreamInput(byteBuffer), namedWriteableRegistry)) { final Version version = in.readVersion(); in.setVersion(version); final Map shards = in.readMap(ShardId::new, SearchContextIdForNode::new); final Map aliasFilters = in.readMap(StreamInput::readString, AliasFilter::new); if (in.available() > 0) { throw new IllegalArgumentException("Not all bytes were read"); } return new SearchContextId(Collections.unmodifiableMap(shards), Collections.unmodifiableMap(aliasFilters)); } catch (IOException e) { throw new IllegalArgumentException("invalid id: [" + id + "]", e); } } public String[] getActualIndices() { final Set indices = new HashSet<>(); for (Map.Entry entry : shards().entrySet()) { final String indexName = entry.getKey().getIndexName(); final String clusterAlias = entry.getValue().getClusterAlias(); if (Strings.isEmpty(clusterAlias)) { indices.add(indexName); } else { indices.add(clusterAlias + RemoteClusterAware.REMOTE_CLUSTER_INDEX_SEPARATOR + indexName); } } return indices.toArray(new String[0]); } }