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 exists
    java.io.InputStream getObject​(java.lang.String bucket, java.lang.String object, long offset)
    Read an object
    void getObject​(java.lang.String bucket, java.lang.String object, java.lang.String filename)
    Download an object
    void 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 client
    S3ClientStat 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 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​(java.lang.String bucket) throws S3ClientServiceException, java.io.IOException
      Check whether a bucket exists
      Parameters:
      bucket - Bucket name
      Returns:
      true if bucket exists
      Throws:
      S3ClientServiceException - if an S3 error occurred
      java.io.IOException - if an S3 error occurred

    • statObject

      S3ClientStat statObject​(java.lang.String bucket, java.lang.String object) throws S3ClientServiceException, java.io.IOException
      Stat the object
      Parameters:
      bucket - Bucket name
      object - Object path
      Returns:
      S3ClientStat object
      Throws:
      S3ClientServiceException - if an S3 error occurred
      java.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.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
      java.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.IOException
      Download an object
      Parameters:
      bucket - Bucket name
      object - Object path
      filename - Destination file
      Throws:
      S3ClientServiceException - if an S3 error occurred
      java.io.IOException - if an S3 error occurred