org.apache.solr.handler.admin.api.ListAliases Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.solr.handler.admin.api;

import static org.apache.solr.security.PermissionNameProvider.Name.COLL_READ_PERM;

import jakarta.inject.Inject;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.apache.solr.client.api.endpoint.ListAliasesApi;
import org.apache.solr.client.api.model.GetAliasByNameResponse;
import org.apache.solr.client.api.model.ListAliasesResponse;
import org.apache.solr.common.cloud.Aliases;
import org.apache.solr.common.cloud.ZkStateReader;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.jersey.PermissionName;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;

/** V2 API implementation for listing and inspecting collection aliases */
public class ListAliases extends AdminAPIBase implements ListAliasesApi {

  @Inject
  public ListAliases(
      CoreContainer coreContainer,
      SolrQueryRequest solrQueryRequest,
      SolrQueryResponse solrQueryResponse) {
    super(coreContainer, solrQueryRequest, solrQueryResponse);
  }

  /**
   * V2 API for listing all aliases known by Solr.
   *
   * This API GET /api/aliases is analogous to the v1 GET /api/cluster/aliases
   *  API.
   */
  @Override
  @PermissionName(COLL_READ_PERM)
  public ListAliasesResponse getAliases() throws Exception {
    recordCollectionForLogAndTracing(null, solrQueryRequest);

    final ListAliasesResponse response = instantiateJerseyResponse(ListAliasesResponse.class);
    final Aliases aliases = readAliasesFromZk();

    if (aliases != null) {
      // the aliases themselves...
      response.aliases = aliases.getCollectionAliasMap();
      // Any properties for the above aliases.
      Map> meta = new LinkedHashMap<>();
      for (String alias : aliases.getCollectionAliasListMap().keySet()) {
        Map collectionAliasProperties = aliases.getCollectionAliasProperties(alias);
        if (!collectionAliasProperties.isEmpty()) {
          meta.put(alias, collectionAliasProperties);
        }
      }
      response.properties = meta;
    }

    return response;
  }

  @Override
  @PermissionName(COLL_READ_PERM)
  public GetAliasByNameResponse getAliasByName(String aliasName) throws Exception {
    recordCollectionForLogAndTracing(null, solrQueryRequest);

    final GetAliasByNameResponse response = instantiateJerseyResponse(GetAliasByNameResponse.class);
    response.alias = aliasName;

    final Aliases aliases = readAliasesFromZk();
    if (aliases != null) {
      response.collections = aliases.getCollectionAliasListMap().getOrDefault(aliasName, List.of());
      response.properties = aliases.getCollectionAliasProperties(aliasName);
    }

    return response;
  }

  private Aliases readAliasesFromZk() throws Exception {
    final CoreContainer coreContainer = fetchAndValidateZooKeeperAwareCoreContainer();
    final ZkStateReader zkStateReader = coreContainer.getZkController().getZkStateReader();
    // Make sure we have the latest alias info, since a user has explicitly invoked an alias API
    zkStateReader.getAliasesManager().update();

    return zkStateReader.getAliases();
  }
}