org.pentaho.di.job.entries.getpop
Class JobEntryGetPOP

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.getpop.JobEntryGetPOP

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryGetPOP
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines an get pop job entry.

Since:

01-03-2007

Author:

Samatar

Field Summary

int	actiontype
int	aftergetimap
int	conditionReceivedDate
static String	DATE_PATTERN
int	retrievemails
int	valueimaplist

Constructor Summary

JobEntryGetPOP()

JobEntryGetPOP(String n)

Method Summary

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 previousResult, int nr)
String	geProxyUsername()
int	getActionType()
int	getAfterGetIMAP()
String	getAttachmentFolder()
String	getAttachmentWildcard()
String	getBodySearch()
int	getConditionOnReceivedDate()
boolean	getDelete()
String	getFilenamePattern()
String	getFirstIMAPMails()
String	getFirstMails()
String	getIMAPFolder()
String	getMoveToIMAPFolder()
String	getOutputDirectory()
String	getPassword()
String	getPort()
String	getProtocol()
String	getProxyUsername()
String	getRealFilenamePattern()
String	getRealFirstMails()
String	getRealOutputDirectory()
String	getRealPassword()
String	getRealPort()
String	getRealProxyUsername()
String	getRealServername()
String	getRealUsername()
String	getReceipientSearch()
String	getReceivedDate1()
String	getReceivedDate2()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
int	getRetrievemails()
String	getSenderSearchTerm()
String	getServerName()
String	getSubjectSearch()
String	getUserName()
int	getValueImapList()
String	getXML()
boolean	isCreateLocalFolder()
boolean	isCreateMoveToFolder()
boolean	isDifferentFolderForAttachment()
boolean	isIncludeSubFolders()
boolean	isNotTermBodySearch()
boolean	isNotTermReceipientSearch()
boolean	isNotTermReceivedDateSearch()
boolean	isNotTermSenderSearch()
boolean	isNotTermSubjectSearch()
boolean	isSaveAttachment()
boolean	isSaveMessage()
boolean	isUseProxy()
boolean	isUseSSL()
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	setActionType(int actiontype)
void	setAfterGetIMAP(int afterget)
void	setAttachmentFolder(String foldername)
void	setAttachmentWildcard(String wildcard)
void	setBodySearch(String bodySearch)
void	setConditionOnReceivedDate(int conditionReceivedDate)
void	setCreateLocalFolder(boolean createfolder)
void	setCreateMoveToFolder(boolean createfolder)
void	setDelete(boolean delete)
void	setDifferentFolderForAttachment(boolean usedifferentfolder)
void	setFilenamePattern(String filenamepattern)
void	setFirstIMAPMails(String firstmails)
void	setFirstMails(String firstmails)
void	setIMAPFolder(String folder)
void	setIncludeSubFolders(boolean includesubfolders)
void	setMoveToIMAPFolder(String foldername)
void	setNotTermBodySearch(boolean notTermBodySearch)
void	setNotTermReceipientSearch(boolean notTermReceipientSearch)
void	setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)
void	setNotTermSenderSearch(boolean notTermSenderSearch)
void	setNotTermSubjectSearch(boolean notTermSubjectSearch)
void	setOutputDirectory(String outputdirectory)
void	setPassword(String password)
void	setPort(String sslport)
void	setProtocol(String protocol)
void	setProxyUsername(String username)
void	setReceipientSearch(String receipientSearch)
void	setReceivedDate1(String inputDate)
void	setReceivedDate2(String inputDate)
void	setRetrievemails(int nr)
void	setSaveAttachment(boolean saveattachment)
void	setSaveMessage(boolean savemessage)
void	setSenderSearchTerm(String senderSearch)
void	setServerName(String servername)
void	setSubjectSearch(String subjectSearch)
void	setUseProxy(boolean useprox)
void	setUserName(String username)
void	setUseSSL(boolean usessl)
void	setValueImapList(int value)

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, isUnconditional, 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, isUnconditional, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Field Detail

actiontype

public int actiontype

conditionReceivedDate

public int conditionReceivedDate

valueimaplist

public int valueimaplist

aftergetimap

public int aftergetimap

retrievemails

public int retrievemails

DATE_PATTERN

public static final String DATE_PATTERN

See Also:

Constant Field Values

Constructor Detail

JobEntryGetPOP

public JobEntryGetPOP(String n)

JobEntryGetPOP

public JobEntryGetPOP()

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

loadXML

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

Specified by:

loadXML in interface JobEntryInterface

Throws:

KettleXMLException

getValueImapList

public int getValueImapList()

setValueImapList

public void setValueImapList(int value)

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

getPort

public String getPort()

getRealPort

public String getRealPort()

setPort

public void setPort(String sslport)

setFirstMails

public void setFirstMails(String firstmails)

getFirstMails

public String getFirstMails()

isIncludeSubFolders

public boolean isIncludeSubFolders()

setIncludeSubFolders

public void setIncludeSubFolders(boolean includesubfolders)

setFirstIMAPMails

public void setFirstIMAPMails(String firstmails)

getFirstIMAPMails

public String getFirstIMAPMails()

setSenderSearchTerm

public void setSenderSearchTerm(String senderSearch)

getSenderSearchTerm

public String getSenderSearchTerm()

setNotTermSenderSearch

public void setNotTermSenderSearch(boolean notTermSenderSearch)

isNotTermSenderSearch

public boolean isNotTermSenderSearch()

setNotTermSubjectSearch

public void setNotTermSubjectSearch(boolean notTermSubjectSearch)

setNotTermBodySearch

public void setNotTermBodySearch(boolean notTermBodySearch)

isNotTermSubjectSearch

public boolean isNotTermSubjectSearch()

isNotTermBodySearch

public boolean isNotTermBodySearch()

setNotTermReceivedDateSearch

public void setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)

isNotTermReceivedDateSearch

public boolean isNotTermReceivedDateSearch()

setNotTermReceipientSearch

public void setNotTermReceipientSearch(boolean notTermReceipientSearch)

isNotTermReceipientSearch

public boolean isNotTermReceipientSearch()

setCreateMoveToFolder

public void setCreateMoveToFolder(boolean createfolder)

isCreateMoveToFolder

public boolean isCreateMoveToFolder()

setReceipientSearch

public void setReceipientSearch(String receipientSearch)

getReceipientSearch

public String getReceipientSearch()

setSubjectSearch

public void setSubjectSearch(String subjectSearch)

getSubjectSearch

public String getSubjectSearch()

setBodySearch

public void setBodySearch(String bodySearch)

getBodySearch

public String getBodySearch()

getReceivedDate1

public String getReceivedDate1()

setReceivedDate1

public void setReceivedDate1(String inputDate)

getReceivedDate2

public String getReceivedDate2()

setReceivedDate2

public void setReceivedDate2(String inputDate)

setMoveToIMAPFolder

public void setMoveToIMAPFolder(String foldername)

getMoveToIMAPFolder

public String getMoveToIMAPFolder()

setCreateLocalFolder

public void setCreateLocalFolder(boolean createfolder)

isCreateLocalFolder

public boolean isCreateLocalFolder()

setConditionOnReceivedDate

public void setConditionOnReceivedDate(int conditionReceivedDate)

getConditionOnReceivedDate

public int getConditionOnReceivedDate()

setActionType

public void setActionType(int actiontype)

getActionType

public int getActionType()

setAfterGetIMAP

public void setAfterGetIMAP(int afterget)

getAfterGetIMAP

public int getAfterGetIMAP()

getRealFirstMails

public String getRealFirstMails()

setServerName

public void setServerName(String servername)

getServerName

public String getServerName()

setUserName

public void setUserName(String username)

getUserName

public String getUserName()

setOutputDirectory

public void setOutputDirectory(String outputdirectory)

setFilenamePattern

public void setFilenamePattern(String filenamepattern)

setRetrievemails

public void setRetrievemails(int nr)

getRetrievemails

public int getRetrievemails()

getFilenamePattern

public String getFilenamePattern()

getOutputDirectory

public String getOutputDirectory()

getRealOutputDirectory

public String getRealOutputDirectory()

getRealFilenamePattern

public String getRealFilenamePattern()

getRealUsername

public String getRealUsername()

getRealServername

public String getRealServername()

getRealProxyUsername

public String getRealProxyUsername()

geProxyUsername

public String geProxyUsername()

getPassword

public String getPassword()

Returns:

Returns the password.

getRealPassword

public String getRealPassword()

getAttachmentFolder

public String getAttachmentFolder()

setAttachmentFolder

public void setAttachmentFolder(String foldername)

setDelete

public void setDelete(boolean delete)

Parameters:

delete - The delete to set.

getDelete

public boolean getDelete()

Returns:

Returns the delete.

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

getIMAPFolder

public String getIMAPFolder()

setIMAPFolder

public void setIMAPFolder(String folder)

setAttachmentWildcard

public void setAttachmentWildcard(String wildcard)

getAttachmentWildcard

public String getAttachmentWildcard()

setUseSSL

public void setUseSSL(boolean usessl)

Parameters:

usessl - The usessl to set.

isUseSSL

public boolean isUseSSL()

Returns:

Returns the usessl.

isUseProxy

public boolean isUseProxy()

Returns:

Returns the useproxy.

setUseProxy

public void setUseProxy(boolean useprox)

isSaveAttachment

public boolean isSaveAttachment()

setProxyUsername

public void setProxyUsername(String username)

getProxyUsername

public String getProxyUsername()

setSaveAttachment

public void setSaveAttachment(boolean saveattachment)

isSaveMessage

public boolean isSaveMessage()

setSaveMessage

public void setSaveMessage(boolean savemessage)

setDifferentFolderForAttachment

public void setDifferentFolderForAttachment(boolean usedifferentfolder)

isDifferentFolderForAttachment

public boolean isDifferentFolderForAttachment()

setPassword

public void setPassword(String password)

Parameters:

password - The password to set.

execute

public Result execute(Result previousResult,
                      int nr)
               throws KettleException

Specified by:

execute in interface JobEntryInterface

Throws:

KettleException

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

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

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