com.google.gerrit.server.group.db

Class GroupsUpdate

java.lang.Object

com.google.gerrit.server.group.db.GroupsUpdate

public class GroupsUpdate
extends java.lang.Object

A database accessor for write calls related to groups.

All calls which write group related details to the database are gathered here. Other classes should always use this class instead of accessing the database directly. There are a few exceptions though: schema classes, wrapper classes, and classes executed during init. The latter ones should use GroupsOnInit instead.

If not explicitly stated, all methods of this class refer to internal groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GroupsUpdate.Factory

Method Summary

Modifier and Type	Method and Description
InternalGroup	createGroup(InternalGroupCreation groupCreation, InternalGroupUpdate groupUpdate) Creates the specified group for the specified members (accounts).
InternalGroup	createGroupInNoteDb(InternalGroupCreation groupCreation, InternalGroupUpdate groupUpdate)
void	updateGroup(AccountGroup.UUID groupUuid, InternalGroupUpdate groupUpdate) Updates the specified group.
com.google.gerrit.server.group.db.GroupsUpdate.UpdateResult	updateGroupInNoteDb(AccountGroup.UUID groupUuid, InternalGroupUpdate groupUpdate)

Methods inherited from class java.lang.Object

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

Method Detail

createGroup

public InternalGroup createGroup(InternalGroupCreation groupCreation,
                                 InternalGroupUpdate groupUpdate)
                          throws com.google.gerrit.exceptions.DuplicateKeyException,
                                 java.io.IOException,
                                 org.eclipse.jgit.errors.ConfigInvalidException

Creates the specified group for the specified members (accounts).

Parameters:

groupCreation - an InternalGroupCreation which specifies all mandatory properties of the group

groupUpdate - an InternalGroupUpdate which specifies optional properties of the group. If this InternalGroupUpdate updates a property which was already specified by the InternalGroupCreation, the value of this InternalGroupUpdate wins.

Returns:

the created InternalGroup

Throws:

com.google.gerrit.exceptions.DuplicateKeyException - if a group with the chosen name already exists

java.io.IOException - if indexing fails, or an error occurs while reading/writing from/to NoteDb

org.eclipse.jgit.errors.ConfigInvalidException

updateGroup

public void updateGroup(AccountGroup.UUID groupUuid,
                        InternalGroupUpdate groupUpdate)
                 throws com.google.gerrit.exceptions.DuplicateKeyException,
                        java.io.IOException,
                        com.google.gerrit.exceptions.NoSuchGroupException,
                        org.eclipse.jgit.errors.ConfigInvalidException

Updates the specified group.

Parameters:

groupUuid - the UUID of the group to update

groupUpdate - an InternalGroupUpdate which indicates the desired updates on the group

Throws:

com.google.gerrit.exceptions.DuplicateKeyException - if the new name of the group is used by another group

java.io.IOException - if indexing fails, or an error occurs while reading/writing from/to NoteDb

com.google.gerrit.exceptions.NoSuchGroupException - if the specified group doesn't exist

org.eclipse.jgit.errors.ConfigInvalidException

createGroupInNoteDb

public InternalGroup createGroupInNoteDb(InternalGroupCreation groupCreation,
                                         InternalGroupUpdate groupUpdate)
                                  throws java.io.IOException,
                                         org.eclipse.jgit.errors.ConfigInvalidException,
                                         com.google.gerrit.exceptions.DuplicateKeyException

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

com.google.gerrit.exceptions.DuplicateKeyException

updateGroupInNoteDb

public com.google.gerrit.server.group.db.GroupsUpdate.UpdateResult updateGroupInNoteDb(AccountGroup.UUID groupUuid,
                                                                                       InternalGroupUpdate groupUpdate)
                                                                                throws java.io.IOException,
                                                                                       org.eclipse.jgit.errors.ConfigInvalidException,
                                                                                       com.google.gerrit.exceptions.DuplicateKeyException,
                                                                                       com.google.gerrit.exceptions.NoSuchGroupException

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

com.google.gerrit.exceptions.DuplicateKeyException

com.google.gerrit.exceptions.NoSuchGroupException