com.google.gerrit.server.account.externalids.ExternalIdCache Maven / Gradle / Ivy
// Copyright (C) 2016 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;
/**
* Caches external IDs of all accounts. Note that the granularity is "revision" only, so each update
* will cache a new value containing all external IDs.
*
* On each cache access the SHA1 of the refs/meta/external-ids branch is read to verify that the
* cache is up to date.
*
*
All returned collections are unmodifiable.
*
*
NOTE: Modules which bind {@link ExternalIdCache} by using modules other than {@link
* com.google.gerrit.server.account.externalids.storage.notedb.ExternalIdCacheImpl.ExternalIdCacheBindingModule},
* should also provide an {@code Optional<}{@link
* com.google.gerrit.server.account.externalids.storage.notedb.ExternalIdCacheImpl}{@code >}
* binding.
*/
public interface ExternalIdCache {
Optional byKey(ExternalId.Key key) throws IOException;
ImmutableSet byAccount(Account.Id accountId) throws IOException;
ImmutableSetMultimap allByAccount() throws IOException;
ImmutableSetMultimap byEmails(String... emails) throws IOException;
ImmutableSetMultimap allByEmail() throws IOException;
default ImmutableSet byEmail(String email) throws IOException {
return byEmails(email).get(email);
}
}