org.apache.camel.component.file.remote
Class SftpOperations

java.lang.Object
  extended by org.apache.camel.component.file.remote.SftpOperations
All Implemented Interfaces:
org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>, RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>

public class SftpOperations
extends Object
implements RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>

SFTP remote file operations


Nested Class Summary
static interface SftpOperations.ExtendedUserInfo
          Extended user info which supports interactive keyboard mode, by entering the password.
 
Constructor Summary
SftpOperations()
           
SftpOperations(com.jcraft.jsch.Proxy proxy)
           
 
Method Summary
 boolean buildDirectory(String directory, boolean absolute)
           
 void changeCurrentDirectory(String path)
           
 void changeToParentDirectory()
           
 boolean connect(RemoteFileConfiguration configuration)
          Connects to the remote server
protected  com.jcraft.jsch.Session createSession(RemoteFileConfiguration configuration)
           
 boolean deleteFile(String name)
           
 void disconnect()
          Disconnects from the remote server
 boolean existsFile(String name)
           
protected  boolean fastExistsFile(String name)
           
 String getCurrentDirectory()
           
 boolean isConnected()
          Returns whether we are connected to the remote server or not
 List<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles()
           
 List<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles(String path)
           
 void releaseRetreivedFileResources(org.apache.camel.Exchange exchange)
           
 boolean renameFile(String from, String to)
           
 boolean retrieveFile(String name, org.apache.camel.Exchange exchange)
           
 boolean sendNoop()
          Sends a noop command to the remote server
 boolean sendSiteCommand(String command)
          Sends a site command to the remote server
 void setEndpoint(org.apache.camel.component.file.GenericFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry> endpoint)
           
 boolean storeFile(String name, org.apache.camel.Exchange exchange)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SftpOperations

public SftpOperations()

SftpOperations

public SftpOperations(com.jcraft.jsch.Proxy proxy)
Method Detail

setEndpoint

public void setEndpoint(org.apache.camel.component.file.GenericFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry> endpoint)
Specified by:
setEndpoint in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>

connect

public boolean connect(RemoteFileConfiguration configuration)
                throws org.apache.camel.component.file.GenericFileOperationFailedException
Description copied from interface: RemoteFileOperations
Connects to the remote server

Specified by:
connect in interface RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Parameters:
configuration - configuration
Returns:
true if connected
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException - can be thrown

createSession

protected com.jcraft.jsch.Session createSession(RemoteFileConfiguration configuration)
                                         throws com.jcraft.jsch.JSchException
Throws:
com.jcraft.jsch.JSchException

isConnected

public boolean isConnected()
                    throws org.apache.camel.component.file.GenericFileOperationFailedException
Description copied from interface: RemoteFileOperations
Returns whether we are connected to the remote server or not

Specified by:
isConnected in interface RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Returns:
true if connected, false if not
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException - can be thrown

disconnect

public void disconnect()
                throws org.apache.camel.component.file.GenericFileOperationFailedException
Description copied from interface: RemoteFileOperations
Disconnects from the remote server

Specified by:
disconnect in interface RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException - can be thrown

deleteFile

public boolean deleteFile(String name)
                   throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
deleteFile in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

renameFile

public boolean renameFile(String from,
                          String to)
                   throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
renameFile in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

buildDirectory

public boolean buildDirectory(String directory,
                              boolean absolute)
                       throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
buildDirectory in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

getCurrentDirectory

public String getCurrentDirectory()
                           throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
getCurrentDirectory in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

changeCurrentDirectory

public void changeCurrentDirectory(String path)
                            throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
changeCurrentDirectory in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

changeToParentDirectory

public void changeToParentDirectory()
                             throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
changeToParentDirectory in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

listFiles

public List<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles()
                                                    throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
listFiles in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

listFiles

public List<com.jcraft.jsch.ChannelSftp.LsEntry> listFiles(String path)
                                                    throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
listFiles in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

retrieveFile

public boolean retrieveFile(String name,
                            org.apache.camel.Exchange exchange)
                     throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
retrieveFile in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

releaseRetreivedFileResources

public void releaseRetreivedFileResources(org.apache.camel.Exchange exchange)
                                   throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
releaseRetreivedFileResources in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

storeFile

public boolean storeFile(String name,
                         org.apache.camel.Exchange exchange)
                  throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
storeFile in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

existsFile

public boolean existsFile(String name)
                   throws org.apache.camel.component.file.GenericFileOperationFailedException
Specified by:
existsFile in interface org.apache.camel.component.file.GenericFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

fastExistsFile

protected boolean fastExistsFile(String name)
                          throws org.apache.camel.component.file.GenericFileOperationFailedException
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException

sendNoop

public boolean sendNoop()
                 throws org.apache.camel.component.file.GenericFileOperationFailedException
Description copied from interface: RemoteFileOperations
Sends a noop command to the remote server

Specified by:
sendNoop in interface RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Returns:
true if the noop was a success, false otherwise
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException - can be thrown

sendSiteCommand

public boolean sendSiteCommand(String command)
                        throws org.apache.camel.component.file.GenericFileOperationFailedException
Description copied from interface: RemoteFileOperations
Sends a site command to the remote server

Specified by:
sendSiteCommand in interface RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>
Parameters:
command - the command
Returns:
true if the command was a success, false otherwise
Throws:
org.apache.camel.component.file.GenericFileOperationFailedException - can be thrown


Apache Camel