com.google.gerrit.server.notedb

Class NoteDbUpdateManager

java.lang.Object

com.google.gerrit.server.notedb.NoteDbUpdateManager

All Implemented Interfaces:

java.lang.AutoCloseable

public class NoteDbUpdateManager
extends java.lang.Object
implements java.lang.AutoCloseable

Object to manage a single sequence of updates to NoteDb.

Instances are one-time-use. Handles updating both the change repo and the All-Users repo for any affected changes, with proper ordering.

To see the state that would be applied prior to executing the full sequence of updates, use stage().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NoteDbUpdateManager.Factory
static class	NoteDbUpdateManager.MismatchedStateException
static class	NoteDbUpdateManager.OpenRepo
static class	NoteDbUpdateManager.Result
static class	NoteDbUpdateManager.StagedResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGES_READ_ONLY

Method Summary

Modifier and Type	Method and Description
void	add(ChangeDraftUpdate draftUpdate)
void	add(ChangeUpdate update) Add an update to the list of updates to execute.
void	close()
void	deleteChange(Change.Id id)
org.eclipse.jgit.lib.BatchRefUpdate	execute()
org.eclipse.jgit.lib.BatchRefUpdate	execute(boolean dryrun)
void	flush()
NoteDbUpdateManager.OpenRepo	getAllUsersRepo()
NoteDbUpdateManager.OpenRepo	getChangeRepo()
NoteDbUpdateManager	setAllUsersRepo(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, ChainedReceiveCommands cmds)
NoteDbUpdateManager	setAtomicRefUpdates(boolean atomicRefUpdates) Set whether to use atomic ref updates.
NoteDbUpdateManager	setChangeRepo(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, ChainedReceiveCommands cmds)
NoteDbUpdateManager	setCheckExpectedState(boolean checkExpectedState)
NoteDbUpdateManager	setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert) Set a push certificate for the push that originally triggered this NoteDb update.
NoteDbUpdateManager	setRefLogIdent(org.eclipse.jgit.lib.PersonIdent ident)
NoteDbUpdateManager	setRefLogMessage(java.lang.String message)
NoteDbUpdateManager	setSaveObjects(boolean saveObjects) Set whether to save objects and make them available in NoteDbUpdateManager.StagedResults.
java.util.Map<Change.Id,NoteDbUpdateManager.StagedResult>	stage() Stage updates in the manager's internal list of commands.
NoteDbUpdateManager.Result	stageAndApplyDelta(Change change)

Methods inherited from class java.lang.Object

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

Field Detail

CHANGES_READ_ONLY

public static final java.lang.String CHANGES_READ_ONLY

See Also:

Constant Field Values

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

setChangeRepo

public NoteDbUpdateManager setChangeRepo(org.eclipse.jgit.lib.Repository repo,
                                         org.eclipse.jgit.revwalk.RevWalk rw,
                                         org.eclipse.jgit.lib.ObjectInserter ins,
                                         ChainedReceiveCommands cmds)

setAllUsersRepo

public NoteDbUpdateManager setAllUsersRepo(org.eclipse.jgit.lib.Repository repo,
                                           org.eclipse.jgit.revwalk.RevWalk rw,
                                           org.eclipse.jgit.lib.ObjectInserter ins,
                                           ChainedReceiveCommands cmds)

setCheckExpectedState

public NoteDbUpdateManager setCheckExpectedState(boolean checkExpectedState)

setSaveObjects

public NoteDbUpdateManager setSaveObjects(boolean saveObjects)

Set whether to save objects and make them available in NoteDbUpdateManager.StagedResults.

If set, all objects inserted into all repos managed by this instance will be buffered in memory, and the NoteDbUpdateManager.StagedResults will return non-null lists from NoteDbUpdateManager.StagedResult.changeObjects() and NoteDbUpdateManager.StagedResult.allUsersObjects().

Not recommended if modifying a large number of changes with a single manager.

Parameters:

saveObjects - whether to save objects; defaults to true.

Returns:

this

setAtomicRefUpdates

public NoteDbUpdateManager setAtomicRefUpdates(boolean atomicRefUpdates)

Set whether to use atomic ref updates.

Can be set to false when the change updates represented by this manager aren't logically related, e.g. when the updater is only used to group objects together with a single inserter.

Parameters:

atomicRefUpdates - whether to use atomic ref updates; defaults to true.

Returns:

this

setRefLogMessage

public NoteDbUpdateManager setRefLogMessage(java.lang.String message)

setRefLogIdent

public NoteDbUpdateManager setRefLogIdent(org.eclipse.jgit.lib.PersonIdent ident)

setPushCertificate

public NoteDbUpdateManager setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert)

Set a push certificate for the push that originally triggered this NoteDb update.

The pusher will not necessarily have specified any of the NoteDb refs explicitly, such as when processing a push to refs/for/master. That's fine; this is just passed to the underlying BatchRefUpdate, and the implementation decides what to do with it.

The cert should be associated with the main repo. There is currently no way of associating a push cert with the All-Users repo, since it is not currently possible to update draft changes via push.

Parameters:

pushCert - push certificate; may be null.

Returns:

this

getChangeRepo

public NoteDbUpdateManager.OpenRepo getChangeRepo()
                                           throws java.io.IOException

Throws:

java.io.IOException

getAllUsersRepo

public NoteDbUpdateManager.OpenRepo getAllUsersRepo()
                                             throws java.io.IOException

Throws:

java.io.IOException

add

public void add(ChangeUpdate update)

Add an update to the list of updates to execute.

Updates should only be added to the manager after all mutations have been made, as this method may eagerly access the update.

Parameters:

update - the update to add.

add

public void add(ChangeDraftUpdate draftUpdate)

deleteChange

public void deleteChange(Change.Id id)

stage

public java.util.Map<Change.Id,NoteDbUpdateManager.StagedResult> stage()
                                                                throws com.google.gwtorm.server.OrmException,
                                                                       java.io.IOException

Stage updates in the manager's internal list of commands.

Returns:

map of the state that would get written to the applicable repo(s) for each affected change.

Throws:

com.google.gwtorm.server.OrmException - if a database layer error occurs.

java.io.IOException - if a storage layer error occurs.

stageAndApplyDelta

public NoteDbUpdateManager.Result stageAndApplyDelta(Change change)
                                              throws com.google.gwtorm.server.OrmException,
                                                     java.io.IOException

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException

execute

public org.eclipse.jgit.lib.BatchRefUpdate execute()
                                            throws com.google.gwtorm.server.OrmException,
                                                   java.io.IOException

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException

execute

public org.eclipse.jgit.lib.BatchRefUpdate execute(boolean dryrun)
                                            throws com.google.gwtorm.server.OrmException,
                                                   java.io.IOException

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException