com.lf.vfslib

Class VFSLib

java.lang.Object

com.lf.vfslib.VFSLib

public final class VFSLib
extends java.lang.Object

Configures and activates the VFSLib providers to access network file systems via Commons VFS.

First of all a valid license key for the VFSLib library has to be set, then an arbitrary file system manager can be configured for the supported providers. Use the shared instance if you have only one single file system manager instance. Create multiple instances with different configurations with the default constructor methods if there are separate file system managers in use.

Since:

1.6

Version:

$Revision: 1.23 $, $Date: 2013/10/19 15:29:46 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
VFSLib() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
S3FileProvider	addProviderAmazonS3(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager) Configures the given file system manager to use the VFSLib provider for Amazon® S3 (convenience method).
DbxFileProvider	addProviderDropbox(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager, java.lang.Object appinfo, java.lang.Object reqconfig) Configures the given file system manager to use the VFSLib provider for Dropbox®.
DbxFileProvider	addProviderDropbox(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager, java.lang.String appkey, java.lang.String appsecret, java.lang.String clientidentifier, java.lang.String language) Configures the given file system manager to use the VFSLib provider for Dropbox® (convenience method).
GDriveFileProvider	addProviderGoogleDrive(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager, java.lang.Object authflow, java.lang.String appname, java.lang.String redirecturi) Configures the given file system manager to use the VFSLib provider for Google® Drive.
GDriveFileProvider	addProviderGoogleDrive(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager, java.lang.String clientid, java.lang.String clientsecret, java.lang.String appname, java.lang.String redirecturi) Configures the given file system manager to use the VFSLib provider for Google® Drive (convenience method).
java.lang.String	getSchemeAmazonS3() Getter method for the VFSLib Amazon® S3 scheme.
java.lang.String	getSchemeDropbox() Getter method for the VFSLib Dropbox® scheme.
java.lang.String	getSchemeGoogleDrive() Getter method for the VFSLib Google® Drive scheme.
static VFSLib	getSharedInstance() Provides the shared instance of the VFSLib.
void	setLicenseFile(java.io.File licensefile) Setter method for the VFSLib license key, imported from a local file here.
void	setLicenseKey(java.lang.String licensekey) Setter method for the VFSLib license key.
void	setLicenseURL(java.net.URL licenseurl) Setter method for the VFSLib license key, imported from URL/classpath here.
void	setSchemeAmazonS3(java.lang.String scheme) Setter method for the VFSLib Amazon® S3 scheme.
void	setSchemeDropbox(java.lang.String scheme) Setter method for the VFSLib Dropbox® scheme.
void	setSchemeGoogleDrive(java.lang.String scheme) Setter method for the VFSLib Google® Drive scheme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VFSLib

public VFSLib()

Constructor method.

Since:

1.6

Method Detail

getSharedInstance

public static VFSLib getSharedInstance()

Provides the shared instance of the VFSLib.

Returns:

Shared instance

Since:

1.6

setLicenseKey

public void setLicenseKey(java.lang.String licensekey)

Setter method for the VFSLib license key.

Parameters:

licensekey - The VFSLib license key

Throws:

java.lang.IllegalArgumentException - If the license key cannot be used

Since:

1.6

setLicenseFile

public void setLicenseFile(java.io.File licensefile)

Setter method for the VFSLib license key, imported from a local file here.

Parameters:

licensefile - The VFSLib license key file

Throws:

java.lang.IllegalArgumentException - If the file is invalid

Since:

1.6

setLicenseURL

public void setLicenseURL(java.net.URL licenseurl)

Setter method for the VFSLib license key, imported from URL/classpath here.

Parameters:

licenseurl - The VFSLib license key URL

Throws:

java.lang.IllegalArgumentException - If the file is invalid

Since:

1.6

setSchemeDropbox

public void setSchemeDropbox(java.lang.String scheme)

Setter method for the VFSLib Dropbox® scheme.

The default scheme name for Dropbox® is "dropbox", override with "dbx" or whatever. This method must be called before the providers are being installed.

Parameters:

scheme - The scheme

Throws:

java.lang.NullPointerException - If the scheme is null or empty

java.lang.IllegalArgumentException - If the license key cannot be used

Since:

1.6

getSchemeDropbox

public java.lang.String getSchemeDropbox()

Getter method for the VFSLib Dropbox® scheme.

Returns:

The scheme

Since:

1.6

addProviderDropbox

public DbxFileProvider addProviderDropbox(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager,
                                 java.lang.String appkey,
                                 java.lang.String appsecret,
                                 java.lang.String clientidentifier,
                                 java.lang.String language)

Configures the given file system manager to use the VFSLib provider for Dropbox® (convenience method).

The required libraries must be in the classpath and a valid license must have been registered. Please setup the application info and request configuration for Dropbox® first. You may use a different scheme/protocol name by calling setSchemeDropbox() (default is "dropbox").

Parameters:

manager - The VFSLib license key (required)

appkey - The Dropbox® application info (required for DbxAppInfo)

appsecret - The Dropbox® request configuration (required for DbxAppInfo)

clientidentifier - The Dropbox® client identifier (required for DbxRequestConfig)

language - The Dropbox® language (required for DbxRequestConfig)

Returns:

The installed provider, null if an error occurred

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalStateException - If the license key has not been set properly

Since:

1.6

addProviderDropbox

public DbxFileProvider addProviderDropbox(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager,
                                 java.lang.Object appinfo,
                                 java.lang.Object reqconfig)

Configures the given file system manager to use the VFSLib provider for Dropbox®.

The required libraries must be in the classpath and a valid license must have been registered. Please setup the application info and request configuration for Dropbox® first. You may use a different scheme/protocol name by calling setSchemeDropbox() (default is "dropbox").

Parameters:

manager - The VFSLib license key (required)

appinfo - The Dropbox® application info (required, type is com.dropbox.core.DbxAppInfo)

reqconfig - The Dropbox® request configuration (required, type is com.dropbox.core.DbxRequestConfig)

Returns:

The installed provider, null if an error occurred

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalStateException - If the license key has not been set properly

java.lang.IllegalArgumentException - If a parameter is not of the expected type

Since:

1.6

setSchemeGoogleDrive

public void setSchemeGoogleDrive(java.lang.String scheme)

Setter method for the VFSLib Google® Drive scheme.

The default scheme name for Google® Drive is "gdrive", override with "google" or whatever. This method must be called before the providers are being installed.

Parameters:

scheme - The scheme

Throws:

java.lang.NullPointerException - If the scheme is null or empty

java.lang.IllegalArgumentException - If the license key cannot be used

Since:

1.6

getSchemeGoogleDrive

public java.lang.String getSchemeGoogleDrive()

Getter method for the VFSLib Google® Drive scheme.

Returns:

The scheme

Since:

1.6

addProviderGoogleDrive

public GDriveFileProvider addProviderGoogleDrive(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager,
                                        java.lang.String clientid,
                                        java.lang.String clientsecret,
                                        java.lang.String appname,
                                        java.lang.String redirecturi)

Configures the given file system manager to use the VFSLib provider for Google® Drive (convenience method).

The required libraries must be in the classpath and a valid license must have been registered. Please setup a project and application in the Google® Cloud Console first. Don't forget to have the Drive API enabled for your project registered from within the Cloud Console.

You may use a different scheme/protocol name by calling getSchemeGoogleDrive() (default is "gdrive").

Parameters:

manager - The VFSLib license key (required)

clientid - The Google® Drive client ID (required)

clientsecret - The Google® Drive client secret (required)

appname - The application name (required)

redirecturi - The Google® Drive redirect URI (required)

Returns:

The installed provider, null if an error occurred

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalStateException - If the license key has not been set properly

Since:

1.6

addProviderGoogleDrive

public GDriveFileProvider addProviderGoogleDrive(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager,
                                        java.lang.Object authflow,
                                        java.lang.String appname,
                                        java.lang.String redirecturi)

Configures the given file system manager to use the VFSLib provider for Google® Drive.

The required libraries must be in the classpath and a valid license must have been registered. Please setup a project and application in the Google® Cloud Console first. Don't forget to have the Drive API enabled for your project registered from within the Cloud Console.

You may use a different scheme/protocol name by calling getSchemeGoogleDrive() (default is "gdrive").

Parameters:

manager - The VFSLib license key (required)

authflow - The Google® authorization flow (required)

appname - The application name (required)

redirecturi - The Google® Drive redirect URI (required)

Returns:

The installed provider, null if an error occurred

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalStateException - If the license key has not been set properly

Since:

1.6

setSchemeAmazonS3

public void setSchemeAmazonS3(java.lang.String scheme)

Setter method for the VFSLib Amazon® S3 scheme.

The default scheme name for Amazon® S3 is "s3", override with "amazon" or whatever. This method must be called before the providers are being installed.

Parameters:

scheme - The scheme

Throws:

java.lang.NullPointerException - If the scheme is null or empty

java.lang.IllegalArgumentException - If the license key cannot be used

Since:

1.6

getSchemeAmazonS3

public java.lang.String getSchemeAmazonS3()

Getter method for the VFSLib Amazon® S3 scheme.

Returns:

The scheme

Since:

1.6

addProviderAmazonS3

public S3FileProvider addProviderAmazonS3(org.apache.commons.vfs2.impl.DefaultFileSystemManager manager)

Configures the given file system manager to use the VFSLib provider for Amazon® S3 (convenience method).

The required libraries must be in the classpath and a valid license must have been registered. Please setup a valid Amazon® Web Services (AWS) account first. You may use a different scheme/protocol name by calling setSchemeAmazonS3() (default is "s3").

Parameters:

manager - The VFSLib license key (required)

Returns:

The installed provider, null if an error occurred

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalStateException - If the license key has not been set properly

Since:

1.6