net.sf.jfilesync.plugins.net.items
Class AbstractLocalPlugin

java.lang.Object
  extended by net.sf.jfilesync.plugins.net.items.AbstractLocalPlugin
All Implemented Interfaces:
GeneralPlugin, ConnectionPlugin
Direct Known Subclasses:
GnuPlugin, TLocal_plugin

public abstract class AbstractLocalPlugin
extends java.lang.Object
implements ConnectionPlugin


Field Summary
private  boolean aborted
           
(package private) static byte[] buf
           
(package private) static int bufsize
           
(package private) static java.util.logging.Logger log
           
 
Fields inherited from interface net.sf.jfilesync.plugins.GeneralPlugin
PROVIDES_FILETRANSFER, PROVIDES_PERMISSION_HANDLING, PROVIDES_RSYNC, PROVIDES_SHELL, PROVIDES_SYMLINK_HANDLING
 
Constructor Summary
AbstractLocalPlugin()
           
 
Method Summary
 void abort()
           
abstract  void chdir(java.lang.String path)
           
abstract  void connect(TConnectionData connectData)
           
protected  void copyStream(java.io.InputStream instream, java.io.OutputStream outstream)
           
protected  void deleteFile(java.lang.String path)
           
abstract  void disconnect()
           
abstract  boolean exists(java.lang.String path)
           
 void get(java.lang.String remoteFileName, java.io.OutputStream outstream)
           
 void get(java.lang.String remoteFileName, java.lang.String localFileName)
           
abstract  java.lang.String getAbsolutePath()
           
abstract  int getConnectionID()
          unique id of the connection plugin
abstract  PluginOptionPanel getConnectionOptionPanel()
          returns a PluginOptionPanel with specific options for this plugin or null if the plugin does not provide options
abstract  java.lang.String getDescription()
           
abstract  java.lang.String getLicense()
           
abstract  int getMajorVersion()
           
abstract  int getMinorVersion()
           
abstract  java.lang.String getName()
           
abstract  TPathControlInterface getPathControl()
           
abstract  java.lang.String getProtocolString()
           
 java.lang.String getVersionString()
           
abstract  boolean hasConnectionOptions()
          if plugin provides additional options it will return true
abstract  boolean isConnected()
           
 boolean isFile(java.lang.String path)
           
abstract  boolean isLink(java.lang.String path)
           
 boolean isLocalConnection()
           
abstract  boolean isProvided(int feature)
          plug-in must provide information if a feature is provided or not
abstract  TFileData ls()
           
abstract  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)
           
 void put(java.lang.String localFileName, java.lang.String remoteFileName)
           
abstract  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
 void rmdir(java.lang.String dirName)
           
 void setModificationTime(java.lang.String fileName, long mtime)
           
abstract  void setPermissions(java.lang.String file, int permissions)
           
abstract  void shellRequest(TTerminal shellArea)
           
abstract  void symlink(java.lang.String dir, java.lang.String link)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.jfilesync.plugins.net.ConnectionPlugin
getDefaultPort, getTConnectionData, requiresPort, setHidden
 

Field Detail

aborted

private boolean aborted

log

static java.util.logging.Logger log

bufsize

static final int bufsize
See Also:
Constant Field Values

buf

static byte[] buf
Constructor Detail

AbstractLocalPlugin

public AbstractLocalPlugin()
Method Detail

isLocalConnection

public boolean isLocalConnection()
Specified by:
isLocalConnection in interface ConnectionPlugin

put

public void put(java.io.InputStream instream,
                java.lang.String remoteFileName)
         throws java.io.IOException
Specified by:
put in interface ConnectionPlugin
Throws:
java.io.IOException

put

public void put(java.lang.String localFileName,
                java.lang.String remoteFileName)
         throws java.io.IOException
Throws:
java.io.IOException

get

public void get(java.lang.String remoteFileName,
                java.lang.String localFileName)
         throws java.io.IOException
Throws:
java.io.IOException

get

public void get(java.lang.String remoteFileName,
                java.io.OutputStream outstream)
         throws java.io.IOException
Specified by:
get in interface ConnectionPlugin
Throws:
java.io.IOException

copyStream

protected void copyStream(java.io.InputStream instream,
                          java.io.OutputStream outstream)
                   throws java.io.IOException
Throws:
java.io.IOException

mkdir

public void mkdir(java.lang.String dir)
           throws java.io.IOException
Specified by:
mkdir in interface ConnectionPlugin
Throws:
java.io.IOException

mkdirs

public void mkdirs(java.lang.String dir)
            throws java.io.IOException
Specified by:
mkdirs in interface ConnectionPlugin
Throws:
java.io.IOException

remove

public void remove(java.lang.String file)
            throws java.io.IOException
Specified by:
remove in interface ConnectionPlugin
Throws:
java.io.IOException

rmdir

public void rmdir(java.lang.String dirName)
           throws java.io.IOException
Specified by:
rmdir in interface ConnectionPlugin
Throws:
java.io.IOException

deleteFile

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

abort

public void abort()
           throws java.io.IOException
Specified by:
abort in interface ConnectionPlugin
Throws:
java.io.IOException

rename

public void rename(java.lang.String oldpath,
                   java.lang.String newpath)
            throws java.io.IOException
Specified by:
rename in interface ConnectionPlugin
Throws:
java.io.IOException

setModificationTime

public void setModificationTime(java.lang.String fileName,
                                long mtime)
                         throws java.io.IOException
Specified by:
setModificationTime in interface ConnectionPlugin
Throws:
java.io.IOException

isFile

public boolean isFile(java.lang.String path)
               throws java.io.IOException
Specified by:
isFile in interface ConnectionPlugin
Throws:
java.io.IOException

requiresPassword

public boolean requiresPassword()
Description copied from interface: ConnectionPlugin
returns true whether the user needs to enter a password considering the current plugin settings

Specified by:
requiresPassword in interface ConnectionPlugin

getVersionString

public java.lang.String getVersionString()

connect

public abstract void connect(TConnectionData connectData)
                      throws PluginConnectException
Specified by:
connect in interface ConnectionPlugin
Throws:
PluginConnectException

disconnect

public abstract void disconnect()
Specified by:
disconnect in interface ConnectionPlugin

isConnected

public abstract boolean isConnected()
Specified by:
isConnected in interface ConnectionPlugin

getPathControl

public abstract TPathControlInterface getPathControl()
Specified by:
getPathControl in interface ConnectionPlugin

ls

public abstract TFileData ls()
                      throws java.io.IOException
Specified by:
ls in interface ConnectionPlugin
Throws:
java.io.IOException

ls

public abstract TFileData ls(java.lang.String path)
                      throws java.io.IOException
Specified by:
ls in interface ConnectionPlugin
Throws:
java.io.IOException

chdir

public abstract void chdir(java.lang.String path)
                    throws java.io.IOException
Specified by:
chdir in interface ConnectionPlugin
Throws:
java.io.IOException

getAbsolutePath

public abstract java.lang.String getAbsolutePath()
Specified by:
getAbsolutePath in interface ConnectionPlugin

exists

public abstract boolean exists(java.lang.String path)
Specified by:
exists in interface ConnectionPlugin

pwd

public abstract java.lang.String pwd()
Specified by:
pwd in interface ConnectionPlugin

setPermissions

public abstract void setPermissions(java.lang.String file,
                                    int permissions)
                             throws java.io.IOException
Specified by:
setPermissions in interface ConnectionPlugin
Throws:
java.io.IOException

symlink

public abstract void symlink(java.lang.String dir,
                             java.lang.String link)
                      throws java.io.IOException
Throws:
java.io.IOException

isLink

public abstract boolean isLink(java.lang.String path)
                        throws java.io.IOException
Specified by:
isLink in interface ConnectionPlugin
Throws:
java.io.IOException

shellRequest

public abstract void shellRequest(TTerminal shellArea)

getConnectionID

public abstract int getConnectionID()
Description copied from interface: ConnectionPlugin
unique id of the connection plugin

Specified by:
getConnectionID in interface ConnectionPlugin

hasConnectionOptions

public abstract boolean hasConnectionOptions()
Description copied from interface: ConnectionPlugin
if plugin provides additional options it will return true

Specified by:
hasConnectionOptions in interface ConnectionPlugin

getConnectionOptionPanel

public abstract PluginOptionPanel getConnectionOptionPanel()
Description copied from interface: ConnectionPlugin
returns a PluginOptionPanel with specific options for this plugin or null if the plugin does not provide options

Specified by:
getConnectionOptionPanel in interface ConnectionPlugin

getProtocolString

public abstract java.lang.String getProtocolString()
Specified by:
getProtocolString in interface ConnectionPlugin

isProvided

public abstract boolean isProvided(int feature)
Description copied from interface: GeneralPlugin
plug-in must provide information if a feature is provided or not

Specified by:
isProvided in interface GeneralPlugin

getName

public abstract java.lang.String getName()
Specified by:
getName in interface GeneralPlugin
Returns:
returns name of plug-in

getDescription

public abstract java.lang.String getDescription()
Specified by:
getDescription in interface GeneralPlugin
Returns:
returns a more detailed description of the plug-in

getMajorVersion

public abstract int getMajorVersion()
Specified by:
getMajorVersion in interface GeneralPlugin

getMinorVersion

public abstract int getMinorVersion()
Specified by:
getMinorVersion in interface GeneralPlugin

getLicense

public abstract java.lang.String getLicense()
Specified by:
getLicense in interface GeneralPlugin