com.lf.vfslib.s3

Class S3FileProvider

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.s3.S3FileProvider

All Implemented Interfaces:

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

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

A provider to access the files hosted by Amazon® S3.

This class coordinates the whole Amazon® S3 functionality used by VFS2.

Since:

1.6

Version:

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

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
S3FileProvider() Constructor method (do not use).
S3FileProvider(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 Amazon® file system.
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.

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

S3FileProvider

public S3FileProvider()
               throws java.lang.InstantiationException

Constructor method (do not use).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

S3FileProvider

public S3FileProvider(VFSLib vfslib)

Constructor method.

Parameters:

vfslib - The parental object

Throws:

java.lang.NullPointerException - If parameters are null

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

Since:

1.6

Method Detail

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 Amazon® 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