net.sf.jfilesync.plugins.net
Interface ConnectionPlugin

All Superinterfaces:
GeneralPlugin
All Known Implementing Classes:
AbstractLocalPlugin, GnuPlugin, JSchPlugin, JSchPluginProxy, SshGnuPlugin, SSHToolsPlugin, TCommonsFTP_plugin, TLocal_plugin, TLocal_WindowsPlugin

public interface ConnectionPlugin
extends GeneralPlugin


Field Summary
 
Fields inherited from interface net.sf.jfilesync.plugins.GeneralPlugin
PROVIDES_FILETRANSFER, PROVIDES_PERMISSION_HANDLING, PROVIDES_RSYNC, PROVIDES_SHELL, PROVIDES_SYMLINK_HANDLING
 
Method Summary
 void abort()
           
 void chdir(java.lang.String path)
           
 void connect(TConnectionData connectData)
           
 void disconnect()
           
 boolean exists(java.lang.String path)
           
 void get(java.lang.String remoteFileName, java.io.OutputStream outstream)
           
 java.lang.String getAbsolutePath()
           
 int getConnectionID()
          unique id of the connection plugin
 PluginOptionPanel getConnectionOptionPanel()
          returns a PluginOptionPanel with specific options for this plugin or null if the plugin does not provide options
 int getDefaultPort()
           
 TPathControlInterface getPathControl()
           
 java.lang.String getProtocolString()
           
 TConnectionData getTConnectionData()
           
 boolean hasConnectionOptions()
          if plugin provides additional options it will return true
 boolean isConnected()
           
 boolean isFile(java.lang.String path)
           
 boolean isLink(java.lang.String path)
           
 boolean isLocalConnection()
           
 TFileData ls()
           
 TFileData ls(java.lang.String path)
           
 void mkdir(java.lang.String dir)
           
 void mkdirs(java.lang.String dir)
           
 void put(java.io.InputStream instream, java.lang.String remoteFileName)
           
 java.lang.String pwd()
           
 void remove(java.lang.String file)
           
 void rename(java.lang.String oldpath, java.lang.String newpath)
           
 boolean requiresPassword()
          returns true whether the user needs to enter a password considering the current plugin settings
 boolean requiresPort()
           
 void rmdir(java.lang.String dir)
           
 void setHidden(java.lang.String path)
           
 void setModificationTime(java.lang.String file, long mtime)
           
 void setPermissions(java.lang.String file, int permissions)
           
 
Methods inherited from interface net.sf.jfilesync.plugins.GeneralPlugin
getDescription, getLicense, getMajorVersion, getMinorVersion, getName, isProvided
 

Method Detail

connect

void connect(TConnectionData connectData)
             throws PluginConnectException
Throws:
PluginConnectException

getTConnectionData

TConnectionData getTConnectionData()

disconnect

void disconnect()

isConnected

boolean isConnected()

isLocalConnection

boolean isLocalConnection()

getPathControl

TPathControlInterface getPathControl()

ls

TFileData ls()
             throws java.io.IOException
Throws:
java.io.IOException

ls

TFileData ls(java.lang.String path)
             throws java.io.IOException
Throws:
java.io.IOException

chdir

void chdir(java.lang.String path)
           throws java.io.IOException
Throws:
java.io.IOException

getAbsolutePath

java.lang.String getAbsolutePath()

exists

boolean exists(java.lang.String path)

put

void put(java.io.InputStream instream,
         java.lang.String remoteFileName)
         throws java.io.IOException
Throws:
java.io.IOException

get

void get(java.lang.String remoteFileName,
         java.io.OutputStream outstream)
         throws java.io.IOException
Throws:
java.io.IOException

mkdir

void mkdir(java.lang.String dir)
           throws java.io.IOException
Throws:
java.io.IOException

mkdirs

void mkdirs(java.lang.String dir)
            throws java.io.IOException
Throws:
java.io.IOException

pwd

java.lang.String pwd()

remove

void remove(java.lang.String file)
            throws java.io.IOException
Throws:
java.io.IOException

rmdir

void rmdir(java.lang.String dir)
           throws java.io.IOException
Throws:
java.io.IOException

abort

void abort()
           throws java.io.IOException
Throws:
java.io.IOException

rename

void rename(java.lang.String oldpath,
            java.lang.String newpath)
            throws java.io.IOException
Throws:
java.io.IOException

setModificationTime

void setModificationTime(java.lang.String file,
                         long mtime)
                         throws java.io.IOException
Throws:
java.io.IOException

setPermissions

void setPermissions(java.lang.String file,
                    int permissions)
                    throws java.io.IOException
Throws:
java.io.IOException

isLink

boolean isLink(java.lang.String path)
               throws java.io.IOException
Throws:
java.io.IOException

isFile

boolean isFile(java.lang.String path)
               throws java.io.IOException
Throws:
java.io.IOException

getConnectionID

int getConnectionID()
unique id of the connection plugin


hasConnectionOptions

boolean hasConnectionOptions()
if plugin provides additional options it will return true


getConnectionOptionPanel

PluginOptionPanel getConnectionOptionPanel()
returns a PluginOptionPanel with specific options for this plugin or null if the plugin does not provide options


requiresPassword

boolean requiresPassword()
returns true whether the user needs to enter a password considering the current plugin settings


getProtocolString

java.lang.String getProtocolString()

requiresPort

boolean requiresPort()

getDefaultPort

int getDefaultPort()

setHidden

void setHidden(java.lang.String path)
               throws java.io.IOException
Throws:
java.io.IOException