loci.common.services

Interface S3ClientService

All Superinterfaces:

Service

All Known Implementing Classes:

S3ClientServiceImpl

public interface S3ClientService
extends Service

An S3 client

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

Method Detail

initialize

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

Initialise the S3 client

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

boolean bucketExists(String bucket)
              throws S3ClientServiceException,
                     IOException

Check whether a bucket exists

Parameters:

bucket - Bucket name

Returns:

true if bucket exists

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred

statObject

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

Stat the object

Parameters:

bucket - Bucket name

object - Object path

Returns:

S3ClientStat object

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred

getObject

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

Read an object

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

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

Download an object

Parameters:

bucket - Bucket name

object - Object path

filename - Destination file

Throws:

S3ClientServiceException - if an S3 error occurred

IOException - if an S3 error occurred