Package 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 Description boolean
bucketExists(java.lang.String bucket)
Check whether a bucket existsjava.io.InputStream
getObject(java.lang.String bucket, java.lang.String object, long offset)
Read an objectvoid
getObject(java.lang.String bucket, java.lang.String object, java.lang.String filename)
Download an objectvoid
initialize(java.lang.String server, int port, java.lang.String accessKey, java.lang.String secretKey, java.lang.String appName, java.lang.String appVersion)
Initialise the S3 clientS3ClientStat
statObject(java.lang.String bucket, java.lang.String object)
Stat the object
-
Method Details
-
initialize
void initialize(java.lang.String server, int port, java.lang.String accessKey, java.lang.String secretKey, java.lang.String appName, java.lang.String appVersion) throws S3ClientServiceExceptionInitialise the S3 client- Parameters:
server
- servernameport
- portaccessKey
- access keysecretKey
- secret keyappName
- user agent application nameappVersion
- user agent application version- Throws:
S3ClientServiceException
- if an S3 error occurred
-
bucketExists
Check whether a bucket exists- Parameters:
bucket
- Bucket name- Returns:
- true if bucket exists
- Throws:
S3ClientServiceException
- if an S3 error occurredjava.io.IOException
- if an S3 error occurred
-
statObject
S3ClientStat statObject(java.lang.String bucket, java.lang.String object) throws S3ClientServiceException, java.io.IOExceptionStat the object- Parameters:
bucket
- Bucket nameobject
- Object path- Returns:
- S3ClientStat object
- Throws:
S3ClientServiceException
- if an S3 error occurredjava.io.IOException
- if an S3 error occurred
-
getObject
java.io.InputStream getObject(java.lang.String bucket, java.lang.String object, long offset) throws S3ClientServiceException, java.io.IOExceptionRead an object- Parameters:
bucket
- Bucket nameobject
- Object pathoffset
- Start reading at this offset- Returns:
- InputStream to the object
- Throws:
S3ClientServiceException
- if an S3 error occurredjava.io.IOException
- if an S3 error occurred
-
getObject
void getObject(java.lang.String bucket, java.lang.String object, java.lang.String filename) throws S3ClientServiceException, java.io.IOExceptionDownload an object- Parameters:
bucket
- Bucket nameobject
- Object pathfilename
- Destination file- Throws:
S3ClientServiceException
- if an S3 error occurredjava.io.IOException
- if an S3 error occurred
-