Package com.atlassian.jira.template

Class DefaultMailTemplatesService

java.lang.Object

com.atlassian.jira.template.DefaultMailTemplatesService

All Implemented Interfaces:

MailTemplatesService

@ParametersAreNonnullByDefault
public class DefaultMailTemplatesService
extends Object
implements MailTemplatesService

A default MailTemplateService implementation which is designed to work with files and directories in Jira Shared Home

Since:

v8.14

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EMAIL_BATCH_DIR
protected static final String	EMAIL_DIR
protected static final String	IMAGES_DIR
protected static final String	TEMP_SUFFIX
protected static final String	TEMPLATES

Constructor Summary

Constructors

Constructor

Description

DefaultMailTemplatesService(FileStores fileStores, GlobalPermissionManager permissionManager, JiraAuthenticationContext authenticationContext, I18nHelper.BeanFactory i18nFactory, CachingJiraHomeTemplateContentLoader cachingTemplateLoader, EmailVelocityTemplatingEngine templatingEngine, com.atlassian.beehive.ClusterLockService clusterLockService, TemplateValidatorService templateValidatorService, JiraHomeTemplatesRevertService jiraHomeTemplatesRevertService, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
ServiceOutcome<Void>	applyEmailTemplates()	If the temporary folder with email templates is present, it will replace the production templates with temporary ones
protected void	copyInputStreamToFile(@NotNull InputStream inputStream, @NotNull File file)
protected void	deleteDirectory(@NotNull File directory)
protected void	deleteIfExists(@NotNull Path path)	Protected methods created to isolate the static functions calls Helps with testing
ServiceOutcome<File>	getEmailTemplatesZip()	Returns a zip file of the templates folder used for single notifications email.
protected String	getLocalizedErrorForLockRefused()
protected String	getLocalizedErrorForUpload()
protected void	moveDirectory(@NotNull File srcDir, @NotNull File destDir)
protected File	newFile(@NotNull String pathname)
protected File	newJiraFile(String templatesFileName)
protected void	quietlyDeleteDirectory(@NotNull File directory)
protected void	quietlyDeleteIfExists(@NotNull Path path)
ServiceOutcome<Void>	revertEmailTemplatesToDefault()	Replaces all currently used templates (stored in Shared Jira Home) with default templates.
protected void	unzip(File file, File outputDir)
ServiceOutcome<Void>	uploadEmailTemplates(InputStream templatesStream)	Saves a stream to disk and unzips it's content to the temporary templates folder.
protected void	zipFolder(File sourceFolder, File destination)

Methods inherited from class java.lang.Object

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

Field Details

TEMPLATES

protected static final String TEMPLATES

See Also:

• Constant Field Values

EMAIL_DIR

protected static final String EMAIL_DIR

See Also:

• Constant Field Values

EMAIL_BATCH_DIR

protected static final String EMAIL_BATCH_DIR

See Also:

• Constant Field Values

IMAGES_DIR

protected static final String IMAGES_DIR

See Also:

• Constant Field Values

TEMP_SUFFIX

protected static final String TEMP_SUFFIX

See Also:

• Constant Field Values

Constructor Details

DefaultMailTemplatesService

public DefaultMailTemplatesService(FileStores fileStores,
 GlobalPermissionManager permissionManager,
 JiraAuthenticationContext authenticationContext,
 I18nHelper.BeanFactory i18nFactory,
 CachingJiraHomeTemplateContentLoader cachingTemplateLoader,
 EmailVelocityTemplatingEngine templatingEngine,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 TemplateValidatorService templateValidatorService,
 JiraHomeTemplatesRevertService jiraHomeTemplatesRevertService,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

uploadEmailTemplates

public ServiceOutcome<Void> uploadEmailTemplates(InputStream templatesStream)

Description copied from interface: MailTemplatesService

Saves a stream to disk and unzips it's content to the temporary templates folder. Then performs validation to check existence of root templates.

Specified by:

uploadEmailTemplates in interface MailTemplatesService

Returns:

Valid ServiceOutcome when templates were unzipped and all root files exists Invalid ServiceOutcome with errors otherwise

applyEmailTemplates

public ServiceOutcome<Void> applyEmailTemplates()

Description copied from interface: MailTemplatesService

If the temporary folder with email templates is present, it will replace the production templates with temporary ones

Specified by:

applyEmailTemplates in interface MailTemplatesService

Returns:

Valid ServiceOutcome when templates replaced Invalid ServiceOutcome with errors otherwise

getEmailTemplatesZip

public ServiceOutcome<File> getEmailTemplatesZip()

Description copied from interface: MailTemplatesService

Returns a zip file of the templates folder used for single notifications email.

Specified by:

getEmailTemplatesZip in interface MailTemplatesService

Returns:

Zipped file of templates folder.

revertEmailTemplatesToDefault

public ServiceOutcome<Void> revertEmailTemplatesToDefault()

Description copied from interface: MailTemplatesService

Replaces all currently used templates (stored in Shared Jira Home) with default templates. If templates were modified then all changes will be overridden.

Specified by:

revertEmailTemplatesToDefault in interface MailTemplatesService

Returns:

Valid ServiceOutcome when templates replaced Invalid ServiceOutcome with errors otherwise

getLocalizedErrorForUpload

protected String getLocalizedErrorForUpload()

getLocalizedErrorForLockRefused

protected String getLocalizedErrorForLockRefused()

deleteIfExists

protected void deleteIfExists(@NotNull
 @NotNull Path path)
                       throws IOException

Protected methods created to isolate the static functions calls Helps with testing

Throws:

IOException

newJiraFile

protected File newJiraFile(String templatesFileName)

zipFolder

protected void zipFolder(File sourceFolder,
 File destination)
                  throws IOException

Throws:

IOException

quietlyDeleteIfExists

protected void quietlyDeleteIfExists(@NotNull
 @NotNull Path path)

copyInputStreamToFile

protected void copyInputStreamToFile(@NotNull
 @NotNull InputStream inputStream,
 @NotNull
 @NotNull File file)
                              throws IOException

Throws:

IOException

unzip

protected void unzip(File file,
 File outputDir)
              throws IOException

Throws:

IOException

deleteDirectory

protected void deleteDirectory(@NotNull
 @NotNull File directory)
                        throws IOException

Throws:

IOException

quietlyDeleteDirectory

protected void quietlyDeleteDirectory(@NotNull
 @NotNull File directory)

moveDirectory

protected void moveDirectory(@NotNull
 @NotNull File srcDir,
 @NotNull
 @NotNull File destDir)
                      throws IOException

Throws:

IOException

newFile

protected File newFile(@NotNull
 @NotNull String pathname)