Class AbstractApiKeyBatchJob

java.lang.Object

ch.tocco.nice2.tasks.api.quartz.AbstractJob

ch.tocco.nice2.tasks.api.quartz.AbstractInterruptableJob

ch.tocco.nice2.usermanager.impl.batchjob.AbstractApiKeyBatchJob

All Implemented Interfaces:

org.quartz.InterruptableJob, org.quartz.Job

Direct Known Subclasses:

ApiKeyExpiryReminderBatchJob, DeleteExpiredApiKeysBatchJob

public abstract class AbstractApiKeyBatchJob
extends AbstractInterruptableJob

Sends reminder emails to users whose API keys will expire soon or which are now expired. - For outlook add-in api keys send email to user itself (if no email address is defined send no email). - For general api keys send email to receiver defined in email template or the default email address as fallback.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractApiKeyBatchJob.SendMailTask

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandExecutor	commandExecutor
protected final Context	context
protected final EmailTemplateLoadService	emailTemplateLoadService
protected final MailFactory	mailFactory
protected final QueryBuilderFactory	queryBuilderFactory

Fields inherited from class AbstractJob

businessUnitManager, l10N, logger, principalManager, securityManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractApiKeyBatchJob(MailFactory mailFactory, EmailTemplateLoadService emailTemplateLoadService, CommandExecutor commandExecutor, QueryBuilderFactory queryBuilderFactory, Context context)

Method Summary

Modifier and Type	Method	Description
protected abstract void	doAfterCommit(Entity apiKey, CommandContext commandContext)
protected void	doExecute(org.quartz.JobExecutionContext context, JobDataMapReader jobDataMapReader)
protected abstract String	getMailTemplateId(boolean isOutlookAddIn)
protected abstract PrimaryKey[]	loadTargetApiKeys(CommandContext commandContext)
void	setSystemMailAddress(String systemMailAddress)

Methods inherited from class AbstractInterruptableJob

interrupt, isCancelled

Methods inherited from class AbstractJob

execute, getProgress, getProgressLog, setBusinessUnitManager, setConverters, setL10N, setLogger, setPrincipalManager, setProgressPersistenceManager, setRuleProviderService, setSecurityManager

Methods inherited from class Object

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

Methods inherited from interface org.quartz.Job

execute

Field Details

mailFactory

protected final MailFactory mailFactory

emailTemplateLoadService

protected final EmailTemplateLoadService emailTemplateLoadService

commandExecutor

protected final CommandExecutor commandExecutor

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

context

protected final Context context

Constructor Details

AbstractApiKeyBatchJob

protected AbstractApiKeyBatchJob(MailFactory mailFactory,
 EmailTemplateLoadService emailTemplateLoadService,
 CommandExecutor commandExecutor,
 QueryBuilderFactory queryBuilderFactory,
 Context context)

Method Details

doExecute

protected void doExecute(org.quartz.JobExecutionContext context,
 JobDataMapReader jobDataMapReader)

Specified by:

doExecute in class AbstractJob

loadTargetApiKeys

protected abstract PrimaryKey[] loadTargetApiKeys(CommandContext commandContext)

getMailTemplateId

protected abstract String getMailTemplateId(boolean isOutlookAddIn)

doAfterCommit

protected abstract void doAfterCommit(Entity apiKey,
 CommandContext commandContext)

setSystemMailAddress

@Value("${email.default.from}")
public void setSystemMailAddress(String systemMailAddress)