Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.oodt.cas.pushpull.protocol.sftp
Class JschSftpClient

java.lang.Object
  extended by org.apache.oodt.cas.pushpull.protocol.Protocol
      extended by org.apache.oodt.cas.pushpull.protocol.sftp.JschSftpClient

public class JschSftpClient
extends Protocol

An implement of an SFTP provider based on Jcraft's JSCH library.

Version:
$Revision$
Author:
bfoster

Field Summary
 
Fields inherited from class org.apache.oodt.cas.pushpull.protocol.Protocol
protocolType, remoteSite
 
Constructor Summary
JschSftpClient()
           
 
Method Summary
 void abortCurFileTransfer()
           
 void cdToRoot()
           
protected  void chDir(ProtocolPath path)
           
protected  void connect(java.lang.String host, java.lang.String username, java.lang.String password)
           
protected  boolean deleteFile(ProtocolFile file)
           
 void disconnectFromServer()
          Disconnects the Protocol for the server
 ProtocolFile getCurrentWorkingDir()
          Returns a string value of current directory -- similar to U*ix pwd()
 void getFile(ProtocolFile file, java.io.File toLocalFile)
          Downloads a file from Protocol server to the location specified by the java.io.File passed in.
 boolean isConnected()
          Can be used to determine if Protocol is connected
 java.util.List<ProtocolFile> listFiles()
           
 
Methods inherited from class org.apache.oodt.cas.pushpull.protocol.Protocol
cd, cdToHOME, cdToROOT, connect, delete, disconnect, download, download, equals, getAbsPathFor, getHomeDir, getProtocolFileFor, getProtocolType, getRemoteSite, isProtocolConnected, ls, ls, ls, pwd, reconnect
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JschSftpClient

public JschSftpClient()
Method Detail

chDir

protected void chDir(ProtocolPath path)
              throws ProtocolException
Specified by:
chDir in class Protocol
Throws:
ProtocolException

cdToRoot

public void cdToRoot()
              throws ProtocolException
Specified by:
cdToRoot in class Protocol
Throws:
ProtocolException

connect

protected void connect(java.lang.String host,
                       java.lang.String username,
                       java.lang.String password)
                throws ProtocolException
Specified by:
connect in class Protocol
Throws:
ProtocolException

disconnectFromServer

public void disconnectFromServer()
                          throws ProtocolException
Description copied from class: Protocol
Disconnects the Protocol for the server

Specified by:
disconnectFromServer in class Protocol
Throws:
ProtocolException

getFile

public void getFile(ProtocolFile file,
                    java.io.File toLocalFile)
             throws ProtocolException
Description copied from class: Protocol
Downloads a file from Protocol server to the location specified by the java.io.File passed in. Only a name can be passed in for fileName, can't be a path. User must first navigate to the directory which contains the file and then can call this method.

Specified by:
getFile in class Protocol
Throws:
ProtocolException

abortCurFileTransfer

public void abortCurFileTransfer()
Specified by:
abortCurFileTransfer in class Protocol

listFiles

public java.util.List<ProtocolFile> listFiles()
                                       throws ProtocolException
Specified by:
listFiles in class Protocol
Throws:
ProtocolException

getCurrentWorkingDir

public ProtocolFile getCurrentWorkingDir()
                                  throws ProtocolException
Description copied from class: Protocol
Returns a string value of current directory -- similar to U*ix pwd()

Specified by:
getCurrentWorkingDir in class Protocol
Returns:
The path of current directory
Throws:
ProtocolException

isConnected

public boolean isConnected()
                    throws ProtocolException
Description copied from class: Protocol
Can be used to determine if Protocol is connected

Specified by:
isConnected in class Protocol
Returns:
true if Protocol is connected, otherwise false
Throws:
ProtocolException

deleteFile

protected boolean deleteFile(ProtocolFile file)
Specified by:
deleteFile in class Protocol
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2011 Apache OODT. All Rights Reserved.