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()
          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 previousResult, int nr)
          Execute the job entry.
 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)
          Gets 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()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 boolean isAddToResult()
           
 boolean isCopyPrevious()
           
 boolean iscreateTargetFolder()
           
 boolean isUseKeyFile()
           
 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.
static void main(String[] args)
           
 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 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()
Description copied from class: JobEntryBase
This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:
clone in interface JobEntryInterface
Overrides:
clone in class JobEntryBase
Returns:
a clone of the object

getXML

public String getXML()
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:
getXML in interface JobEntryInterface
Overrides:
getXML in class JobEntryBase
Returns:
the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException
Description copied from interface: JobEntryInterface
This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry�s settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:
loadXML in interface JobEntryInterface
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
id_jobentry - the id of the job entry
databases - the list of databases
slaveServers - the list of slave servers
Throws:
KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
id_job - the id_job
Throws:
KettleException - if any errors occur during the save

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)
Description copied from interface: JobEntryInterface
Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:
execute in interface JobEntryInterface
Parameters:
previousResult - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry

evaluates

public boolean evaluates()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:
evaluates in interface JobEntryInterface
Overrides:
evaluates in class JobEntryBase
Returns:
false

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
Description copied from class: JobEntryBase
Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:
getResourceDependencies in interface JobEntryInterface
Overrides:
getResourceDependencies in class JobEntryBase
Returns:
an empty list of ResourceReferences
See Also:
ResourceReference

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. For JobEntryBase, this method performs no operations.

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)