com.lf.vfslib.s3

Class S3ClientWrapper

java.lang.Object

com.lf.vfslib.s3.S3ClientWrapper

All Implemented Interfaces:

ClientWrapper

public class S3ClientWrapper
extends Object
implements ClientWrapper

Wraps a Amazon S3 client.

Since:

1.6

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
S3ClientWrapper() Constructor method (do not use).

Method Summary

Modifier and Type	Method and Description
boolean	disconnectClient() Let's the underlying client disconnect from the server.
software.amazon.awssdk.services.s3.S3Client	getClient() Provides access to the internal Amazon S3 client.
static String	getClientURLID(org.apache.commons.vfs2.provider.GenericFileName root, org.apache.commons.vfs2.FileSystemOptions options, VFSLib vfslib) Provides a textual representation for this connection.
static S3ClientWrapper	getS3ClientWrapper(org.apache.commons.vfs2.provider.GenericFileName root, org.apache.commons.vfs2.FileSystemOptions options, VFSLib vfslib, S3FileProvider provider) Gets an idle client from the pool or creates a fresh new instance.
String	getURLID() Provides the unique URL identifier used to manage this client instance.
String	toString() Provides a textual representation.
static void	unlockS3ClientWrapper(S3ClientWrapper wrapper) Releases the given client from the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ClientWrapper

public S3ClientWrapper()
                throws InstantiationException

Constructor method (do not use).

Throws:

InstantiationException - Error indication

Method Detail

getClient

public software.amazon.awssdk.services.s3.S3Client getClient()

Provides access to the internal Amazon S3 client.

Returns:

The client reference

disconnectClient

public boolean disconnectClient()

Let's the underlying client disconnect from the server.

Specified by:

disconnectClient in interface ClientWrapper

Returns:

Successful?

getURLID

public String getURLID()

Provides the unique URL identifier used to manage this client instance.

Something like "s3://user@aws.amazon.com".

Specified by:

getURLID in interface ClientWrapper

Returns:

The URL

getS3ClientWrapper

public static S3ClientWrapper getS3ClientWrapper(org.apache.commons.vfs2.provider.GenericFileName root,
                                                 org.apache.commons.vfs2.FileSystemOptions options,
                                                 VFSLib vfslib,
                                                 S3FileProvider provider)
                                          throws org.apache.commons.vfs2.FileSystemException

Gets an idle client from the pool or creates a fresh new instance.

Parameters:

root - The root path

options - The file system options

vfslib - The parental object, shared instance if null

provider - The file provider

Returns:

Wrapper instance

Throws:

org.apache.commons.vfs2.FileSystemException - If an I/O error occurs

unlockS3ClientWrapper

public static void unlockS3ClientWrapper(S3ClientWrapper wrapper)

Releases the given client from the pool.

Parameters:

wrapper - The wrapper

toString

public String toString()

Provides a textual representation.

Overrides:

toString in class Object

Returns:

The text

getClientURLID

public static String getClientURLID(org.apache.commons.vfs2.provider.GenericFileName root,
                                    org.apache.commons.vfs2.FileSystemOptions options,
                                    VFSLib vfslib)

Provides a textual representation for this connection.

Parameters:

root - The root path

options - The file system options

vfslib - The parental object, shared instance if null

Returns:

The text