Package org.ametys.web.usermanagement

Class SendInvitationsSchedulable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

org.ametys.cms.schedule.AbstractSendingMailSchedulable

org.ametys.web.usermanagement.SendInvitationsSchedulable

All Implemented Interfaces:

Schedulable, LogEnabled, PluginAware, Initializable, Component, Configurable, Contextualizable, Serviceable

public class SendInvitationsSchedulable
extends AbstractSendingMailSchedulable

Job for sending invitations email

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

AbstractStaticSchedulable.SchedulableParameterParser

Field Summary

Fields

Modifier and Type	Field	Description
protected UserSignupManager	_signupManager	The signup manager
protected SiteManager	_siteManager	The site manager
protected UserPopulationDAO	_userPopulationDAO	DAO for user population
static final String	GUESTS_KEY	The key for the guests
static final String	RESEND_INVITATIONS_KEY	The key for the guests
static final String	SITE_NAME_KEY	The key for the site name
static final String	USER_DIRECTORY_ID_KEY	The key for the id of the population
static final String	USER_POPULATION_ID_KEY	The key for the id of the population

Fields inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_currentUserProvider, _i18nUtils, _mailSender, _sysadminMail, _userHelper

Fields inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

_acceptConcurrentExecution, _context, _description, _iconGlyph, _iconLarge, _iconMedium, _iconSmall, _id, _label, _parameters, _pluginName, _private, _schedulableParameterTypeExtensionPoint, _smanager, _startTime, _userManager, PROGRESSION_TRACKER

Constructor Summary

Constructors

Constructor	Description
SendInvitationsSchedulable()

Method Summary

Modifier and Type	Method	Description
protected String	_buildErrorMailBody(JobExecutionContext context, UserManagementException.StatusError globalErrorCause)	Build the HTML mail body in case of error
protected String	_buildMailBody(JobExecutionContext context, List<String> successEmails, List<String> invalidEmails, List<String> errorMails, List<String> existingTempUsers, List<String> existingUsers)	Build the HTML mail body
protected void	_doExecute(JobExecutionContext context, ContainerProgressionTracker progressionTracker)	Executes the schedulable.
protected String	_getErrorMailBody(JobExecutionContext context, Throwable throwable)	Retrieves the body of the error mail
protected I18nizableText	_getErrorMailSubject(JobExecutionContext context)	Retrieves the subject of the error mail
protected Site	_getSite(JobExecutionContext context)	Get the site title from job execution context
protected String	_getSuccessMailBody(JobExecutionContext context)	Retrieves the body of the success mail
protected I18nizableText	_getSuccessMailSubject(JobExecutionContext context)	Retrieves the subject of the success mail
protected boolean	_isMailBodyInHTML(JobExecutionContext context)	Determines if the mail body is in HTML
protected String	getToolUri(Site site)	Get the back-office url to access user temp tool
void	initialize()
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.schedule.AbstractSendingMailSchedulable

_getRecipient, _sendMail, execute

Methods inherited from class org.ametys.plugins.core.impl.schedule.AbstractStaticSchedulable

acceptConcurrentExecution, configure, contextualize, getDescription, getIconGlyph, getIconLarge, getIconMedium, getIconSmall, getId, getLabel, getParameters, getProgressionTracker, isPrivate, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

USER_POPULATION_ID_KEY

public static final String USER_POPULATION_ID_KEY

The key for the id of the population

See Also:

• Constant Field Values

USER_DIRECTORY_ID_KEY

public static final String USER_DIRECTORY_ID_KEY

The key for the id of the population

See Also:

• Constant Field Values

SITE_NAME_KEY

public static final String SITE_NAME_KEY

The key for the site name

See Also:

• Constant Field Values

GUESTS_KEY

public static final String GUESTS_KEY

The key for the guests

See Also:

• Constant Field Values

RESEND_INVITATIONS_KEY

public static final String RESEND_INVITATIONS_KEY

The key for the guests

See Also:

• Constant Field Values

_signupManager

protected UserSignupManager _signupManager

The signup manager

_siteManager

protected SiteManager _siteManager

The site manager

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

DAO for user population

Constructor Details

SendInvitationsSchedulable

public SendInvitationsSchedulable()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSendingMailSchedulable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractSendingMailSchedulable

Throws:

Exception

_doExecute

protected void _doExecute(JobExecutionContext context,
 ContainerProgressionTracker progressionTracker)
                   throws Exception

Description copied from class: AbstractSendingMailSchedulable

Executes the schedulable.

Specified by:

_doExecute in class AbstractSendingMailSchedulable

Parameters:

context - the context

progressionTracker - The progression tracker

Throws:

Exception - if an error occurred

_getSuccessMailSubject

protected I18nizableText _getSuccessMailSubject(JobExecutionContext context)
                                         throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the success mail

Specified by:

_getSuccessMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the success mail

Throws:

Exception - If an error occurs while building the mail subject

_getSuccessMailBody

protected String _getSuccessMailBody(JobExecutionContext context)
                              throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the success mail

Specified by:

_getSuccessMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the body of the success mail

Throws:

Exception - If an error occurs while building the mail body

_isMailBodyInHTML

protected boolean _isMailBodyInHTML(JobExecutionContext context)
                             throws Exception

Description copied from class: AbstractSendingMailSchedulable

Determines if the mail body is in HTML

Overrides:

_isMailBodyInHTML in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

true if the mail body is in HTML, false otherwise

Throws:

Exception - If an error occurs while retrieving if mail body should be HTML

_buildMailBody

protected String _buildMailBody(JobExecutionContext context,
 List<String> successEmails,
 List<String> invalidEmails,
 List<String> errorMails,
 List<String> existingTempUsers,
 List<String> existingUsers)
                         throws IOException

Build the HTML mail body

Parameters:

context - the job context data

successEmails - the mails in success

invalidEmails - the invalid emails

errorMails - the mails for which the send has failed

existingTempUsers - the existing temporary users

existingUsers - the existing users

Returns:

the HTML mail body

Throws:

IOException - if failed to build send invitation report

getToolUri

protected String getToolUri(Site site)

Get the back-office url to access user temp tool

Parameters:

site - the site

Returns:

the tool uri

_getErrorMailSubject

protected I18nizableText _getErrorMailSubject(JobExecutionContext context)
                                       throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the subject of the error mail

Specified by:

_getErrorMailSubject in class AbstractSendingMailSchedulable

Parameters:

context - the context

Returns:

the subject of the error mail

Throws:

Exception - If an error occurs while building the mail subject

_getErrorMailBody

protected String _getErrorMailBody(JobExecutionContext context,
 Throwable throwable)
                            throws Exception

Description copied from class: AbstractSendingMailSchedulable

Retrieves the body of the error mail

Specified by:

_getErrorMailBody in class AbstractSendingMailSchedulable

Parameters:

context - the context

throwable - the error

Returns:

the body of the error mail

Throws:

Exception - If an error occurs while building the mail body

_buildErrorMailBody

protected String _buildErrorMailBody(JobExecutionContext context,
 UserManagementException.StatusError globalErrorCause)
                              throws IOException

Build the HTML mail body in case of error

Parameters:

context - the job context data

globalErrorCause - the global error cause

Returns:

the HTML mail body in case of error

Throws:

IOException - if failed to build send invitation error

_getSite

protected Site _getSite(JobExecutionContext context)

Get the site title from job execution context

Parameters:

context - the job context

Returns:

the site title