com.google.gerrit.server.account.externalids.storage.notedb.ExternalIdsNoteDbImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.10.0
// Copyright (C) 2023 The Android Open Source Project
//
// Licensed 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 com.google.gerrit.server.account.externalids.storage.notedb;

import static com.google.common.collect.ImmutableSet.toImmutableSet;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSetMultimap;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.entities.Account;
import com.google.gerrit.server.account.externalids.ExternalId;
import com.google.gerrit.server.account.externalids.ExternalIdCache;
import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory;
import com.google.gerrit.server.account.externalids.ExternalIds;
import com.google.gerrit.server.config.AuthConfig;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.io.IOException;
import java.util.Optional;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.ObjectId;

/**
 * Class to access external IDs.
 *
 * The external IDs are either read from NoteDb or retrieved from the cache.
 */
@Singleton
public class ExternalIdsNoteDbImpl implements ExternalIds {
  private final ExternalIdReader externalIdReader;
  @Nullable private final ExternalIdCacheImpl externalIdCache;
  private final AuthConfig authConfig;
  private final ExternalIdKeyFactory externalIdKeyFactory;

  @Inject
  ExternalIdsNoteDbImpl(
      ExternalIdReader externalIdReader,
      ExternalIdCache externalIdCache,
      ExternalIdKeyFactory externalIdKeyFactory,
      AuthConfig authConfig) {
    this.externalIdReader = externalIdReader;
    if (externalIdCache instanceof ExternalIdCacheImpl) {
      this.externalIdCache = (ExternalIdCacheImpl) externalIdCache;
    } else if (externalIdCache instanceof DisabledExternalIdCache) {
      // Supported case for testing only. Non of the disabled cache methods should be called, so
      // it's safe to not assign the var.
      this.externalIdCache = null;
    } else {
      throw new IllegalStateException(
          "The cache provided in ExternalIdsNoteDbImpl should be either ExternalIdCacheImpl or"
              + " DisabledExternalIdCache");
    }
    this.externalIdKeyFactory = externalIdKeyFactory;
    this.authConfig = authConfig;
  }

  @Override
  public ImmutableSet all() throws IOException, ConfigInvalidException {
    return externalIdReader.all();
  }

  /** Returns all external IDs from the specified revision of the refs/meta/external-ids branch. */
  public ImmutableSet all(ObjectId rev) throws IOException, ConfigInvalidException {
    return externalIdReader.all(rev);
  }

  @Override
  public Optional get(ExternalId.Key key) throws IOException {
    Optional externalId = Optional.empty();
    if (authConfig.isUserNameCaseInsensitiveMigrationMode()) {
      externalId =
          externalIdCache.byKey(externalIdKeyFactory.create(key.scheme(), key.id(), false));
    }
    if (!externalId.isPresent()) {
      externalId = externalIdCache.byKey(key);
    }
    return externalId;
  }

  @Override
  public ImmutableSet byAccount(Account.Id accountId) throws IOException {
    return externalIdCache.byAccount(accountId);
  }

  @Override
  public ImmutableSet byAccount(Account.Id accountId, String scheme)
      throws IOException {
    return byAccount(accountId).stream()
        .filter(e -> e.key().isScheme(scheme))
        .collect(toImmutableSet());
  }

  /** Returns the external IDs of the specified account. */
  public ImmutableSet byAccount(Account.Id accountId, ObjectId rev) throws IOException {
    return externalIdCache.byAccount(accountId, rev);
  }

  @Override
  public ImmutableSetMultimap allByAccount() throws IOException {
    return externalIdCache.allByAccount();
  }

  /**
   * {@inheritDoc}
   *
   * 
The external IDs are retrieved from the external ID cache. Each access to the external ID *
   * cache requires reading the SHA1 of the refs/meta/external-ids branch. If external IDs for *
   * multiple emails are needed it is more efficient to use {@link #byEmails(String...)} as this *
   * method reads the SHA1 of the refs/meta/external-ids branch only once (and not once per email).
   *
   * @see #byEmails(String...)
   */
  @Override
  public ImmutableSet byEmail(String email) throws IOException {
    return externalIdCache.byEmail(email);
  }

  /**
   * {@inheritDoc}
   *
   * The external IDs are retrieved from the external ID cache. Each access to the external ID
   * cache requires reading the SHA1 of the refs/meta/external-ids branch. If external IDs for
   * multiple emails are needed it is more efficient to use this method instead of {@link
   * #byEmail(String)} as this method reads the SHA1 of the refs/meta/external-ids branch only once
   * (and not once per email).
   *
   * @see #byEmail(String)
   */
  @Override
  public ImmutableSetMultimap byEmails(String... emails) throws IOException {
    return externalIdCache.byEmails(emails);
  }
}