Class Plugin

  • Direct Known Subclasses:
    TransferPlugin, WebInterfacePlugin

    public abstract class Plugin
    extends java.lang.Object
    A plugin can be used to store Syncany's repository files on any remote location. Implementations of the Plugin class identify a storage/transfer plugin.

    Using the 'id' attribute, plugins can be loaded by the Plugins class. Once a plugin is loaded, a corresponding TransferSettings object must be created and initialized. From the connection object, a TransferManager can then be used to upload/download files to the repository.

    Per naming convention, plugins must end by the name Plugin and extend this class. Furthermore, all plugin classes must reside in a package org.syncany.plugins.plugin-id, where plugin-id is the identifier specified by getId().

    • Constructor Summary

      Constructors 
      Constructor Description
      Plugin​(java.lang.String pluginId)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDateStr()
      Returns the date the plugin was compiled
      java.lang.String getId()
      Returns a unique plugin identifier.
      java.lang.String getName()
      Returns a short name of the plugin
      java.lang.String getVersion()
      Returns the version of the plugin
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Plugin

        public Plugin​(java.lang.String pluginId)
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns a unique plugin identifier.

        This identifier must correspond to the to the fully qualified package name in which the plugin classes reside. all plugin classes must reside in a package 'org.syncany.connection.plugins.plugin-id'.

      • getName

        public java.lang.String getName()
        Returns a short name of the plugin
      • getVersion

        public java.lang.String getVersion()
        Returns the version of the plugin
      • getDateStr

        public java.lang.String getDateStr()
        Returns the date the plugin was compiled