Package com.google.gerrit.server.project

Class ProjectCacheImpl

java.lang.Object

com.google.gerrit.server.project.ProjectCacheImpl

All Implemented Interfaces:

ProjectCache

public class ProjectCacheImpl
extends Object
implements ProjectCache

Cache of project information, including access rights.

The data of a project is the project's project.config in refs/meta/config parsed out as an immutable value. It's keyed purely by the refs/meta/config SHA-1. We also cache the same value keyed by name. The latter mapping can become outdated, so data must be evicted explicitly.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CACHE_LIST
static String	CACHE_NAME
static String	PERSISTED_CACHE_NAME

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableSortedSet<Project.NameKey>	all()	Returns sorted iteration of projects.
static byte[]	allProjectsFileProjectConfigHash(Optional<org.eclipse.jgit.lib.StoredConfig> allProjectsConfig)	Returns a MurMur128 hash of the contents of etc/All-Projects-project.config.
com.google.common.collect.ImmutableSortedSet<Project.NameKey>	byName(String pfx)	Filter the set of registered project names by common prefix.
void	evict(Project.NameKey p)	Invalidate the cached information about the given project.
void	evictAllByName()
void	evictAndReindex(Project p)	Invalidate the cached information about the given project, and triggers reindexing for it
void	evictAndReindex(Project.NameKey p)	Invalidate the cached information about the given project, and triggers reindexing for it
Optional<ProjectState>	get(Project.NameKey projectName)	Get the cached data for a project by its unique name.
ProjectState	getAllProjects()	Returns the parent state for all projects on this server.
ProjectState	getAllUsers()	Returns the project state of the project storing meta data for all users.
Set<AccountGroup.UUID>	guessRelevantGroupUUIDs()	Returns estimated set of relevant groups extracted from hot project access rules.
static com.google.inject.Module	module()
void	onCreateProject(Project.NameKey newProjectName)	Notify the cache that a new project was constructed.
void	remove(Project p)	Remove information about the given project from the cache.
void	remove(Project.NameKey name)	Remove information about the given project from the cache.
long	sizeAllByName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

PERSISTED_CACHE_NAME

public static final String PERSISTED_CACHE_NAME

See Also:

Constant Field Values

CACHE_LIST

public static final String CACHE_LIST

See Also:

Constant Field Values

Method Detail

module

public static com.google.inject.Module module()

getAllProjects

public ProjectState getAllProjects()

Description copied from interface: ProjectCache

Returns the parent state for all projects on this server.

Specified by:

getAllProjects in interface ProjectCache

getAllUsers

public ProjectState getAllUsers()

Description copied from interface: ProjectCache

Returns the project state of the project storing meta data for all users.

Specified by:

getAllUsers in interface ProjectCache

get

public Optional<ProjectState> get(Project.NameKey projectName)

Description copied from interface: ProjectCache

Get the cached data for a project by its unique name.

Specified by:

get in interface ProjectCache

Parameters:

projectName - name of the project.

Returns:

an Optional wrapping the cached data; absent if no such project exists or the projectName is null

evict

public void evict(Project.NameKey p)

Description copied from interface: ProjectCache

Invalidate the cached information about the given project.

Specified by:

evict in interface ProjectCache

Parameters:

p - the NameKey of the project that is being evicted

evictAndReindex

public void evictAndReindex(Project p)

Description copied from interface: ProjectCache

Invalidate the cached information about the given project, and triggers reindexing for it

Specified by:

evictAndReindex in interface ProjectCache

Parameters:

p - project that is being evicted

evictAndReindex

public void evictAndReindex(Project.NameKey p)

Description copied from interface: ProjectCache

Invalidate the cached information about the given project, and triggers reindexing for it

Specified by:

evictAndReindex in interface ProjectCache

Parameters:

p - the NameKey of the project that is being evicted

remove

public void remove(Project p)

Description copied from interface: ProjectCache

Remove information about the given project from the cache. It will no longer be returned from ProjectCache.all().

Specified by:

remove in interface ProjectCache

remove

public void remove(Project.NameKey name)

Description copied from interface: ProjectCache

Remove information about the given project from the cache. It will no longer be returned from ProjectCache.all().

Specified by:

remove in interface ProjectCache

onCreateProject

public void onCreateProject(Project.NameKey newProjectName)
                     throws IOException

Description copied from interface: ProjectCache

Notify the cache that a new project was constructed.

Specified by:

onCreateProject in interface ProjectCache

Throws:

IOException

all

public com.google.common.collect.ImmutableSortedSet<Project.NameKey> all()

Description copied from interface: ProjectCache

Returns sorted iteration of projects.

Specified by:

all in interface ProjectCache

guessRelevantGroupUUIDs

public Set<AccountGroup.UUID> guessRelevantGroupUUIDs()

Description copied from interface: ProjectCache

Returns estimated set of relevant groups extracted from hot project access rules. If the cache is cold or too small for the entire project set of the server, this set may be incomplete.

Specified by:

guessRelevantGroupUUIDs in interface ProjectCache

byName

public com.google.common.collect.ImmutableSortedSet<Project.NameKey> byName(String pfx)

Description copied from interface: ProjectCache

Filter the set of registered project names by common prefix.

Specified by:

byName in interface ProjectCache

Parameters:

pfx - common prefix.

Returns:

sorted iteration of projects sharing the same prefix.

allProjectsFileProjectConfigHash

public static byte[] allProjectsFileProjectConfigHash(Optional<org.eclipse.jgit.lib.StoredConfig> allProjectsConfig)

Returns a MurMur128 hash of the contents of etc/All-Projects-project.config.

evictAllByName

public void evictAllByName()

sizeAllByName

public long sizeAllByName()