Package com.google.gerrit.server.update

Class BatchUpdate

java.lang.Object

com.google.gerrit.server.update.BatchUpdate

All Implemented Interfaces:

AutoCloseable

public class BatchUpdate
extends Object
implements AutoCloseable

Helper for a set of change updates that should be applied to the NoteDb database.

An update operation can be divided into three phases:

1. Git reference updates
2. Review metadata updates
3. Post-update steps

A single conceptual operation, such as a REST API call or a merge operation, may make multiple changes at each step, which all need to be serialized relative to each other. Moreover, for consistency, the git ref updates must be visible to the review metadata updates, since for example the metadata might refer to newly-created patch set refs. In NoteDb, this is accomplished by combining these two phases into a single BatchRefUpdate.

Similarly, all post-update steps, such as sending email, must run only after all storage mutations have completed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchUpdate.Factory

Method Summary

Modifier and Type	Method	Description
BatchUpdate	addOp(Change.Id id, CurrentUser contextUser, BatchUpdateOp op)	Adds a BatchUpdate for a change that should be executed by the given context user.
BatchUpdate	addOp(Change.Id id, BatchUpdateOp op)	Adds a BatchUpdate for a change.
BatchUpdate	addRepoOnlyOp(CurrentUser contextUser, RepoOnlyOp op)	Adds a RepoOnlyOp that should be executed by the given context user.
BatchUpdate	addRepoOnlyOp(RepoOnlyOp op)	Adds a RepoOnlyOp.
void	close()
BatchUpdates.Result	execute()
BatchUpdates.Result	execute(BatchUpdateListener listener)
Project.NameKey	getProject()
Map<String,org.eclipse.jgit.transport.ReceiveCommand>	getRefUpdates()
Map<BranchNameKey,org.eclipse.jgit.transport.ReceiveCommand>	getSuccessfullyUpdatedBranches(boolean dryrun)	Return the references successfully updated by this BatchUpdate with their command.
BatchUpdate	insertChange(InsertChangeOp op)
boolean	isExecuted()
static com.google.inject.Module	module()
BatchUpdate	setNotify(NotifyResolver.Result notify)	Set the default notification settings for all changes in the batch.
BatchUpdate	setNotifyHandling(Change.Id changeId, NotifyHandling notifyHandling)	Override the NotifyHandling on a per-change basis.
BatchUpdate	setOnSubmitValidators(OnSubmitValidators onSubmitValidators)	Add a validation step for intended ref operations, which will be performed at the end of RepoOnlyOp.updateRepo(RepoContext) step.
BatchUpdate	setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert)
BatchUpdate	setRefLogMessage(String refLogMessage)
BatchUpdate	setRepository(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk revWalk, org.eclipse.jgit.lib.ObjectInserter inserter)

Methods inherited from class java.lang.Object

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

Method Details

module

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

close

public void close()

Specified by:

close in interface AutoCloseable

execute

@CanIgnoreReturnValue
public BatchUpdates.Result execute(BatchUpdateListener listener)
                            throws UpdateException,
RestApiException

Throws:

UpdateException

RestApiException

execute

@CanIgnoreReturnValue
public BatchUpdates.Result execute()
                            throws UpdateException,
RestApiException

Throws:

UpdateException

RestApiException

isExecuted

public boolean isExecuted()

setRepository

@CanIgnoreReturnValue
public BatchUpdate setRepository(org.eclipse.jgit.lib.Repository repo,
 org.eclipse.jgit.revwalk.RevWalk revWalk,
 org.eclipse.jgit.lib.ObjectInserter inserter)

setPushCertificate

@CanIgnoreReturnValue
public BatchUpdate setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert)

setRefLogMessage

@CanIgnoreReturnValue
public BatchUpdate setRefLogMessage(String refLogMessage)

setNotify

@CanIgnoreReturnValue
public BatchUpdate setNotify(NotifyResolver.Result notify)

Set the default notification settings for all changes in the batch.

Parameters:

notify - notification settings.

Returns:

this.

setNotifyHandling

@CanIgnoreReturnValue
public BatchUpdate setNotifyHandling(Change.Id changeId,
 NotifyHandling notifyHandling)

Override the NotifyHandling on a per-change basis.

Only the handling enum can be overridden; all changes share the same value for NotifyResolver.Result.accounts().

Parameters:

changeId - change ID.

notifyHandling - notify handling.

Returns:

this.

setOnSubmitValidators

@CanIgnoreReturnValue
public BatchUpdate setOnSubmitValidators(OnSubmitValidators onSubmitValidators)

Add a validation step for intended ref operations, which will be performed at the end of RepoOnlyOp.updateRepo(RepoContext) step.

getProject

public Project.NameKey getProject()

getRefUpdates

public Map<String,org.eclipse.jgit.transport.ReceiveCommand> getRefUpdates()

getSuccessfullyUpdatedBranches

public Map<BranchNameKey,org.eclipse.jgit.transport.ReceiveCommand> getSuccessfullyUpdatedBranches(boolean dryrun)

Return the references successfully updated by this BatchUpdate with their command. In dryrun, we assume all updates were successful.

addOp

@CanIgnoreReturnValue
public BatchUpdate addOp(Change.Id id,
 BatchUpdateOp op)

Adds a BatchUpdate for a change.

The op is executed by the user for which the BatchUpdate has been created.

addOp

@CanIgnoreReturnValue
public BatchUpdate addOp(Change.Id id,
 CurrentUser contextUser,
 BatchUpdateOp op)

Adds a BatchUpdate for a change that should be executed by the given context user.

addRepoOnlyOp

@CanIgnoreReturnValue
public BatchUpdate addRepoOnlyOp(RepoOnlyOp op)

Adds a RepoOnlyOp.

The op is executed by the user for which the BatchUpdate has been created.

addRepoOnlyOp

@CanIgnoreReturnValue
public BatchUpdate addRepoOnlyOp(CurrentUser contextUser,
 RepoOnlyOp op)

Adds a RepoOnlyOp that should be executed by the given context user.

insertChange

@CanIgnoreReturnValue
public BatchUpdate insertChange(InsertChangeOp op)
                         throws IOException

Throws:

IOException