Class Api.Request

  • Direct Known Subclasses:
    ApiUpload.Request
    Enclosing class:
    Api

    public static class Api.Request
    extends java.lang.Object
    api 请求基类
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addHeaderField​(java.lang.String key, java.lang.String value)
      增加请求头
      StringMap getHeader()
      获取请求头信息
      java.lang.String getHost()
      获取 请求的 Host
      java.lang.String getPath()
      获取 url 的 path 信息
      java.lang.String getQuery()
      获取 query 字符串
      java.net.URL getUrl()
      获取 URL
      java.lang.String getUrlPrefix()
      获取请求的 urlPrefix, scheme + host eg: https://upload.qiniu.com
      boolean hasBody()
      是否有请求体
      Api.Request setStreamBodySinkSize​(long streamBodySinkSize)
      使用 streamBody 时,每次读取 streamBody 的大小,读取后发送 默认:streamBodySinkSize 相关:sinkSize
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getUrlPrefix

        public java.lang.String getUrlPrefix()
        获取请求的 urlPrefix, scheme + host eg: https://upload.qiniu.com
        Returns:
        urlPrefix
      • getHost

        public java.lang.String getHost()
                                 throws QiniuException
        获取 请求的 Host
        Returns:
        Host
        Throws:
        QiniuException - 解析 urlPrefix 时的异常
      • getPath

        public java.lang.String getPath()
                                 throws QiniuException
        获取 url 的 path 信息
        Returns:
        path 信息
        Throws:
        QiniuException - 异常
      • getQuery

        public java.lang.String getQuery()
                                  throws QiniuException
        获取 query 字符串
        Returns:
        query 字符串
        Throws:
        QiniuException - 组装 query 时的异常,一般为缺失必要参数的异常
      • addHeaderField

        public void addHeaderField​(java.lang.String key,
                                   java.lang.String value)
        增加请求头
        Parameters:
        key - key
        value - value
      • setStreamBodySinkSize

        public Api.Request setStreamBodySinkSize​(long streamBodySinkSize)
        使用 streamBody 时,每次读取 streamBody 的大小,读取后发送 默认:streamBodySinkSize 相关:sinkSize
        Parameters:
        streamBodySinkSize - 每次读取 streamBody 的大小
        Returns:
        Request
      • hasBody

        public boolean hasBody()
        是否有请求体
        Returns:
        是否有请求体