Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.yaftp.ftp
Interface FtpConnection  view FtpConnection download FtpConnection.java

All Known Implementing Classes:
FtpClientSession, LocalFileConnection

public interface FtpConnection

in order to emulate FTP commands on any non FTP file system (LocalFile, URL.....) we define following interface which should be implemented by FTP like candidate sessions

Version:
: 0.0.1

Method Summary
 void changeDirectory(java.lang.String name)
          proceed with standard change directory command
 boolean delete(java.lang.String candidate)
          proceed with single file deletion
 java.util.Vector filteredList()
          retuns the Directory list vector
 java.lang.String ftpCommand(java.lang.String command)
          Proceed with user entered FTP commands
 java.lang.String[] get_column_names()
          returns the names of expanded mode list view
 java.lang.String get_ftpSrvName()
          return a well known name identifying this FTP
 java.lang.String getDirectoryMessage()
          return message appropriate to directory change
 java.lang.String getOsDetails()
          returns OS detail string if needed
 java.lang.String getOSFtp()
          returns OSFtp identification
 boolean isLocal()
          return true if FTP implementors deasl with local drive session
 boolean isMVS()
          returns true if connection is an MVS FTP session
 void newDirectory(java.lang.String name)
          build a new directory command
 void removeDirectory(java.lang.String candidate)
          proceed with remove empty directory command
 void rename(java.lang.String from, java.lang.String to)
          proceed with rename a file element(Dir or file)
 void set_jesMode(boolean jesMode)
          this idiosynchrasie is used for MVS only
 void stop()
          proceed with needed session termination
 

Method Detail

changeDirectory

public void changeDirectory(java.lang.String name)
                     throws ClientFtpError
proceed with standard change directory command


newDirectory

public void newDirectory(java.lang.String name)
                  throws ClientFtpError
build a new directory command


rename

public void rename(java.lang.String from,
                   java.lang.String to)
            throws ClientFtpError
proceed with rename a file element(Dir or file)


isLocal

public boolean isLocal()
return true if FTP implementors deasl with local drive session


get_ftpSrvName

public java.lang.String get_ftpSrvName()
return a well known name identifying this FTP


filteredList

public java.util.Vector filteredList()
                              throws ClientFtpError
retuns the Directory list vector


get_column_names

public java.lang.String[] get_column_names()
returns the names of expanded mode list view


getOSFtp

public java.lang.String getOSFtp()
returns OSFtp identification


getOsDetails

public java.lang.String getOsDetails()
returns OS detail string if needed


isMVS

public boolean isMVS()
returns true if connection is an MVS FTP session


set_jesMode

public void set_jesMode(boolean jesMode)
this idiosynchrasie is used for MVS only


getDirectoryMessage

public java.lang.String getDirectoryMessage()
return message appropriate to directory change


ftpCommand

public java.lang.String ftpCommand(java.lang.String command)
                            throws ClientFtpError
Proceed with user entered FTP commands


delete

public boolean delete(java.lang.String candidate)
               throws ClientFtpError
proceed with single file deletion


removeDirectory

public void removeDirectory(java.lang.String candidate)
                     throws ClientFtpError
proceed with remove empty directory command


stop

public void stop()
          throws ClientFtpError
proceed with needed session termination