Package loci.common.services
Interface S3ClientService
- All Superinterfaces:
Service
- All Known Implementing Classes:
S3ClientServiceImpl
An S3 client
-
Method Summary
Modifier and TypeMethodDescriptionbooleanbucketExists(String bucket) Check whether a bucket existsRead an objectvoidDownload an objectvoidinitialize(String server, int port, String accessKey, String secretKey, String appName, String appVersion) Initialise the S3 clientstatObject(String bucket, String object) Stat the object
-
Method Details
-
initialize
void initialize(String server, int port, String accessKey, String secretKey, String appName, String appVersion) throws S3ClientServiceException Initialise 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 occurredIOException- if an S3 error occurred
-
statObject
Stat the object- Parameters:
bucket- Bucket nameobject- Object path- Returns:
- S3ClientStat object
- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-
getObject
InputStream getObject(String bucket, String object, long offset) throws S3ClientServiceException, IOException Read an object- Parameters:
bucket- Bucket nameobject- Object pathoffset- Start reading at this offset- Returns:
- InputStream to the object
- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-
getObject
void getObject(String bucket, String object, String filename) throws S3ClientServiceException, IOException Download an object- Parameters:
bucket- Bucket nameobject- Object pathfilename- Destination file- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-