com.google.gerrit.server.account

Class WatchConfig

java.lang.Object

com.google.gerrit.server.git.VersionedMetaData

com.google.gerrit.server.account.WatchConfig

All Implemented Interfaces:

ValidationError.Sink

public class WatchConfig
extends VersionedMetaData
implements ValidationError.Sink

‘watch.config’ file in the user branch in the All-Users repository that contains the watch configuration of the user.

The 'watch.config' file is a git config file that has one 'project' section for all project watches of a project.

The project name is used as subsection name and the filters with the notify types that decide for which events email notifications should be sent are represented as 'notify' values in the subsection. A 'notify' value is formatted as <filter> [<comma-separated-list-of-notify-types>]:

   [project "foo"]
     notify = * [ALL_COMMENTS]
     notify = branch:master [ALL_COMMENTS, NEW_PATCHSETS]
     notify = branch:master owner:self [SUBMITTED_CHANGES]
 

If two notify values in the same subsection have the same filter they are merged on the next save, taking the union of the notify types.

For watch configurations that notify on no event the list of notify types is empty:

   [project "foo"]
     notify = branch:master []
 

Unknown notify types are ignored and removed on save.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WatchConfig.Accessor
static class	WatchConfig.NotifyType
static class	WatchConfig.NotifyValue
static class	WatchConfig.ProjectWatchKey

Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData

VersionedMetaData.BatchMetaDataUpdate, VersionedMetaData.PathInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILTER_ALL
static java.lang.String	KEY_NOTIFY
static java.lang.String	PROJECT
static java.lang.String	WATCH_CONFIG

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData

inserter, newTree, reader, revision

Constructor Summary

Constructors

Constructor and Description
WatchConfig(Account.Id accountId)

Method Summary

Modifier and Type	Method and Description
void	error(ValidationError error)
protected java.lang.String	getRefName()
java.util.List<ValidationError>	getValidationErrors() Get the validation errors, if any were discovered during load.
protected void	onLoad() Set up the metadata, parsing any state from the loaded revision.
protected boolean	onSave(org.eclipse.jgit.lib.CommitBuilder commit) Save any changes to the metadata in a commit.
static java.util.Map<WatchConfig.ProjectWatchKey,java.util.Set<WatchConfig.NotifyType>>	parse(Account.Id accountId, org.eclipse.jgit.lib.Config cfg, ValidationError.Sink validationErrorSink)
void	setProjectWatches(java.util.Map<WatchConfig.ProjectWatchKey,java.util.Set<WatchConfig.NotifyType>> projectWatches)

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData

commit, commitToNewRef, getObjectId, getPathInfos, getRevision, load, load, load, load, load, openUpdate, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_ALL

public static final java.lang.String FILTER_ALL

See Also:

Constant Field Values

WATCH_CONFIG

public static final java.lang.String WATCH_CONFIG

See Also:

Constant Field Values

PROJECT

public static final java.lang.String PROJECT

See Also:

Constant Field Values

KEY_NOTIFY

public static final java.lang.String KEY_NOTIFY

See Also:

Constant Field Values

Constructor Detail

WatchConfig

public WatchConfig(Account.Id accountId)

Method Detail

getRefName

protected java.lang.String getRefName()

Specified by:

getRefName in class VersionedMetaData

Returns:

name of the reference storing this configuration.

onLoad

protected void onLoad()
               throws java.io.IOException,
                      org.eclipse.jgit.errors.ConfigInvalidException

Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

parse

public static java.util.Map<WatchConfig.ProjectWatchKey,java.util.Set<WatchConfig.NotifyType>> parse(Account.Id accountId,
                                                                                                     org.eclipse.jgit.lib.Config cfg,
                                                                                                     ValidationError.Sink validationErrorSink)

setProjectWatches

public void setProjectWatches(java.util.Map<WatchConfig.ProjectWatchKey,java.util.Set<WatchConfig.NotifyType>> projectWatches)

onSave

protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)
                  throws java.io.IOException,
                         org.eclipse.jgit.errors.ConfigInvalidException

Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:

true if the commit should proceed, false to abort.

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

error

public void error(ValidationError error)

Specified by:

error in interface ValidationError.Sink

getValidationErrors

public java.util.List<ValidationError> getValidationErrors()

Get the validation errors, if any were discovered during load.

Returns:

list of errors; empty list if there are no errors.