org.pentaho.di.job.entries.sftp
Class JobEntrySFTP

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.sftp.JobEntrySFTP
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySFTP
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a SFTP job entry.

Since:
05-11-2003
Author:
Matt

Constructor Summary
JobEntrySFTP()
           
JobEntrySFTP(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 getCompression()
           
 String getKeyFilename()
           
 String getKeyPassPhrase()
           
 String getPassword()
           
 String getProxyHost()
           
 String getProxyPassword()
           
 String getProxyPort()
           
 String getProxyType()
           
 String getProxyUsername()
           
 boolean getRemove()
           
 List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
          Get a list of all the resource dependencies that the step is depending on.
 String getScpDirectory()
           
 String getServerName()
           
 String getServerPort()
           
 String getTargetDirectory()
           
 String getUserName()
           
 String getWildcard()
           
 String getXML()
           
 boolean isAddToResult()
           
 boolean isCopyPrevious()
           
 boolean iscreateTargetFolder()
           
 boolean isUseKeyFile()
           
 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)
           
static void main(String[] args)
           
 void saveRep(Repository rep, ObjectId id_job)
           
 void setAddToResult(boolean isaddresultin)
           
 void setCompression(String compression)
           
 void setCopyPrevious(boolean copyprevious)
           
 void setcreateTargetFolder(boolean createtargetfolder)
           
 void setKeyFilename(String value)
           
 void setKeyPassPhrase(String value)
           
 void setPassword(String password)
           
 void setProxyHost(String value)
           
 void setProxyPassword(String value)
           
 void setProxyPort(String value)
           
 void setProxyType(String value)
           
 void setProxyUsername(String value)
           
 void setRemove(boolean remove)
           
 void setScpDirectory(String directory)
           
 void setServerName(String serverName)
           
 void setServerPort(String serverPort)
           
 void setTargetDirectory(String targetDirectory)
           
 void setUseKeyFile(boolean value)
           
 void setUserName(String userName)
           
 void setWildcard(String wildcard)
           
 
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
 

Constructor Detail

JobEntrySFTP

public JobEntrySFTP(String n)

JobEntrySFTP

public JobEntrySFTP()
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

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

getScpDirectory

public String getScpDirectory()
Returns:
Returns the directory.

setScpDirectory

public void setScpDirectory(String directory)
Parameters:
directory - The directory to set.

getPassword

public String getPassword()
Returns:
Returns the password.

setPassword

public void setPassword(String password)
Parameters:
password - The password to set.

getCompression

public String getCompression()
Returns:
Returns the compression.

setCompression

public void setCompression(String compression)
Parameters:
compression - The compression to set.

getServerName

public String getServerName()
Returns:
Returns the serverName.

setServerName

public void setServerName(String serverName)
Parameters:
serverName - The serverName to set.

getUserName

public String getUserName()
Returns:
Returns the userName.

setUserName

public void setUserName(String userName)
Parameters:
userName - The userName to set.

getWildcard

public String getWildcard()
Returns:
Returns the wildcard.

setWildcard

public void setWildcard(String wildcard)
Parameters:
wildcard - The wildcard to set.

setAddToResult

public void setAddToResult(boolean isaddresultin)

isAddToResult

public boolean isAddToResult()

getTargetDirectory

public String getTargetDirectory()
Returns:
Returns the targetDirectory.

setcreateTargetFolder

public void setcreateTargetFolder(boolean createtargetfolder)

iscreateTargetFolder

public boolean iscreateTargetFolder()

isCopyPrevious

public boolean isCopyPrevious()

setCopyPrevious

public void setCopyPrevious(boolean copyprevious)

setTargetDirectory

public void setTargetDirectory(String targetDirectory)
Parameters:
targetDirectory - The targetDirectory to set.

setRemove

public void setRemove(boolean remove)
Parameters:
remove - The remove to set.

getRemove

public boolean getRemove()
Returns:
Returns the remove.

getServerPort

public String getServerPort()

setServerPort

public void setServerPort(String serverPort)

isUseKeyFile

public boolean isUseKeyFile()

setUseKeyFile

public void setUseKeyFile(boolean value)

getKeyFilename

public String getKeyFilename()

setKeyFilename

public void setKeyFilename(String value)

getKeyPassPhrase

public String getKeyPassPhrase()

setKeyPassPhrase

public void setKeyPassPhrase(String value)

getProxyType

public String getProxyType()

setProxyType

public void setProxyType(String value)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String value)

getProxyPort

public String getProxyPort()

setProxyPort

public void setProxyPort(String value)

getProxyUsername

public String getProxyUsername()

setProxyUsername

public void setProxyUsername(String value)

getProxyPassword

public String getProxyPassword()

setProxyPassword

public void setProxyPassword(String value)

execute

public Result execute(Result previousResult,
                      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

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

main

public static void main(String[] args)