| // Copyright (C) 2009 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; |
| |
| import com.google.common.cache.CacheLoader; |
| import com.google.common.cache.LoadingCache; |
| import com.google.common.flogger.FluentLogger; |
| import com.google.gerrit.entities.AccountGroup; |
| import com.google.gerrit.server.cache.CacheModule; |
| import com.google.gerrit.server.group.InternalGroup; |
| import com.google.gerrit.server.group.db.Groups; |
| import com.google.gerrit.server.logging.Metadata; |
| import com.google.gerrit.server.logging.TraceContext; |
| import com.google.gerrit.server.logging.TraceContext.TraceTimer; |
| import com.google.gerrit.server.query.group.InternalGroupQuery; |
| import com.google.inject.Inject; |
| import com.google.inject.Module; |
| import com.google.inject.Provider; |
| import com.google.inject.Singleton; |
| import com.google.inject.TypeLiteral; |
| import com.google.inject.name.Named; |
| import java.util.Optional; |
| import java.util.concurrent.ExecutionException; |
| |
| /** Tracks group objects in memory for efficient access. */ |
| @Singleton |
| public class GroupCacheImpl implements GroupCache { |
| private static final FluentLogger logger = FluentLogger.forEnclosingClass(); |
| |
| private static final String BYID_NAME = "groups"; |
| private static final String BYNAME_NAME = "groups_byname"; |
| private static final String BYUUID_NAME = "groups_byuuid"; |
| |
| public static Module module() { |
| return new CacheModule() { |
| @Override |
| protected void configure() { |
| cache(BYID_NAME, AccountGroup.Id.class, new TypeLiteral<Optional<InternalGroup>>() {}) |
| .maximumWeight(Long.MAX_VALUE) |
| .loader(ByIdLoader.class); |
| |
| cache(BYNAME_NAME, String.class, new TypeLiteral<Optional<InternalGroup>>() {}) |
| .maximumWeight(Long.MAX_VALUE) |
| .loader(ByNameLoader.class); |
| |
| cache(BYUUID_NAME, String.class, new TypeLiteral<Optional<InternalGroup>>() {}) |
| .maximumWeight(Long.MAX_VALUE) |
| .loader(ByUUIDLoader.class); |
| |
| bind(GroupCacheImpl.class); |
| bind(GroupCache.class).to(GroupCacheImpl.class); |
| } |
| }; |
| } |
| |
| private final LoadingCache<AccountGroup.Id, Optional<InternalGroup>> byId; |
| private final LoadingCache<String, Optional<InternalGroup>> byName; |
| private final LoadingCache<String, Optional<InternalGroup>> byUUID; |
| |
| @Inject |
| GroupCacheImpl( |
| @Named(BYID_NAME) LoadingCache<AccountGroup.Id, Optional<InternalGroup>> byId, |
| @Named(BYNAME_NAME) LoadingCache<String, Optional<InternalGroup>> byName, |
| @Named(BYUUID_NAME) LoadingCache<String, Optional<InternalGroup>> byUUID) { |
| this.byId = byId; |
| this.byName = byName; |
| this.byUUID = byUUID; |
| } |
| |
| @Override |
| public Optional<InternalGroup> get(AccountGroup.Id groupId) { |
| try { |
| return byId.get(groupId); |
| } catch (ExecutionException e) { |
| logger.atWarning().withCause(e).log("Cannot load group %s", groupId); |
| return Optional.empty(); |
| } |
| } |
| |
| @Override |
| public Optional<InternalGroup> get(AccountGroup.NameKey name) { |
| if (name == null) { |
| return Optional.empty(); |
| } |
| try { |
| return byName.get(name.get()); |
| } catch (ExecutionException e) { |
| logger.atWarning().withCause(e).log("Cannot look up group %s by name", name.get()); |
| return Optional.empty(); |
| } |
| } |
| |
| @Override |
| public Optional<InternalGroup> get(AccountGroup.UUID groupUuid) { |
| if (groupUuid == null) { |
| return Optional.empty(); |
| } |
| |
| try { |
| return byUUID.get(groupUuid.get()); |
| } catch (ExecutionException e) { |
| logger.atWarning().withCause(e).log("Cannot look up group %s by uuid", groupUuid.get()); |
| return Optional.empty(); |
| } |
| } |
| |
| @Override |
| public void evict(AccountGroup.Id groupId) { |
| if (groupId != null) { |
| logger.atFine().log("Evict group %s by ID", groupId.get()); |
| byId.invalidate(groupId); |
| } |
| } |
| |
| @Override |
| public void evict(AccountGroup.NameKey groupName) { |
| if (groupName != null) { |
| logger.atFine().log("Evict group '%s' by name", groupName.get()); |
| byName.invalidate(groupName.get()); |
| } |
| } |
| |
| @Override |
| public void evict(AccountGroup.UUID groupUuid) { |
| if (groupUuid != null) { |
| logger.atFine().log("Evict group %s by UUID", groupUuid.get()); |
| byUUID.invalidate(groupUuid.get()); |
| } |
| } |
| |
| static class ByIdLoader extends CacheLoader<AccountGroup.Id, Optional<InternalGroup>> { |
| private final Provider<InternalGroupQuery> groupQueryProvider; |
| |
| @Inject |
| ByIdLoader(Provider<InternalGroupQuery> groupQueryProvider) { |
| this.groupQueryProvider = groupQueryProvider; |
| } |
| |
| @Override |
| public Optional<InternalGroup> load(AccountGroup.Id key) throws Exception { |
| try (TraceTimer timer = |
| TraceContext.newTimer( |
| "Loading group by ID", Metadata.builder().groupId(key.get()).build())) { |
| return groupQueryProvider.get().byId(key); |
| } |
| } |
| } |
| |
| static class ByNameLoader extends CacheLoader<String, Optional<InternalGroup>> { |
| private final Provider<InternalGroupQuery> groupQueryProvider; |
| |
| @Inject |
| ByNameLoader(Provider<InternalGroupQuery> groupQueryProvider) { |
| this.groupQueryProvider = groupQueryProvider; |
| } |
| |
| @Override |
| public Optional<InternalGroup> load(String name) throws Exception { |
| try (TraceTimer timer = |
| TraceContext.newTimer( |
| "Loading group by name", Metadata.builder().groupName(name).build())) { |
| return groupQueryProvider.get().byName(AccountGroup.nameKey(name)); |
| } |
| } |
| } |
| |
| static class ByUUIDLoader extends CacheLoader<String, Optional<InternalGroup>> { |
| private final Groups groups; |
| |
| @Inject |
| ByUUIDLoader(Groups groups) { |
| this.groups = groups; |
| } |
| |
| @Override |
| public Optional<InternalGroup> load(String uuid) throws Exception { |
| try (TraceTimer timer = |
| TraceContext.newTimer( |
| "Loading group by UUID", Metadata.builder().groupUuid(uuid).build())) { |
| return groups.getGroup(AccountGroup.uuid(uuid)); |
| } |
| } |
| } |
| } |