http

Documentation

Overview

Package http defines the structure of request and response which used to access the BCE services as well as the http constant headers and and methods. And finally implement the `Execute` funct- ion to do the work.

Index

• Constants
• func InitClient(config ClientConfig)
• func SetResponseHeaderTimeout(t int)
• type ClientConfig
• type Request
  • func (r *Request) Body() io.ReadCloser
  • func (r *Request) Endpoint() string
  • func (r *Request) GenerateUrl(addPort bool) string
  • func (r *Request) Header(key string) string
  • func (r *Request) Headers() map[string]string
  • func (r *Request) Host() string
  • func (r *Request) Length() int64
  • func (r *Request) Method() string
  • func (r *Request) Param(key string) string
  • func (r *Request) Params() map[string]string
  • func (r *Request) Port() int
  • func (r *Request) Protocol() string
  • func (r *Request) ProxyUrl() string
  • func (r *Request) QueryString() string
  • func (r *Request) SetBody(stream io.ReadCloser)
  • func (r *Request) SetEndpoint(endpoint string)
  • func (r *Request) SetHeader(key, value string)
  • func (r *Request) SetHeaders(headers map[string]string)
  • func (r *Request) SetHost(host string)
  • func (r *Request) SetLength(l int64)
  • func (r *Request) SetMethod(method string)
  • func (r *Request) SetParam(key, value string)
  • func (r *Request) SetParams(params map[string]string)
  • func (r *Request) SetPort(port int)
  • func (r *Request) SetProtocol(protocol string)
  • func (r *Request) SetProxyUrl(url string)
  • func (r *Request) SetTimeout(timeout int)
  • func (r *Request) SetUri(uri string)
  • func (r *Request) String() string
  • func (r *Request) Timeout() int
  • func (r *Request) Uri() string
• type Response
  • func Execute(request *Request) (*Response, error)
  • func (r *Response) Body() io.ReadCloser
  • func (r *Response) ContentLength() int64
  • func (r *Response) ElapsedTime() time.Duration
  • func (r *Response) GetHeader(name string) string
  • func (r *Response) GetHeaders() map[string]string
  • func (r *Response) HttpResponse() *http.Response
  • func (r *Response) Protocol() string
  • func (r *Response) SetHttpResponse(response *http.Response)
  • func (r *Response) StatusCode() int
  • func (r *Response) StatusText() string

Constants

const (
	GET     = "GET"
	PUT     = "PUT"
	POST    = "POST"
	DELETE  = "DELETE"
	HEAD    = "HEAD"
	OPTIONS = "OPTIONS"
	PATCH   = "PATCH"
)

Constants of the supported HTTP methods for BCE

const (
	// Standard HTTP Headers
	AUTHORIZATION       = "Authorization"
	CACHE_CONTROL       = "Cache-Control"
	CONTENT_DISPOSITION = "Content-Disposition"
	CONTENT_ENCODING    = "Content-Encoding"
	CONTENT_LANGUAGE    = "Content-Language"
	CONTENT_LENGTH      = "Content-Length"
	CONTENT_MD5         = "Content-Md5"
	CONTENT_RANGE       = "Content-Range"
	CONTENT_TYPE        = "Content-Type"
	DATE                = "Date"
	ETAG                = "Etag"
	EXPIRES             = "Expires"
	HOST                = "Host"
	LAST_MODIFIED       = "Last-Modified"
	LOCATION            = "Location"
	RANGE               = "Range"
	SERVER              = "Server"
	TRANSFER_ENCODING   = "Transfer-Encoding"
	USER_AGENT          = "User-Agent"

	// BCE Common HTTP Headers
	BCE_PREFIX               = "x-bce-"
	BCE_ACL                  = "x-bce-acl"
	BCE_GRANT_READ           = "x-bce-grant-read"
	BCE_GRANT_FULL_CONTROL   = "x-bce-grant-full-control"
	BCE_CONTENT_SHA256       = "x-bce-content-sha256"
	BCE_CONTENT_CRC32        = "x-bce-content-crc32"
	BCE_REQUEST_ID           = "x-bce-request-id"
	BCE_USER_METADATA_PREFIX = "x-bce-meta-"
	BCE_SECURITY_TOKEN       = "x-bce-security-token"
	BCE_DATE                 = "x-bce-date"
	BCE_TAG                  = "x-bce-tag-list"

	// BOS HTTP Headers
	BCE_COPY_METADATA_DIRECTIVE         = "x-bce-metadata-directive"
	BCE_COPY_SOURCE                     = "x-bce-copy-source"
	BCE_COPY_SOURCE_IF_MATCH            = "x-bce-copy-source-if-match"
	BCE_COPY_SOURCE_IF_MODIFIED_SINCE   = "x-bce-copy-source-if-modified-since"
	BCE_COPY_SOURCE_IF_NONE_MATCH       = "x-bce-copy-source-if-none-match"
	BCE_COPY_SOURCE_IF_UNMODIFIED_SINCE = "x-bce-copy-source-if-unmodified-since"
	BCE_COPY_SOURCE_RANGE               = "x-bce-copy-source-range"
	BCE_DEBUG_ID                        = "x-bce-debug-id"
	BCE_OBJECT_TYPE                     = "x-bce-object-type"
	BCE_NEXT_APPEND_OFFSET              = "x-bce-next-append-offset"
	BCE_STORAGE_CLASS                   = "x-bce-storage-class"
	BCE_PROCESS                         = "x-bce-process"
	BCE_RESTORE_TIER                    = "x-bce-restore-tier"
	BCE_RESTORE_DAYS                    = "x-bce-restore-days"
	BCE_RESTORE                         = "x-bce-restore"
	BCE_FORBID_OVERWRITE                = "x-bce-forbid-overwrite"
	BCE_SYMLINK_TARGET                  = "x-bce-symlink-target"
	BCE_SYMLINK_BUCKET                  = "x-bce-symlink-bucket"
	BCE_TRAFFIC_LIMIT                   = "x-bce-traffic-limit"
	BCE_BUCKET_TYPE                     = "x-bce-bucket-type"
	BCE_OBJECT_TAGGING                  = "x-bce-tagging"
)

Constants of the HTTP headers for BCE

Functions

func InitClient

func InitClient(config ClientConfig)

func SetResponseHeaderTimeout

func SetResponseHeaderTimeout(t int)

Types

type ClientConfig

type ClientConfig struct {
	RedirectDisabled bool
}

type Request

type Request struct {
	// contains filtered or unexported fields
}

Reauest stands for the general http request structure to make request to the BCE services.

func (*Request) Body

func (r *Request) Body() io.ReadCloser

func (*Request) Endpoint

func (r *Request) Endpoint() string

func (*Request) GenerateUrl

func (r *Request) GenerateUrl(addPort bool) string

func (*Request) Header

func (r *Request) Header(key string) string

func (*Request) Headers

func (r *Request) Headers() map[string]string

func (*Request) Host

func (r *Request) Host() string

func (*Request) Length

func (r *Request) Length() int64

func (*Request) Method

func (r *Request) Method() string

func (*Request) Param

func (r *Request) Param(key string) string

func (*Request) Params

func (r *Request) Params() map[string]string

func (*Request) Port

func (r *Request) Port() int

func (*Request) Protocol

func (r *Request) Protocol() string

func (*Request) ProxyUrl

func (r *Request) ProxyUrl() string

func (*Request) QueryString

func (r *Request) QueryString() string

func (*Request) SetBody

func (r *Request) SetBody(stream io.ReadCloser)

func (*Request) SetEndpoint

func (r *Request) SetEndpoint(endpoint string)

func (*Request) SetHeader

func (r *Request) SetHeader(key, value string)

func (*Request) SetHeaders

func (r *Request) SetHeaders(headers map[string]string)

func (*Request) SetHost

func (r *Request) SetHost(host string)

func (*Request) SetLength

func (r *Request) SetLength(l int64)

func (*Request) SetMethod

func (r *Request) SetMethod(method string)

func (*Request) SetParam

func (r *Request) SetParam(key, value string)

func (*Request) SetParams

func (r *Request) SetParams(params map[string]string)

func (*Request) SetPort

func (r *Request) SetPort(port int)

func (*Request) SetProtocol

func (r *Request) SetProtocol(protocol string)

func (*Request) SetProxyUrl

func (r *Request) SetProxyUrl(url string)

func (*Request) SetTimeout

func (r *Request) SetTimeout(timeout int)

func (*Request) SetUri

func (r *Request) SetUri(uri string)

func (*Request) String

func (r *Request) String() string

func (*Request) Timeout

func (r *Request) Timeout() int

func (*Request) Uri

func (r *Request) Uri() string

type Response

type Response struct {
	// contains filtered or unexported fields
}

Response defines the general http response structure for accessing the BCE services.

func Execute

func Execute(request *Request) (*Response, error)

Execute - do the http requset and get the response

PARAMS:

• request: the http request instance to be sent

RETURNS:

• response: the http response returned from the server
• error: nil if ok otherwise the specific error

func (*Response) Body

func (r *Response) Body() io.ReadCloser

func (*Response) ContentLength

func (r *Response) ContentLength() int64

func (*Response) ElapsedTime

func (r *Response) ElapsedTime() time.Duration

func (*Response) GetHeader

func (r *Response) GetHeader(name string) string

func (*Response) GetHeaders

func (r *Response) GetHeaders() map[string]string

func (*Response) HttpResponse

func (r *Response) HttpResponse() *http.Response

func (*Response) Protocol

func (r *Response) Protocol() string

func (*Response) SetHttpResponse

func (r *Response) SetHttpResponse(response *http.Response)

func (*Response) StatusCode

func (r *Response) StatusCode() int

func (*Response) StatusText

func (r *Response) StatusText() string