|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.job.entry.JobEntryBase org.pentaho.di.job.entries.mail.JobEntryMail
public class JobEntryMail
Describes a Mail Job Entry.
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()
This method is called when a job entry is duplicated in Spoon. |
boolean |
evaluates()
This method must return true if the job entry supports the true/false outgoing hops. |
Result |
execute(Result result,
int nr)
Execute the job entry. |
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)
Gets a list of all the resource dependencies that the step is depending on. |
String |
getSecureConnectionType()
|
String |
getServer()
|
String |
getSubject()
|
String |
getXML()
This method is called by PDI whenever a job entry needs to serialize its settings to XML. |
String |
getZipFilename()
|
boolean |
isIncludingFiles()
|
boolean |
isOnlySendComment()
|
boolean |
isUnconditional()
This method must return true if the job entry supports the unconditional outgoing hop. |
boolean |
isUseHTML()
|
boolean |
isUsePriority()
|
boolean |
isUsingAuthentication()
|
boolean |
isUsingSecureAuthentication()
|
boolean |
isZipFiles()
|
void |
loadRep(Repository rep,
ObjectId id_jobentry,
List<DatabaseMeta> databases,
List<SlaveServer> slaveServers)
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. |
void |
loadXML(Node entrynode,
List<DatabaseMeta> databases,
List<SlaveServer> slaveServers,
Repository rep)
This method is called by PDI whenever a job entry needs to read its settings from XML. |
void |
saveRep(Repository rep,
ObjectId id_job)
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. |
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 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 |
---|
public String[] embeddedimages
public String[] contentids
Constructor Detail |
---|
public JobEntryMail(String n)
public JobEntryMail()
Method Detail |
---|
public Object clone()
JobEntryBase
clone
in interface JobEntryInterface
clone
in class JobEntryBase
public String getXML()
JobEntryBase
getXML
in interface JobEntryInterface
getXML
in class JobEntryBase
public void allocate(int nrFileTypes)
public void loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep) throws KettleXMLException
JobEntryInterface
loadXML
in interface JobEntryInterface
entrynode
- the top-level XML nodedatabases
- the list of databasesslaveServers
- the list of slave serversrep
- the repository object
KettleXMLException
- if any errors occur during the loading of the XMLpublic void loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers) throws KettleException
JobEntryBase
loadRep
in interface JobEntryInterface
loadRep
in class JobEntryBase
rep
- the repository objectid_jobentry
- the id of the job entrydatabases
- the list of databasesslaveServers
- the list of slave servers
KettleException
- if any errors occur during the loadpublic void saveRep(Repository rep, ObjectId id_job) throws KettleException
JobEntryBase
saveRep
in interface JobEntryInterface
saveRep
in class JobEntryBase
rep
- the repository objectid_job
- the id_job
KettleException
- if any errors occur during the savepublic void setServer(String s)
public String getServer()
public void setDestination(String dest)
public void setDestinationCc(String destCc)
public void setDestinationBCc(String destBCc)
public String getDestination()
public String getDestinationCc()
public String getDestinationBCc()
public void setReplyAddress(String reply)
public String getReplyAddress()
public void setReplyName(String replyname)
public String getReplyName()
public void setSubject(String subj)
public String getSubject()
public void setIncludeDate(boolean incl)
public boolean getIncludeDate()
public void setContactPerson(String person)
public String getContactPerson()
public void setContactPhone(String phone)
public String getContactPhone()
public void setComment(String comm)
public String getComment()
public int[] getFileType()
ResultFile
public void setFileType(int[] fileType)
fileType
- the result file types to select for attachmentResultFile
public boolean isIncludingFiles()
public void setIncludingFiles(boolean includeFiles)
public String getZipFilename()
public void setZipFilename(String zipFilename)
zipFilename
- The zipFilename to set.public boolean isZipFiles()
public void setZipFiles(boolean zipFiles)
zipFiles
- The zipFiles to set.public String getAuthenticationPassword()
public void setAuthenticationPassword(String authenticationPassword)
authenticationPassword
- The authenticationPassword to set.public String getAuthenticationUser()
public void setAuthenticationUser(String authenticationUser)
authenticationUser
- The authenticationUser to set.public boolean isUsingAuthentication()
public void setUsingAuthentication(boolean usingAuthentication)
usingAuthentication
- The usingAuthentication to set.public boolean isOnlySendComment()
public void setOnlySendComment(boolean onlySendComment)
onlySendComment
- the onlySendComment flag to setpublic boolean isUseHTML()
public void setUseHTML(boolean useHTML)
useHTML
- the useHTML to setpublic String getEncoding()
public String getSecureConnectionType()
public void setSecureConnectionType(String secureConnectionType)
secureConnectionType
- the secure connection type to setpublic void setEncoding(String encoding)
encoding
- the encoding to setpublic void setReplyToAddresses(String replyToAddresses)
secureconnectiontype
- the replayToAddresses to setpublic String getReplyToAddresses()
public void setUsePriority(boolean usePriority)
usePriority
- the usePriority to setpublic boolean isUsePriority()
public String getPriority()
public void setImportance(String importance)
importance
- the importance to setpublic String getImportance()
public void setPriority(String priority)
priority
- the priority to setpublic Result execute(Result result, int nr)
JobEntryInterface
execute
in interface JobEntryInterface
result
- the previous resultnr
- the number of rows
public boolean evaluates()
JobEntryBase
evaluates
in interface JobEntryInterface
evaluates
in class JobEntryBase
public boolean isUnconditional()
JobEntryBase
isUnconditional
in interface JobEntryInterface
isUnconditional
in class JobEntryBase
public boolean isUsingSecureAuthentication()
public void setUsingSecureAuthentication(boolean usingSecureAuthentication)
usingSecureAuthentication
- the usingSecureAuthentication to setpublic String getPort()
public void setPort(String port)
port
- the port to setpublic List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
JobEntryBase
getResourceDependencies
in interface JobEntryInterface
getResourceDependencies
in class JobEntryBase
ResourceReference
public void check(List<CheckResultInterface> remarks, JobMeta jobMeta)
JobEntryBase
check
in interface JobEntryInterface
check
in class JobEntryBase
remarks
- CheckResults from checking the job entryjobMeta
- JobMeta information letting threading back to the JobMeta possible
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |