org.pentaho.di.job.entries.mail
Class JobEntryMail

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.mail.JobEntryMail

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryMail
extends JobEntryBase
implements Cloneable, JobEntryInterface

Describes a Mail Job Entry.

Author:

Matt Created on 17-06-2003

Field Summary

String[]	contentids
String[]	embeddedimages

Constructor Summary

JobEntryMail()

JobEntryMail(String n)

Method Summary

void	allocate(int nrFileTypes)
void	check(List<CheckResultInterface> remarks, JobMeta jobMeta) Support for overrides not having to put in a check method
Object	clone()
boolean	evaluates() check whether or not this job entry evaluates.
Result	execute(Result result, int nr)
String	getAuthenticationPassword()
String	getAuthenticationUser()
String	getComment()
String	getContactPerson()
String	getContactPhone()
String	getDestination()
String	getDestinationBCc()
String	getDestinationCc()
String	getEncoding()
int[]	getFileType()
String	getImportance()
boolean	getIncludeDate()
String	getPort()
String	getPriority()
String	getReplyAddress()
String	getReplyName()
String	getReplyToAddresses()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
String	getSecureConnectionType()
String	getServer()
String	getSubject()
String	getXML()
String	getZipFilename()
boolean	isIncludingFiles()
boolean	isOnlySendComment()
boolean	isUnconditional()
boolean	isUseHTML()
boolean	isUsePriority()
boolean	isUsingAuthentication()
boolean	isUsingSecureAuthentication()
boolean	isZipFiles()
void	loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
void	saveRep(Repository rep, ObjectId id_job)
void	setAuthenticationPassword(String authenticationPassword)
void	setAuthenticationUser(String authenticationUser)
void	setComment(String comm)
void	setContactPerson(String person)
void	setContactPhone(String phone)
void	setDestination(String dest)
void	setDestinationBCc(String destBCc)
void	setDestinationCc(String destCc)
void	setEncoding(String encoding)
void	setFileType(int[] fileType)
void	setImportance(String importance)
void	setIncludeDate(boolean incl)
void	setIncludingFiles(boolean includeFiles)
void	setOnlySendComment(boolean onlySendComment)
void	setPort(String port)
void	setPriority(String priority)
void	setReplyAddress(String reply)
void	setReplyName(String replyname)
void	setReplyToAddresses(String replyToAddresses)
void	setSecureConnectionType(String secureConnectionType)
void	setServer(String s)
void	setSubject(String subj)
void	setUseHTML(boolean useHTML)
void	setUsePriority(boolean usePriority)
void	setUsingAuthentication(boolean usingAuthentication)
void	setUsingSecureAuthentication(boolean usingSecureAuthentication)
void	setZipFilename(String zipFilename)
void	setZipFiles(boolean zipFiles)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Field Detail

embeddedimages

public String[] embeddedimages

contentids

public String[] contentids

Constructor Detail

JobEntryMail

public JobEntryMail(String n)

JobEntryMail

public JobEntryMail()

Method Detail

clone

public Object clone()

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

getXML

public String getXML()

Specified by:

getXML in interface JobEntryInterface

Overrides:

getXML in class JobEntryBase

allocate

public void allocate(int nrFileTypes)

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException

Specified by:

loadXML in interface JobEntryInterface

Throws:

KettleXMLException

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Throws:

KettleException

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Throws:

KettleException

setServer

public void setServer(String s)

getServer

public String getServer()

setDestination

public void setDestination(String dest)

setDestinationCc

public void setDestinationCc(String destCc)

setDestinationBCc

public void setDestinationBCc(String destBCc)

getDestination

public String getDestination()

getDestinationCc

public String getDestinationCc()

getDestinationBCc

public String getDestinationBCc()

setReplyAddress

public void setReplyAddress(String reply)

getReplyAddress

public String getReplyAddress()

setReplyName

public void setReplyName(String replyname)

getReplyName

public String getReplyName()

setSubject

public void setSubject(String subj)

getSubject

public String getSubject()

setIncludeDate

public void setIncludeDate(boolean incl)

getIncludeDate

public boolean getIncludeDate()

setContactPerson

public void setContactPerson(String person)

getContactPerson

public String getContactPerson()

setContactPhone

public void setContactPhone(String phone)

getContactPhone

public String getContactPhone()

setComment

public void setComment(String comm)

getComment

public String getComment()

getFileType

public int[] getFileType()

Returns:

the result file types to select for attachment

See Also:

ResultFile

setFileType

public void setFileType(int[] fileType)

Parameters:

fileType - the result file types to select for attachment

See Also:

ResultFile

isIncludingFiles

public boolean isIncludingFiles()

setIncludingFiles

public void setIncludingFiles(boolean includeFiles)

getZipFilename

public String getZipFilename()

Returns:

Returns the zipFilename.

setZipFilename

public void setZipFilename(String zipFilename)

Parameters:

zipFilename - The zipFilename to set.

isZipFiles

public boolean isZipFiles()

Returns:

Returns the zipFiles.

setZipFiles

public void setZipFiles(boolean zipFiles)

Parameters:

zipFiles - The zipFiles to set.

getAuthenticationPassword

public String getAuthenticationPassword()

Returns:

Returns the authenticationPassword.

setAuthenticationPassword

public void setAuthenticationPassword(String authenticationPassword)

Parameters:

authenticationPassword - The authenticationPassword to set.

getAuthenticationUser

public String getAuthenticationUser()

Returns:

Returns the authenticationUser.

setAuthenticationUser

public void setAuthenticationUser(String authenticationUser)

Parameters:

authenticationUser - The authenticationUser to set.

isUsingAuthentication

public boolean isUsingAuthentication()

Returns:

Returns the usingAuthentication.

setUsingAuthentication

public void setUsingAuthentication(boolean usingAuthentication)

Parameters:

usingAuthentication - The usingAuthentication to set.

isOnlySendComment

public boolean isOnlySendComment()

Returns:

the onlySendComment flag

setOnlySendComment

public void setOnlySendComment(boolean onlySendComment)

Parameters:

onlySendComment - the onlySendComment flag to set

isUseHTML

public boolean isUseHTML()

Returns:

the useHTML flag

setUseHTML

public void setUseHTML(boolean useHTML)

Parameters:

useHTML - the useHTML to set

getEncoding

public String getEncoding()

Returns:

the encoding

getSecureConnectionType

public String getSecureConnectionType()

Returns:

the secure connection type

setSecureConnectionType

public void setSecureConnectionType(String secureConnectionType)

Parameters:

secureConnectionType - the secure connection type to set

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the encoding to set

setReplyToAddresses

public void setReplyToAddresses(String replyToAddresses)

Parameters:

secureconnectiontype - the replayToAddresses to set

getReplyToAddresses

public String getReplyToAddresses()

Returns:

replayToAddresses

setUsePriority

public void setUsePriority(boolean usePriority)

Parameters:

usePriority - the usePriority to set

isUsePriority

public boolean isUsePriority()

Returns:

the usePriority flag

getPriority

public String getPriority()

Returns:

the priority

setImportance

public void setImportance(String importance)

Parameters:

importance - the importance to set

getImportance

public String getImportance()

Returns:

the importance

setPriority

public void setPriority(String priority)

Parameters:

priority - the priority to set

execute

public Result execute(Result result,
                      int nr)

Specified by:

execute in interface JobEntryInterface

evaluates

public boolean evaluates()

Description copied from class: JobEntryBase

check whether or not this job entry evaluates.

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:

true if the job entry evaluates

isUnconditional

public boolean isUnconditional()

Specified by:

isUnconditional in interface JobEntryInterface

Overrides:

isUnconditional in class JobEntryBase

isUsingSecureAuthentication

public boolean isUsingSecureAuthentication()

Returns:

the usingSecureAuthentication

setUsingSecureAuthentication

public void setUsingSecureAuthentication(boolean usingSecureAuthentication)

Parameters:

usingSecureAuthentication - the usingSecureAuthentication to set

getPort

public String getPort()

Returns:

the port

setPort

public void setPort(String port)

Parameters:

port - the port to set

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

Get a list of all the resource dependencies that the step is depending on.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

a list of all the resource dependencies that the step is depending on

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta)

Description copied from class: JobEntryBase

Support for overrides not having to put in a check method

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - CheckResults from checking the job entry

jobMeta - JobMeta information letting threading back to the JobMeta possible