Package alluxio.underfs.kodo

Class KodoClient

  • public class KodoClient
extends java.lang.Object
    Client or Kodo under file system.

    • Constructor Summary

      Constructors 
      Constructor Description
      KodoClient​(com.qiniu.util.Auth auth, java.lang.String bucketName, java.lang.String downloadHost, java.lang.String endPoint, com.qiniu.storage.Configuration cfg, okhttp3.OkHttpClient okHttpClient)
      Creates a new instance of KodoClient.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void copyObject​(java.lang.String src, java.lang.String dst)
      Copys object in Qiniu kodo.
      void createEmptyObject​(java.lang.String key)
      Creates empty Object in Qiniu kodo.
      void deleteObject​(java.lang.String key)
      Deletes Object in Qiniu kodo.
      java.lang.String getBucketName()
      Gets bucketname for kodoclient.
      com.qiniu.storage.model.FileInfo getFileInfo​(java.lang.String key)
      Gets file from for Qiniu kodo.
      java.io.InputStream getObject​(java.lang.String key, long startPos, long endPos, long contentLength)
      Gets object from Qiniu kodo.
      com.qiniu.storage.model.FileListing listFiles​(java.lang.String prefix, java.lang.String marker, int limit, java.lang.String delimiter)
      Lists object for Qiniu kodo.
      void uploadFile​(java.lang.String Key, java.io.File File)
      Puts Object to Qiniu kodo.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • KodoClient

        public KodoClient​(com.qiniu.util.Auth auth,
                  java.lang.String bucketName,
                  java.lang.String downloadHost,
                  java.lang.String endPoint,
                  com.qiniu.storage.Configuration cfg,
                  okhttp3.OkHttpClient okHttpClient)
        Creates a new instance of KodoClient.
        Parameters:
        auth - Qiniu authentication
        bucketName - bucketname for kodo
        downloadHost - download host for kodo
        endPoint - endpoint for kodo
        cfg - configuration for Qiniu SDK
        okHttpClient - http client

    • Method Detail

      • getBucketName

        public java.lang.String getBucketName()
        Gets bucketname for kodoclient.
        Returns:
        bucketname

      • getFileInfo

        public com.qiniu.storage.model.FileInfo getFileInfo​(java.lang.String key)
                                             throws com.qiniu.common.QiniuException
        Gets file from for Qiniu kodo.
        Parameters:
        key - Object jey
        Returns:
        Qiniu FileInfo
        Throws:
        com.qiniu.common.QiniuException

      • getObject

        public java.io.InputStream getObject​(java.lang.String key,
                                     long startPos,
                                     long endPos,
                                     long contentLength)
                              throws java.io.IOException
        Gets object from Qiniu kodo. All requests are authenticated by default，default expires 3600s We use okhttp as our HTTP client and support two main parameters in the external adjustment, MAX request and timeout time.
        Parameters:
        key - object key
        startPos - start index for object
        endPos - end index for object
        contentLength - object file size
        Returns:
        inputstream
        Throws:
        java.io.IOException

      • uploadFile

        public void uploadFile​(java.lang.String Key,
                       java.io.File File)
                throws com.qiniu.common.QiniuException
        Puts Object to Qiniu kodo.
        Parameters:
        Key - Object key for kodo
        File - Alluxio File
        Throws:
        com.qiniu.common.QiniuException

      • copyObject

        public void copyObject​(java.lang.String src,
                       java.lang.String dst)
                throws com.qiniu.common.QiniuException
        Copys object in Qiniu kodo.
        Parameters:
        src - source Object key
        dst - destination Object Key
        Throws:
        com.qiniu.common.QiniuException

      • createEmptyObject

        public void createEmptyObject​(java.lang.String key)
                       throws com.qiniu.common.QiniuException
        Creates empty Object in Qiniu kodo.
        Parameters:
        key - empty Object key
        Throws:
        com.qiniu.common.QiniuException

      • deleteObject

        public void deleteObject​(java.lang.String key)
                  throws com.qiniu.common.QiniuException
        Deletes Object in Qiniu kodo.
        Parameters:
        key - Object key
        Throws:
        com.qiniu.common.QiniuException

      • listFiles

        public com.qiniu.storage.model.FileListing listFiles​(java.lang.String prefix,
                                                     java.lang.String marker,
                                                     int limit,
                                                     java.lang.String delimiter)
                                              throws com.qiniu.common.QiniuException
        Lists object for Qiniu kodo.
        Parameters:
        prefix - prefix for bucket
        marker - Marker returned the last time a file list was obtained
        limit - Length limit for each iteration, Max. 1000
        delimiter - Specifies a directory separator that lists all common prefixes (simulated listing directory effects). The default is an empty string
        Returns:
        result for list
        Throws:
        com.qiniu.common.QiniuException