com.lf.vfslib.dropbox

Class DbxFileProvider

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractVfsContainer

org.apache.commons.vfs2.provider.AbstractFileProvider

org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

com.lf.vfslib.dropbox.DbxFileProvider

All Implemented Interfaces:

org.apache.commons.vfs2.provider.FileProvider, org.apache.commons.vfs2.provider.VfsComponent

public final class DbxFileProvider
extends org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

A provider to access the files hosted by Dropbox®.

This class coordinates the whole Dropbox® functionality used by VFS2.

Since:

1.6

Version:

$Revision: 1.10 $, $Date: 2013/09/27 08:38:28 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Collection<org.apache.commons.vfs2.Capability>	capabilities The provider's capabilities.

Constructor Summary

Constructors

Constructor and Description
DbxFileProvider() Constructor method (do not use).
DbxFileProvider(java.lang.Object appinfo, java.lang.Object reqconfig, VFSLib vfslib) Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.commons.vfs2.FileSystem	doCreateFileSystem(org.apache.commons.vfs2.FileName name, org.apache.commons.vfs2.FileSystemOptions options) Creates a Dropbox® file system.
com.dropbox.core.DbxAppInfo	getAppInfo() Provides the provider's Dropbox® application info.
java.util.Collection<org.apache.commons.vfs2.Capability>	getCapabilities() Provides the provider's capabilities.
org.apache.commons.vfs2.FileSystemConfigBuilder	getConfigBuilder() Provides the builder instance responsible for proper file system options.
com.dropbox.core.DbxRequestConfig	getRequestConfig() Provides the provider's Dropbox® request configuration.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

findFile, findFile, getFileSystem

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider

addFileSystem, close, closeFileSystem, createFileSystem, findFileSystem, freeUnusedResources, getFileNameParser, parseUri, setFileNameParser

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

capabilities

protected static final java.util.Collection<org.apache.commons.vfs2.Capability> capabilities

The provider's capabilities.

Constructor Detail

DbxFileProvider

public DbxFileProvider()
                throws java.lang.InstantiationException

Constructor method (do not use).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

DbxFileProvider

public DbxFileProvider(java.lang.Object appinfo,
               java.lang.Object reqconfig,
               VFSLib vfslib)

Constructor method.

Parameters:

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

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

vfslib - The parental object

Throws:

java.lang.NullPointerException - If parameters are 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

Method Detail

getAppInfo

public com.dropbox.core.DbxAppInfo getAppInfo()

Provides the provider's Dropbox® application info.

Returns:

The app info

Since:

1.6

getRequestConfig

public com.dropbox.core.DbxRequestConfig getRequestConfig()

Provides the provider's Dropbox® request configuration.

Returns:

The app info

Since:

1.6

doCreateFileSystem

protected org.apache.commons.vfs2.FileSystem doCreateFileSystem(org.apache.commons.vfs2.FileName name,
                                                    org.apache.commons.vfs2.FileSystemOptions options)
                                                         throws org.apache.commons.vfs2.FileSystemException

Creates a Dropbox® file system.

Specified by:

doCreateFileSystem in class org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider

Parameters:

name - The file name

options - The file system options

Throws:

org.apache.commons.vfs2.FileSystemException - If something goes wrong

Since:

1.6

getConfigBuilder

public org.apache.commons.vfs2.FileSystemConfigBuilder getConfigBuilder()

Provides the builder instance responsible for proper file system options.

Specified by:

getConfigBuilder in interface org.apache.commons.vfs2.provider.FileProvider

Overrides:

getConfigBuilder in class org.apache.commons.vfs2.provider.AbstractFileProvider

Returns:

The builder

Since:

1.6

getCapabilities

public java.util.Collection<org.apache.commons.vfs2.Capability> getCapabilities()

Provides the provider's capabilities.

Returns:

The collection

Since:

1.6