com.google.gerrit.server.notedb

Class NoteDbUpdateManager

java.lang.Object

com.google.gerrit.server.notedb.NoteDbUpdateManager

All Implemented Interfaces:

AutoCloseable

public class NoteDbUpdateManager
extends Object
implements 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 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)
void	execute()
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	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	setRefLogIdent(org.eclipse.jgit.lib.PersonIdent ident)
NoteDbUpdateManager	setRefLogMessage(String message)
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 String CHANGES_READ_ONLY

See Also:

Constant Field Values

Method Detail

close

public void close()

Specified by:

close in interface 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)

setRefLogMessage

public NoteDbUpdateManager setRefLogMessage(String message)

setRefLogIdent

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

getChangeRepo

public NoteDbUpdateManager.OpenRepo getChangeRepo()
                                           throws IOException

Throws:

IOException

getAllUsersRepo

public NoteDbUpdateManager.OpenRepo getAllUsersRepo()
                                             throws IOException

Throws:

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 Map<Change.Id,NoteDbUpdateManager.StagedResult> stage()
                                                      throws com.google.gwtorm.server.OrmException,
                                                             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.

IOException - if a storage layer error occurs.

stageAndApplyDelta

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

Throws:

com.google.gwtorm.server.OrmException

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

execute

public void execute()
             throws com.google.gwtorm.server.OrmException,
                    IOException

Throws:

com.google.gwtorm.server.OrmException

IOException