Package com.google.gerrit.server.mail.send

Class ChangeEmailImpl

java.lang.Object

com.google.gerrit.server.mail.send.ChangeEmailImpl

All Implemented Interfaces:

ChangeEmail, OutgoingEmail.EmailDecorator

public class ChangeEmailImpl
extends Object
implements ChangeEmail

Populates an email for change related notifications.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.server.mail.send.ChangeEmail

ChangeEmail.ChangeEmailDecorator

Field Summary

Fields

Modifier and Type	Field	Description
protected final EmailArguments	args
protected final BranchNameKey	branch
protected final Change	change
protected final ChangeData	changeData
protected final ChangeEmail.ChangeEmailDecorator	changeEmailDecorator
protected final Set<Account.Id>	currentAttentionSet
protected OutgoingEmail	email
protected PatchSet	patchSet
protected PatchSetInfo	patchSetInfo

Constructor Summary

Constructors

Constructor	Description
ChangeEmailImpl(EmailArguments args, Project.NameKey project, Change.Id changeId, ChangeEmail.ChangeEmailDecorator changeEmailDecorator)

Method Summary

Modifier and Type	Method	Description
void	addAuthors(RecipientType rt)	TO or CC all vested parties (change owner, patch set uploader, author).
void	bccStarredBy()	BCC any user who has starred this change.
void	ccAllApprovals()	Any user who has published comments on this change.
void	ccExistingReviewers()	Users who were added as reviewers to this change.
Change	getChange()	Get change for which the email is being sent.
ChangeData	getChangeData()	Get ChangeData for the change corresponding to the email.
protected String	getChangeDetail()	Create the change message and the affected file list.
protected String	getChangeUrl()	Get a link to the change; null if the server doesn't know its own address or if the address is malformed.
String	getCoverLetter()	Get the text of the "cover letter".
int	getDeletionsCount()	Get the number of deleted lines in a change.
protected Set<String>	getEmailsByState(ReviewerStateInternal state)
protected boolean	getIncludeDiff()
int	getInsertionsCount()	Get the number of added lines in a change.
PatchSet	getPatchSet()	Get PatchSet if provided.
ProjectState	getProjectState()	Get the project entity the change is in; null if its been deleted.
Instant	getTimestamp()	Get Timestamp of the event causing the email.
String	getUnifiedDiff()	Show patch set as unified difference.
void	includeWatchers(NotifyConfig.NotifyType type)	Include users and groups that want notification of events.
void	includeWatchers(NotifyConfig.NotifyType type, boolean includeWatchersFromNotifyConfig)	Include users and groups that want notification of events.
void	init(OutgoingEmail email)	Stores the reference to the email for the subsequent calls.
boolean	isRecipientAllowed(Account.Id to)	Evaluates whether account can be added to the list of recipients.
boolean	isRecipientAllowed(Address addr)	Evaluates whether email can be added to the list of recipients.
Map<String,FileDiffOutput>	listModifiedFiles()	Get the patch list corresponding to this patch set.
Map<String,FileDiffOutput>	listModifiedFiles(int patchSetId)	Get the patch list corresponding to patch set patchSetId of this change.
void	markAsReply()	Mark the email as non-first in the thread to ensure correct headers will be set
void	populateEmailContent()	Populate headers, recipients and body of the email.
void	setChangeMessage(String cm, Instant t)	Specify the summary of what happened to the change.
protected void	setChangeSubjectHeader()
void	setEmailOnlyAttentionSetIfEnabled(boolean value)	Specify if the email should only be sent to attention set.
void	setPatchSet(PatchSet ps)	Specify PatchSet with which the notification is associated with.
void	setPatchSet(PatchSet ps, PatchSetInfo psi)	Specify PatchSet along with additional data.
protected void	setThreadHeaders()	Sets headers for conversation grouping
protected static String	shortenSubject(String subject)	A shortened subject is the subject limited to 72 characters, with an ellipsis if it exceeds that limit.
boolean	shouldSendMessage()	If returns false email is not sent to any recipients.

Methods inherited from class java.lang.Object

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

Field Details

args

protected final EmailArguments args

currentAttentionSet

protected final Set<Account.Id> currentAttentionSet

change

protected final Change change

changeData

protected final ChangeData changeData

branch

protected final BranchNameKey branch

changeEmailDecorator

protected final ChangeEmail.ChangeEmailDecorator changeEmailDecorator

email

protected OutgoingEmail email

patchSet

protected PatchSet patchSet

patchSetInfo

protected PatchSetInfo patchSetInfo

Constructor Details

ChangeEmailImpl

public ChangeEmailImpl(EmailArguments args,
 Project.NameKey project,
 Change.Id changeId,
 ChangeEmail.ChangeEmailDecorator changeEmailDecorator)

Method Details

markAsReply

public void markAsReply()

Description copied from interface: ChangeEmail

Mark the email as non-first in the thread to ensure correct headers will be set

Specified by:

markAsReply in interface ChangeEmail

getChange

public Change getChange()

Description copied from interface: ChangeEmail

Get change for which the email is being sent.

Specified by:

getChange in interface ChangeEmail

getChangeData

public ChangeData getChangeData()

Description copied from interface: ChangeEmail

Get ChangeData for the change corresponding to the email.

Specified by:

getChangeData in interface ChangeEmail

getTimestamp

public Instant getTimestamp()

Description copied from interface: ChangeEmail

Get Timestamp of the event causing the email.

Provided by ChangeEmail.setChangeMessage(String, Instant).

Specified by:

getTimestamp in interface ChangeEmail

setPatchSet

public void setPatchSet(PatchSet ps)

Description copied from interface: ChangeEmail

Specify PatchSet with which the notification is associated with.

Specified by:

setPatchSet in interface ChangeEmail

getPatchSet

public PatchSet getPatchSet()

Description copied from interface: ChangeEmail

Get PatchSet if provided.

Specified by:

getPatchSet in interface ChangeEmail

setPatchSet

public void setPatchSet(PatchSet ps,
 PatchSetInfo psi)

Description copied from interface: ChangeEmail

Specify PatchSet along with additional data.

Specified by:

setPatchSet in interface ChangeEmail

setChangeMessage

public void setChangeMessage(String cm,
 Instant t)

Description copied from interface: ChangeEmail

Specify the summary of what happened to the change.

Specified by:

setChangeMessage in interface ChangeEmail

setEmailOnlyAttentionSetIfEnabled

public void setEmailOnlyAttentionSetIfEnabled(boolean value)

Description copied from interface: ChangeEmail

Specify if the email should only be sent to attention set.

Only affects users who have corresponding option enabled in the settings.

Specified by:

setEmailOnlyAttentionSetIfEnabled in interface ChangeEmail

shouldSendMessage

public boolean shouldSendMessage()

Description copied from interface: OutgoingEmail.EmailDecorator

If returns false email is not sent to any recipients.

Specified by:

shouldSendMessage in interface OutgoingEmail.EmailDecorator

init

public void init(OutgoingEmail email)
          throws com.google.gerrit.exceptions.EmailException

Description copied from interface: OutgoingEmail.EmailDecorator

Stores the reference to the email for the subsequent calls.

Both init and populateEmailContent can be called multiply times in case of retries. Init is therefore responsible for clearing up any changes which are not idempotent and initializing data for use in populateEmailContent.

Can be used to adjust any of the behaviour of the OutgoingEmail.populateEmailContent().

Specified by:

init in interface OutgoingEmail.EmailDecorator

Throws:

com.google.gerrit.exceptions.EmailException

setChangeSubjectHeader

protected void setChangeSubjectHeader()

getInsertionsCount

public int getInsertionsCount()

Description copied from interface: ChangeEmail

Get the number of added lines in a change.

Specified by:

getInsertionsCount in interface ChangeEmail

getDeletionsCount

public int getDeletionsCount()

Description copied from interface: ChangeEmail

Get the number of deleted lines in a change.

Specified by:

getDeletionsCount in interface ChangeEmail

getChangeUrl

protected String getChangeUrl()

Get a link to the change; null if the server doesn't know its own address or if the address is malformed. The link will contain a usp parameter set to "email" to inform the frontend on clickthroughs where the link came from.

setThreadHeaders

protected void setThreadHeaders()

Sets headers for conversation grouping

getCoverLetter

public String getCoverLetter()

Get the text of the "cover letter".

Specified by:

getCoverLetter in interface ChangeEmail

getChangeDetail

protected String getChangeDetail()

Create the change message and the affected file list.

listModifiedFiles

public Map<String,FileDiffOutput> listModifiedFiles(int patchSetId)

Get the patch list corresponding to patch set patchSetId of this change.

Specified by:

listModifiedFiles in interface ChangeEmail

listModifiedFiles

public Map<String,FileDiffOutput> listModifiedFiles()

Get the patch list corresponding to this patch set.

Specified by:

listModifiedFiles in interface ChangeEmail

getProjectState

public ProjectState getProjectState()

Get the project entity the change is in; null if its been deleted.

Specified by:

getProjectState in interface ChangeEmail

addAuthors

public void addAuthors(RecipientType rt)

TO or CC all vested parties (change owner, patch set uploader, author).

Specified by:

addAuthors in interface ChangeEmail

bccStarredBy

public void bccStarredBy()

BCC any user who has starred this change.

Specified by:

bccStarredBy in interface ChangeEmail

includeWatchers

public void includeWatchers(NotifyConfig.NotifyType type)

Include users and groups that want notification of events.

Specified by:

includeWatchers in interface ChangeEmail

includeWatchers

public void includeWatchers(NotifyConfig.NotifyType type,
 boolean includeWatchersFromNotifyConfig)

Include users and groups that want notification of events.

Specified by:

includeWatchers in interface ChangeEmail

ccAllApprovals

public void ccAllApprovals()

Any user who has published comments on this change.

Specified by:

ccAllApprovals in interface ChangeEmail

ccExistingReviewers

public void ccExistingReviewers()

Users who were added as reviewers to this change.

Specified by:

ccExistingReviewers in interface ChangeEmail

isRecipientAllowed

public boolean isRecipientAllowed(Address addr)
                           throws PermissionBackendException

Description copied from interface: OutgoingEmail.EmailDecorator

Evaluates whether email can be added to the list of recipients.

Specified by:

isRecipientAllowed in interface OutgoingEmail.EmailDecorator

Parameters:

addr - the recipient for which it should be checker whether it can be added to the list of recipients

Throws:

PermissionBackendException - thrown if checking permissions fails

isRecipientAllowed

public boolean isRecipientAllowed(Account.Id to)
                           throws PermissionBackendException

Description copied from interface: OutgoingEmail.EmailDecorator

Evaluates whether account can be added to the list of recipients.

Specified by:

isRecipientAllowed in interface OutgoingEmail.EmailDecorator

Parameters:

to - the recipient for which it should be checker whether it can be added to the list of recipients

Throws:

PermissionBackendException - thrown if checking permissions fails

populateEmailContent

public void populateEmailContent()
                          throws com.google.gerrit.exceptions.EmailException

Description copied from interface: OutgoingEmail.EmailDecorator

Populate headers, recipients and body of the email.

Method operates on the email provided in the init method.

By default, all the contents and parameters of the email should be set in this method.

Specified by:

populateEmailContent in interface OutgoingEmail.EmailDecorator

Throws:

com.google.gerrit.exceptions.EmailException

shortenSubject

protected static String shortenSubject(String subject)

A shortened subject is the subject limited to 72 characters, with an ellipsis if it exceeds that limit.

getEmailsByState

protected Set<String> getEmailsByState(ReviewerStateInternal state)

getIncludeDiff

protected boolean getIncludeDiff()

getUnifiedDiff

public String getUnifiedDiff()

Show patch set as unified difference.

Specified by:

getUnifiedDiff in interface ChangeEmail