com.google.gerrit.server.mail.send

Class NotificationEmail

java.lang.Object

com.google.gerrit.server.mail.send.OutgoingEmail

com.google.gerrit.server.mail.send.NotificationEmail

Direct Known Subclasses:

ChangeEmail

public abstract class NotificationEmail
extends OutgoingEmail

Common class for notifications that are related to a project and branch

Field Summary

Fields

Modifier and Type	Field and Description
protected Branch.NameKey	branch

Fields inherited from class com.google.gerrit.server.mail.send.OutgoingEmail

args, footers, fromId, messageClass, notify, soyContext, soyContextEmailData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotificationEmail(EmailArguments ea, java.lang.String mc, Branch.NameKey branch)

Method Summary

Modifier and Type	Method and Description
protected void	add(RecipientType type, com.google.gerrit.server.mail.send.ProjectWatch.Watchers.List list) Add users or email addresses to the TO, CC, or BCC list.
protected static java.lang.String	getInstanceAndProjectName(java.lang.String instanceName, java.lang.String projectName)
protected static java.lang.String	getShortProjectName(java.lang.String projectName)
java.lang.String	getSshHost()
protected abstract ProjectWatch.Watchers	getWatchers(ProjectWatches.NotifyType type, boolean includeWatchersFromNotifyConfig) Returns all watchers that are relevant
protected void	includeWatchers(ProjectWatches.NotifyType type) Include users and groups that want notification of events.
protected void	includeWatchers(ProjectWatches.NotifyType type, boolean includeWatchersFromNotifyConfig) Include users and groups that want notification of events.
protected void	init() Setup the message headers and envelope (TO, CC, BCC).
protected void	setupSoyContext()

Methods inherited from class com.google.gerrit.server.mail.send.OutgoingEmail

add, add, add, add, add, add, add, add, addByEmail, addByEmail, appendHtml, appendText, format, getFromLine, getGerritHost, getNameEmailFor, getNameFor, getSettingsUrl, getUserNameEmailFor, isVisibleTo, removeHeader, removeUser, send, setFrom, setHeader, setHeader, setNotify, shouldSendMessage, soyHtmlTemplate, supportsHtml, textTemplate, useHtml

Methods inherited from class java.lang.Object

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

Field Detail

branch

protected Branch.NameKey branch

Constructor Detail

NotificationEmail

protected NotificationEmail(EmailArguments ea,
                            java.lang.String mc,
                            Branch.NameKey branch)

Method Detail

init

protected void init()
             throws com.google.gerrit.exceptions.EmailException

Description copied from class: OutgoingEmail

Setup the message headers and envelope (TO, CC, BCC).

Overrides:

init in class OutgoingEmail

Throws:

com.google.gerrit.exceptions.EmailException - if an error occurred.

includeWatchers

protected void includeWatchers(ProjectWatches.NotifyType type)

Include users and groups that want notification of events.

includeWatchers

protected void includeWatchers(ProjectWatches.NotifyType type,
                               boolean includeWatchersFromNotifyConfig)

Include users and groups that want notification of events.

getWatchers

protected abstract ProjectWatch.Watchers getWatchers(ProjectWatches.NotifyType type,
                                                     boolean includeWatchersFromNotifyConfig)

Returns all watchers that are relevant

add

protected void add(RecipientType type,
                   com.google.gerrit.server.mail.send.ProjectWatch.Watchers.List list)

Add users or email addresses to the TO, CC, or BCC list.

getSshHost

public java.lang.String getSshHost()

setupSoyContext

protected void setupSoyContext()

Overrides:

setupSoyContext in class OutgoingEmail

getShortProjectName

protected static java.lang.String getShortProjectName(java.lang.String projectName)

getInstanceAndProjectName

protected static java.lang.String getInstanceAndProjectName(java.lang.String instanceName,
                                                            java.lang.String projectName)