Package loci.common.services
Class S3ClientServiceImpl
java.lang.Object
loci.common.services.AbstractService
loci.common.services.S3ClientServiceImpl
- All Implemented Interfaces:
S3ClientService,Service
An S3 client
-
Constructor Summary
Constructors -
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 objectMethods inherited from class loci.common.services.AbstractService
checkClassDependency
-
Constructor Details
-
S3ClientServiceImpl
public S3ClientServiceImpl()Default constructor.
-
-
Method Details
-
initialize
public void initialize(String server, int port, String accessKey, String secretKey, String appName, String appVersion) throws S3ClientServiceException Description copied from interface:S3ClientServiceInitialise the S3 client- Specified by:
initializein interfaceS3ClientService- Parameters:
server- servernameport- portaccessKey- access keysecretKey- secret keyappName- user agent application nameappVersion- user agent application version- Throws:
S3ClientServiceException- if an S3 error occurred
-
bucketExists
Description copied from interface:S3ClientServiceCheck whether a bucket exists- Specified by:
bucketExistsin interfaceS3ClientService- Parameters:
bucket- Bucket name- Returns:
- true if bucket exists
- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-
statObject
public S3ClientStat statObject(String bucket, String object) throws S3ClientServiceException, IOException Description copied from interface:S3ClientServiceStat the object- Specified by:
statObjectin interfaceS3ClientService- Parameters:
bucket- Bucket nameobject- Object path- Returns:
- S3ClientStat object
- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-
getObject
public InputStream getObject(String bucket, String object, long offset) throws S3ClientServiceException, IOException Description copied from interface:S3ClientServiceRead an object- Specified by:
getObjectin interfaceS3ClientService- 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
public void getObject(String bucket, String object, String filename) throws S3ClientServiceException, IOException Description copied from interface:S3ClientServiceDownload an object- Specified by:
getObjectin interfaceS3ClientService- Parameters:
bucket- Bucket nameobject- Object pathfilename- Destination file- Throws:
S3ClientServiceException- if an S3 error occurredIOException- if an S3 error occurred
-