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

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_KEY_ID Access key ID.
static String	AWS_REGION Bucket URI.
static String	BUCKET_NAME Bucket name.
static String	DISPLAY_NAME Display name.
static String	SECRET_KEY Secret key.

Constructor Summary

Constructors

Constructor and Description
S3FileSystemConfigBuilder() Constructor method.

Method Summary

Modifier and Type	Method and Description
String	getAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options) Getter for Amazon S3 access key ID.
String	getAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options) Getter for Amazon S3 account display name.
String	getAWSRegion(org.apache.commons.vfs2.FileSystemOptions options) Getter for the AWS region for the bucket.
String	getBucketName(org.apache.commons.vfs2.FileSystemOptions options) Getter for the name of the Amazon S3 bucket.
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, String keyid) Setter for Amazon S3 access key ID.
void	setAccountDisplayName(org.apache.commons.vfs2.FileSystemOptions options, String name) Setter for Amazon S3 account display name.
void	setAWSRegion(org.apache.commons.vfs2.FileSystemOptions options, String region) Setter for the AWS region for the bucket.
void	setBucketName(org.apache.commons.vfs2.FileSystemOptions options, String name) Setter for the name of the Amazon S3 bucket.
void	setSecretKey(org.apache.commons.vfs2.FileSystemOptions options, String key) Setter for Amazon S3 secret key.

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

getRootURI, setRootURI

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_NAME

public static final String DISPLAY_NAME

Display name.

ACCESS_KEY_ID

public static final String ACCESS_KEY_ID

Access key ID.

SECRET_KEY

public static final String SECRET_KEY

Secret key.

AWS_REGION

public static final String AWS_REGION

Bucket URI.

BUCKET_NAME

public static final String BUCKET_NAME

Bucket name.

Constructor Detail

S3FileSystemConfigBuilder

public S3FileSystemConfigBuilder()

Constructor method.

Method Detail

getSharedInstance

public static S3FileSystemConfigBuilder getSharedInstance()

Provides the shared instance of the factory implementation.

Returns:

Shared instance

setAccountDisplayName

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

Setter for Amazon S3 account display name.

Parameters:

options - The options

name - The display name

getAccountDisplayName

public 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

setAccessKeyID

public void setAccessKeyID(org.apache.commons.vfs2.FileSystemOptions options,
                           String keyid)

Setter for Amazon S3 access key ID.

Parameters:

options - The options

keyid - The access key ID

getAccessKeyID

public 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

setSecretKey

public void setSecretKey(org.apache.commons.vfs2.FileSystemOptions options,
                         String key)

Setter for Amazon S3 secret key.

Parameters:

options - The options

key - The secret key

getSecretKey

public 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

setAWSRegion

public void setAWSRegion(org.apache.commons.vfs2.FileSystemOptions options,
                         String region)

Setter for the AWS region for the bucket.

Parameters:

options - The options

region - The region

Since:

2.8

getAWSRegion

public String getAWSRegion(org.apache.commons.vfs2.FileSystemOptions options)

Getter for the AWS region for the bucket.

Parameters:

options - The options

Returns:

The region. May be null.

Since:

2.8

setBucketName

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

Setter for the name of the Amazon S3 bucket.

Parameters:

options - The options

name - The display name

getBucketName

public 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