loci.common.services

Class S3ClientServiceImpl

java.lang.Object

loci.common.services.AbstractService

loci.common.services.S3ClientServiceImpl

All Implemented Interfaces:

S3ClientService, Service

public class S3ClientServiceImpl
extends AbstractService
implements S3ClientService

An S3 client

Constructor Summary

Constructors

Constructor and Description
S3ClientServiceImpl() Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	bucketExists(String bucket) Check whether a bucket exists
InputStream	getObject(String bucket, String object, long offset) Read an object
void	getObject(String bucket, String object, String filename) Download an object
void	initialize(String server, int port, String accessKey, String secretKey, String appName, String appVersion) Initialise the S3 client
S3ClientStat	statObject(String bucket, String object) Stat the object

Methods inherited from class loci.common.services.AbstractService

checkClassDependency

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ClientServiceImpl

public S3ClientServiceImpl()

Default constructor.

Method Detail

initialize

public void initialize(String server,
                       int port,
                       String accessKey,
                       String secretKey,
                       String appName,
                       String appVersion)
                throws S3ClientServiceException

Description copied from interface: S3ClientService

Initialise the S3 client

Specified by:

initialize in interface S3ClientService

Parameters:

server - servername

port - port

accessKey - access key

secretKey - secret key

appName - user agent application name

appVersion - user agent application version

Throws:

S3ClientServiceException - if an S3 error occurred

bucketExists

public boolean bucketExists(String bucket)
                     throws S3ClientServiceException,
                            IOException

Description copied from interface: S3ClientService

Check whether a bucket exists

Specified by:

bucketExists in interface S3ClientService

Parameters:

bucket - Bucket name

Returns:

true if bucket exists

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred

statObject

public S3ClientStat statObject(String bucket,
                               String object)
                        throws S3ClientServiceException,
                               IOException

Description copied from interface: S3ClientService

Stat the object

Specified by:

statObject in interface S3ClientService

Parameters:

bucket - Bucket name

object - Object path

Returns:

S3ClientStat object

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred

getObject

public InputStream getObject(String bucket,
                             String object,
                             long offset)
                      throws S3ClientServiceException,
                             IOException

Description copied from interface: S3ClientService

Read an object

Specified by:

getObject in interface S3ClientService

Parameters:

bucket - Bucket name

object - Object path

offset - Start reading at this offset

Returns:

InputStream to the object

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred

getObject

public void getObject(String bucket,
                      String object,
                      String filename)
               throws S3ClientServiceException,
                      IOException

Description copied from interface: S3ClientService

Download an object

Specified by:

getObject in interface S3ClientService

Parameters:

bucket - Bucket name

object - Object path

filename - Destination file

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred