com.lf.vfslib.s3

Class S3FileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

com.lf.vfslib.s3.S3FileSystemConfigBuilder

public class S3FileSystemConfigBuilder
extends org.apache.commons.vfs2.FileSystemConfigBuilder

The config builder for the various Amazon® S3 configuration options.

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
static java.lang.String	ACCESS_KEY_ID Variable name.
static java.lang.String	BUCKET_NAME Variable name.
static java.lang.String	DISPLAY_NAME Variable name.
static java.lang.String	SECRET_KEY Variable name.
protected static S3FileSystemConfigBuilder	sharedInstance Shared DbxFileSystemConfigBuilder instance.
protected VFSLib	vfsLib The parental object.

Constructor Summary

Constructors

Constructor and Description
S3FileSystemConfigBuilder() Constructor method.
S3FileSystemConfigBuilder(VFSLib vfslib) Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options) Getter for Amazon® S3 access key ID.
java.lang.String	getAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options) Getter for Amazon® S3 account display name.
java.lang.String	getBucketName(org.apache.commons.vfs2.FileSystemOptions options) Getter for the name of the Amazon® S3 bucket.
protected java.lang.Class<? extends org.apache.commons.vfs2.FileSystem>	getConfigClass() Provides the file system class to be configured by this builder.
java.lang.String	getSecretKey(org.apache.commons.vfs2.FileSystemOptions options) Getter for Amazon® S3 secret key.
static S3FileSystemConfigBuilder	getSharedInstance() Provides the shared instance of the factory implementation.
void	setAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options, java.lang.String token) Setter for Amazon® S3 access key ID.
void	setAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options, java.lang.String name) Setter for Amazon® S3 account display name.
void	setBucketName(org.apache.commons.vfs2.FileSystemOptions options, java.lang.String name) Setter for the name of the Amazon® S3 bucket.
void	setSecretKey(org.apache.commons.vfs2.FileSystemOptions options, java.lang.String token) Setter for Amazon® S3 secret key.

Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder

getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setRootURI

Methods inherited from class java.lang.Object

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

Field Detail

sharedInstance

protected static S3FileSystemConfigBuilder sharedInstance

Shared DbxFileSystemConfigBuilder instance.

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

Variable name.

ACCESS_KEY_ID

public static final java.lang.String ACCESS_KEY_ID

Variable name.

SECRET_KEY

public static final java.lang.String SECRET_KEY

Variable name.

BUCKET_NAME

public static final java.lang.String BUCKET_NAME

Variable name.

vfsLib

protected VFSLib vfsLib

The parental object.

Constructor Detail

S3FileSystemConfigBuilder

public S3FileSystemConfigBuilder()

Constructor method.

Uses the shared instance of the VFSLib class and its resource bundle.

Since:

1.6

S3FileSystemConfigBuilder

public S3FileSystemConfigBuilder(VFSLib vfslib)

Constructor method.

Parameters:

vfslib - The parental object, shared instance if null

Since:

1.6

Method Detail

getSharedInstance

public static S3FileSystemConfigBuilder getSharedInstance()

Provides the shared instance of the factory implementation.

Returns:

Shared instance

Since:

1.6

getConfigClass

protected java.lang.Class<? extends org.apache.commons.vfs2.FileSystem> getConfigClass()

Provides the file system class to be configured by this builder.

Specified by:

getConfigClass in class org.apache.commons.vfs2.FileSystemConfigBuilder

Returns:

File system class

Since:

1.6

setAccountDisplayName

public void setAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options,
                         java.lang.String name)

Setter for Amazon® S3 account display name.

Parameters:

options - The options

name - The display name

Since:

1.6

getAccountDisplayName

public java.lang.String getAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options)

Getter for Amazon® S3 account display name.

Parameters:

options - The options

Returns:

The display name, may be null

Since:

1.6

setAccessKeyID

public void setAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options,
                  java.lang.String token)

Setter for Amazon® S3 access key ID.

Parameters:

options - The options

token - The access key ID

Since:

1.6

getAccessKeyID

public java.lang.String getAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options)

Getter for Amazon® S3 access key ID.

Parameters:

options - The options

Returns:

The access key ID, may be null

Since:

1.6

setSecretKey

public void setSecretKey(org.apache.commons.vfs2.FileSystemOptions options,
                java.lang.String token)

Setter for Amazon® S3 secret key.

Parameters:

options - The options

token - The secret key

Since:

1.6

getSecretKey

public java.lang.String getSecretKey(org.apache.commons.vfs2.FileSystemOptions options)

Getter for Amazon® S3 secret key.

Parameters:

options - The options

Returns:

The secret key, may be null

Since:

1.6

setBucketName

public void setBucketName(org.apache.commons.vfs2.FileSystemOptions options,
                 java.lang.String name)

Setter for the name of the Amazon® S3 bucket.

Parameters:

options - The options

name - The display name

Since:

1.6

getBucketName

public java.lang.String getBucketName(org.apache.commons.vfs2.FileSystemOptions options)

Getter for the name of the Amazon® S3 bucket.

Parameters:

options - The options

Returns:

The display name, may be null

Since:

1.6