com.lf.vfslib.gdrive

Class GDriveFileProvider

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.gdrive.GDriveFileProvider

All Implemented Interfaces:

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

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

A provider to access the files hosted by Google® Drive.

This class coordinates the whole Google® Drive functionality used by VFS2.

Since:

1.6

Version:

$Revision: 1.3 $, $Date: 2013/10/11 17:49:15 $

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
GDriveFileProvider() Constructor method (do not use).
GDriveFileProvider(java.lang.Object authflow, java.lang.String appname, java.lang.String redirecturi, 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 Google® Drive file system.
java.lang.String	getApplicationName() Return the name of the application.
com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow	getAuthFlow() Provides the provider's Google® Drive authorization flow.
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.
java.lang.String	getRedirectURI() Provides the provider's Google® Drive redirect URI.

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

GDriveFileProvider

public GDriveFileProvider()
                   throws java.lang.InstantiationException

Constructor method (do not use).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

GDriveFileProvider

public GDriveFileProvider(java.lang.Object authflow,
                  java.lang.String appname,
                  java.lang.String redirecturi,
                  VFSLib vfslib)

Constructor method.

Parameters:

authflow - The Google® authorization flow (required, type is com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow)

appname - The application name (required)

redirecturi - The Google® redirect URI (required)

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

getAuthFlow

public com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow getAuthFlow()

Provides the provider's Google® Drive authorization flow.

Returns:

The auth flow

Since:

1.6

getApplicationName

public java.lang.String getApplicationName()

Return the name of the application.

Returns:

The name

Since:

1.6

getRedirectURI

public java.lang.String getRedirectURI()

Provides the provider's Google® Drive redirect URI.

Returns:

The redirect URI

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 Google® Drive 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