java/com/google/gerrit/server/account/externalids/ExternalIds.java

// 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;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSetMultimap;
import com.google.gerrit.entities.Account;
import java.io.IOException;
import java.util.Optional;
import org.eclipse.jgit.errors.ConfigInvalidException;

public interface ExternalIds {
  /** Returns all external IDs. */
  ImmutableSet<ExternalId> all() throws IOException, ConfigInvalidException;

  /** Returns the specified external ID. */
  Optional<ExternalId> get(ExternalId.Key key) throws IOException;

  /** Returns the external IDs of the specified account. */
  ImmutableSet<ExternalId> byAccount(Account.Id accountId) throws IOException;

  /** Returns the external IDs of the specified account that have the given scheme. */
  ImmutableSet<ExternalId> byAccount(Account.Id accountId, String scheme) throws IOException;

  /** Returns all external IDs by account. */
  ImmutableSetMultimap<Account.Id, ExternalId> allByAccount() throws IOException;

  /**
   * Returns the external ID with the given email.
   *
   * <p>Each email should belong to a single external ID only. This means if more than one external
   * ID is returned there is an inconsistency in the external IDs.
   *
   * <p>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...)
   */
  ImmutableSet<ExternalId> byEmail(String email) throws IOException;

  /**
   * Returns the external IDs for the given emails.
   *
   * <p>Each email should belong to a single external ID only. This means if more than one external
   * ID for an email is returned there is an inconsistency in the external IDs.
   *
   * <p>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)
   */
  ImmutableSetMultimap<String, ExternalId> byEmails(String... emails) throws IOException;
}