Package fr.ens.biologie.genomique.aozan.aozan3.dataprocessor

Class DataProcessorTemplateEmailMessage

java.lang.Object

fr.ens.biologie.genomique.aozan.aozan3.TemplateEmailMessage

fr.ens.biologie.genomique.aozan.aozan3.dataprocessor.DataProcessorTemplateEmailMessage

public class DataProcessorTemplateEmailMessage
extends TemplateEmailMessage

This class define a template email message for end of step messages.

Since:

3.1

Author:

Laurent Jourdren

Field Summary

Fields inherited from class fr.ens.biologie.genomique.aozan.aozan3.TemplateEmailMessage

DEFAULT_MAIL_FOOTER, DEFAULT_MAIL_HEADER, DEFAULT_SUBJECT_PREFIX

Constructor Summary

Constructors

Constructor	Description
DataProcessorTemplateEmailMessage(Configuration conf, String templateKey, String defaultTemplateResource)	Public constructor.

Method Summary

Modifier and Type	Method	Description
EmailMessage	endDataProcessorEmail(String subject, RunId runId, Path outputDirectory, long startTime, long endTime, long outputSize, long diskFree, Map<String,String> variables)	Create an end of step message.

Methods inherited from class fr.ens.biologie.genomique.aozan.aozan3.TemplateEmailMessage

errorMessage, errorMessage, setFooter, setHeader, setTemplate, setTemplateFromFile, setTemplateFromResource, toEmailMessage, toEmailMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProcessorTemplateEmailMessage

public DataProcessorTemplateEmailMessage(Configuration conf,
                                         String templateKey,
                                         String defaultTemplateResource)
                                  throws IOException

Public constructor.

Parameters:

conf - Configuration

templateKey - template configuration key

defaultTemplateResource - default path for the template in Java resources

Throws:

IOException - if an error occurs while reading the template file

Method Detail

endDataProcessorEmail

public EmailMessage endDataProcessorEmail(String subject,
                                          RunId runId,
                                          Path outputDirectory,
                                          long startTime,
                                          long endTime,
                                          long outputSize,
                                          long diskFree,
                                          Map<String,String> variables)
                                   throws Aozan3Exception

Create an end of step message.

Parameters:

subject - email message

runId - run ID

outputDirectory - output directory of the step

startTime - start time of the step

endTime - end time of the step

outputSize - output size of generated data

diskFree - disk free space available at the end of the steo

variables - variables for the template

Returns:

an email message

Throws:

Aozan3Exception - if an error occurs while creating the message