JobEntrySSH2GET

java.lang.Object
- org.pentaho.di.job.entry.JobEntryBase
- - org.pentaho.di.job.entries.ssh2get.JobEntrySSH2GET

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
```
public class JobEntrySSH2GET
extends JobEntryBase
implements Cloneable, JobEntryInterface
```
This defines a SSH2 GET job entry.

Since:

17-12-2007

Author:

Samatar

Constructor Summary

Constructors
Constructor and Description

JobEntrySSH2GET()

JobEntrySSH2GET(String n)

Constructors
Constructor and Description
`JobEntrySSH2GET()`
`JobEntrySSH2GET(String n)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Allows JobEntry objects to check themselves for consistency
`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.
`org.pentaho.di.core.Result`	`execute(org.pentaho.di.core.Result previousResult, int nr)` Execute the job entry.
`boolean`	`FileExists(String filename)` Check existence of a local file
`String`	`getAfterFTPPut()`
`String`	`getDestinationFolder()`
`long`	`getFileSize(com.trilead.ssh2.SFTPv3Client sftpClient, String filename)` Returns the file size of a file
`String`	`getFtpDirectory()`
`String`	`getHTTPProxyHost()`
`String`	`getHTTPProxyPassword()`
`String`	`getHTTPProxyPort()`
`String`	`getHTTPProxyUsername()`
`String`	`getKeyFilename()`
`String`	`getKeyFilePass()`
`String`	`getlocalDirectory()`
`String`	`getPassword()`
`List<ResourceReference>`	`getResourceDependencies(JobMeta jobMeta)` Gets a list of all the resource dependencies that the step is depending on.
`String`	`getServerName()`
`String`	`getServerPort()`
`int`	`getTimeout()`
`String`	`getUserName()`
`String`	`getWildcard()`
`String`	`getXML()` This method is called by PDI whenever a job entry needs to serialize its settings to XML.
`boolean`	`isCacheHostKey()`
`boolean`	`isCreateDestinationFolder()`
`boolean`	`isCreateTargetFolder()`
`boolean`	`isDirectory(com.trilead.ssh2.SFTPv3Client sftpClient, String filename)` Checks if file is a directory
`boolean`	`isFile(com.trilead.ssh2.SFTPv3Client sftpClient, String filename)` Checks if file is a file
`boolean`	`isIncludeSubFolders()`
`boolean`	`isOnlyGettingNewFiles()`
`boolean`	`isUseBasicAuthentication()`
`boolean`	`isUseHTTPProxy()`
`boolean`	`isUsePublicKey()`
`void`	`loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.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<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore)` This method is called by PDI whenever a job entry needs to read its settings from XML.
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job)` This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
`void`	`setAfterFTPPut(String afterFtpPut)`
`void`	`setCacheHostKey(boolean cachehostkeyin)`
`void`	`setCreateDestinationFolder(boolean createdestinationfolderin)`
`void`	`setCreateTargetFolder(boolean createtargetfolderin)`
`void`	`setDestinationFolder(String destinationfolderin)`
`void`	`setFtpDirectory(String directory)`
`void`	`setHTTPProxyHost(String proxyhost)`
`void`	`setHTTPProxyPassword(String proxyPassword)`
`void`	`setHTTPProxyPort(String proxyport)`
`void`	`setHTTPProxyUsername(String proxyusername)`
`void`	`setIncludeSubFolders(boolean includeSubFolders)`
`void`	`setKeyFilename(String keyfilename)`
`void`	`setKeyFilePass(String keyFilePass)`
`void`	`setlocalDirectory(String localDirectory)`
`void`	`setOnlyGettingNewFiles(boolean onlyGettingNewFiles)`
`void`	`setPassword(String password)`
`void`	`setServerName(String serverName)`
`void`	`setServerPort(String serverPort)`
`void`	`setTimeout(int timeout)`
`void`	`setUseBasicAuthentication(boolean useBasicAuthentication)`
`void`	`setUseHTTPProxy(boolean httpproxy)`
`void`	`setUsePublicKey(boolean publickey)`
`void`	`setUserName(String userName)`
`void`	`setWildcard(String wildcard)`
`boolean`	`sshDirectoryExists(com.trilead.ssh2.SFTPv3Client sftpClient, String directory)` Checks if a directory exists
`boolean`	`sshFileExists(com.trilead.ssh2.SFTPv3Client sftpClient, String filename)` Check existence of a file

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobEntrySSH2GET
```
public JobEntrySSH2GET(String n)
```
  - JobEntrySSH2GET
```
public JobEntrySSH2GET()
```
- 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<org.pentaho.di.core.database.DatabaseMeta> databases,
           List<SlaveServer> slaveServers,
           Repository rep,
           org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.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
    
    Overrides:
    
    loadXML in class JobEntryBase
    
    Parameters:
    entrynode - the top-level XML node
    databases - the list of databases
    slaveServers - the list of slave servers
    rep - the repository object
    metaStore - The metaStore to optionally load from.
    
    Throws:
    
    org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML
  - loadRep
```
public void loadRep(Repository rep,
           org.pentaho.metastore.api.IMetaStore metaStore,
           org.pentaho.di.repository.ObjectId id_jobentry,
           List<org.pentaho.di.core.database.DatabaseMeta> databases,
           List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
```
    Description copied from interface: JobEntryInterface
    
    This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
    
    Specified by:
    
    loadRep in interface JobEntryInterface
    
    Overrides:
    
    loadRep in class JobEntryBase
    
    Parameters:
    rep - the repository object
    metaStore - the MetaStore to use
    id_jobentry - the id of the job entry
    databases - the list of databases
    slaveServers - the list of slave servers
    
    Throws:
    
    org.pentaho.di.core.exception.KettleException - if any errors occur during the load
  - saveRep
```
public void saveRep(Repository rep,
           org.pentaho.metastore.api.IMetaStore metaStore,
           org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
```
    Description copied from interface: JobEntryInterface
    
    This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
    
    Specified by:
    
    saveRep in interface JobEntryInterface
    
    Overrides:
    
    saveRep in class JobEntryBase
    
    Parameters:
    rep - the repository
    metaStore - the MetaStore to use
    id_job - the id_job
    
    Throws:
    
    org.pentaho.di.core.exception.KettleException - if any errors occur during the save
  - getFtpDirectory
```
public String getFtpDirectory()
```
    Returns:
    Returns the directory.
  - setFtpDirectory
```
public void setFtpDirectory(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.
  - getAfterFTPPut
```
public String getAfterFTPPut()
```
    Returns:
    Returns the afterftpput.
  - setAfterFTPPut
```
public void setAfterFTPPut(String afterFtpPut)
```
    Parameters:
    afterFtpPut - The action after (FTP/SSH) transfer to execute
  - setHTTPProxyPassword
```
public void setHTTPProxyPassword(String proxyPassword)
```
    Parameters:
    proxyPassword - The httpproxypassword to set.
  - getHTTPProxyPassword
```
public String getHTTPProxyPassword()
```
    Returns:
    Returns the password.
  - setKeyFilePass
```
public void setKeyFilePass(String keyFilePass)
```
    Parameters:
    keyFilePass - The key file pass to set.
  - getKeyFilePass
```
public String getKeyFilePass()
```
    Returns:
    Returns the key file pass.
  - getServerName
```
public String getServerName()
```
    Returns:
    Returns the serverName.
  - setServerName
```
public void setServerName(String serverName)
```
    Parameters:
    serverName - The serverName to set.
  - setHTTPProxyHost
```
public void setHTTPProxyHost(String proxyhost)
```
    Parameters:
    proxyhost - The httpproxyhost to set.
  - getHTTPProxyHost
```
public String getHTTPProxyHost()
```
    Returns:
    Returns the HTTP proxy host.
  - setKeyFilename
```
public void setKeyFilename(String keyfilename)
```
    Parameters:
    keyfilename - The key filename to set.
  - getKeyFilename
```
public String getKeyFilename()
```
    Returns:
    Returns the key filename.
  - getUserName
```
public String getUserName()
```
    Returns:
    Returns the userName.
  - setUserName
```
public void setUserName(String userName)
```
    Parameters:
    userName - The userName to set.
  - setHTTPProxyUsername
```
public void setHTTPProxyUsername(String proxyusername)
```
    Parameters:
    proxyusername - The httpproxyusername to set.
  - getHTTPProxyUsername
```
public String getHTTPProxyUsername()
```
    Returns:
    Returns the userName.
  - getWildcard
```
public String getWildcard()
```
    Returns:
    Returns the wildcard.
  - setWildcard
```
public void setWildcard(String wildcard)
```
    Parameters:
    wildcard - The wildcard to set.
  - getlocalDirectory
```
public String getlocalDirectory()
```
    Returns:
    Returns the localDirectory.
  - setlocalDirectory
```
public void setlocalDirectory(String localDirectory)
```
    Parameters:
    localDirectory - The localDirectory to set.
  - isOnlyGettingNewFiles
```
public boolean isOnlyGettingNewFiles()
```
    Returns:
    Returns the onlyGettingNewFiles.
  - setOnlyGettingNewFiles
```
public void setOnlyGettingNewFiles(boolean onlyGettingNewFiles)
```
    Parameters:
    onlyGettingNewFiles - The onlyGettingNewFiles to set.
  - setCacheHostKey
```
public void setCacheHostKey(boolean cachehostkeyin)
```
    Parameters:
    cachehostkeyin - The cachehostkey to set.
  - isCacheHostKey
```
public boolean isCacheHostKey()
```
    Returns:
    Returns the cachehostkey.
  - setUseHTTPProxy
```
public void setUseHTTPProxy(boolean httpproxy)
```
    Parameters:
    httpproxy - The usehttpproxy to set.
  - isUseHTTPProxy
```
public boolean isUseHTTPProxy()
```
    Returns:
    Returns the usehttpproxy.
  - isUseBasicAuthentication
```
public boolean isUseBasicAuthentication()
```
    Returns:
    Returns the use basic authentication flag.
  - setUseBasicAuthentication
```
public void setUseBasicAuthentication(boolean useBasicAuthentication)
```
    Parameters:
    useBasicAuthentication - The use basic authentication flag to set.
  - setIncludeSubFolders
```
public void setIncludeSubFolders(boolean includeSubFolders)
```
    Parameters:
    includeSubFolders - The include sub folders flag to set.
  - isIncludeSubFolders
```
public boolean isIncludeSubFolders()
```
    Returns:
    Returns the include sub folders flag.
  - setCreateDestinationFolder
```
public void setCreateDestinationFolder(boolean createdestinationfolderin)
```
    Parameters:
    createdestinationfolderin - The createdestinationfolder to set.
  - isCreateDestinationFolder
```
public boolean isCreateDestinationFolder()
```
    Returns:
    Returns the createdestinationfolder.
  - isCreateTargetFolder
```
public boolean isCreateTargetFolder()
```
    Returns:
    Returns the CreateTargetFolder.
  - setCreateTargetFolder
```
public void setCreateTargetFolder(boolean createtargetfolderin)
```
    Parameters:
    createtargetfolderin - The createtargetfolder to set.
  - setUsePublicKey
```
public void setUsePublicKey(boolean publickey)
```
    Parameters:
    publickey - The publicpublickey to set.
  - isUsePublicKey
```
public boolean isUsePublicKey()
```
    Returns:
    Returns the usehttpproxy.
  - getServerPort
```
public String getServerPort()
```
  - setServerPort
```
public void setServerPort(String serverPort)
```
  - setHTTPProxyPort
```
public void setHTTPProxyPort(String proxyport)
```
  - getHTTPProxyPort
```
public String getHTTPProxyPort()
```
  - setDestinationFolder
```
public void setDestinationFolder(String destinationfolderin)
```
  - getDestinationFolder
```
public String getDestinationFolder()
```
  - setTimeout
```
public void setTimeout(int timeout)
```
    Parameters:
    timeout - The timeout to set.
  - getTimeout
```
public int getTimeout()
```
    Returns:
    Returns the timeout.
  - execute
```
public org.pentaho.di.core.Result execute(org.pentaho.di.core.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
  - sshFileExists
```
public boolean sshFileExists(com.trilead.ssh2.SFTPv3Client sftpClient,
                    String filename)
```
    Check existence of a file
    
    Parameters:
    sftpClient -
    filename -
    
    Returns:
    true, if file exists
    
    Throws:
    
    Exception
  - FileExists
```
public boolean FileExists(String filename)
```
    Check existence of a local file
    
    Parameters:
    filename -
    
    Returns:
    true, if file exists
  - isDirectory
```
public boolean isDirectory(com.trilead.ssh2.SFTPv3Client sftpClient,
                  String filename)
```
    Checks if file is a directory
    
    Parameters:
    sftpClient -
    filename -
    
    Returns:
    true, if filename is a directory
  - sshDirectoryExists
```
public boolean sshDirectoryExists(com.trilead.ssh2.SFTPv3Client sftpClient,
                         String directory)
```
    Checks if a directory exists
    
    Parameters:
    sftpClient -
    directory -
    
    Returns:
    true, if directory exists
  - getFileSize
```
public long getFileSize(com.trilead.ssh2.SFTPv3Client sftpClient,
               String filename)
                 throws Exception
```
    Returns the file size of a file
    
    Parameters:
    sftpClient -
    filename -
    
    Returns:
    the size of the file
    
    Throws:
    
    Exception
  - isFile
```
public boolean isFile(com.trilead.ssh2.SFTPv3Client sftpClient,
             String filename)
```
    Checks if file is a file
    
    Parameters:
    sftpClient -
    filename -
    
    Returns:
    true, if filename is a directory
  - 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<org.pentaho.di.core.CheckResultInterface> remarks,
         JobMeta jobMeta,
         org.pentaho.di.core.variables.VariableSpace space,
         Repository repository,
         org.pentaho.metastore.api.IMetaStore metaStore)
```
    Description copied from class: JobEntryBase
    
    Allows JobEntry objects to check themselves for consistency
    
    Specified by:
    
    check in interface JobEntryInterface
    
    Overrides:
    
    check in class JobEntryBase
    
    Parameters:
    remarks - List of CheckResult objects indicating consistency status
    jobMeta - the metadata object for the job entry
    space - the variable space to resolve string expressions with variables with
    repository - the repository to load Kettle objects from
    metaStore - the MetaStore to load common elements from

Class JobEntrySSH2GET

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JobEntrySSH2GET

JobEntrySSH2GET

Method Detail

clone

getXML

loadXML

loadRep

saveRep

getFtpDirectory

setFtpDirectory

getPassword

setPassword

getAfterFTPPut

setAfterFTPPut

setHTTPProxyPassword

getHTTPProxyPassword

setKeyFilePass

getKeyFilePass

getServerName

setServerName

setHTTPProxyHost

getHTTPProxyHost

setKeyFilename

getKeyFilename

getUserName

setUserName

setHTTPProxyUsername

getHTTPProxyUsername

getWildcard

setWildcard

getlocalDirectory

setlocalDirectory

isOnlyGettingNewFiles

setOnlyGettingNewFiles

setCacheHostKey

isCacheHostKey

setUseHTTPProxy

isUseHTTPProxy

isUseBasicAuthentication

setUseBasicAuthentication

setIncludeSubFolders

isIncludeSubFolders

setCreateDestinationFolder

isCreateDestinationFolder

isCreateTargetFolder

setCreateTargetFolder

setUsePublicKey

isUsePublicKey

getServerPort

setServerPort

setHTTPProxyPort

getHTTPProxyPort

setDestinationFolder

getDestinationFolder

setTimeout

getTimeout

execute

sshFileExists

FileExists

isDirectory

sshDirectoryExists

getFileSize

isFile

evaluates

getResourceDependencies

check