soap

Documentation

Index

• Variables
• func IsRegularError(err error) bool
• func IsSoapFault(err error) bool
• func IsVimFault(err error) bool
• func ParseURL(s string) (*url.URL, error)
• func ThumbprintSHA1(cert *x509.Certificate) string
• func ToRegularError(err error) error
• func ToVimFault(err error) types.BaseMethodFault
• func Wrap(err error) error
• func WrapRegularError(err error) error
• func WrapSoapFault(f *Fault) error
• func WrapVimFault(v types.BaseMethodFault) error
• type Client
  • func NewClient(u *url.URL, insecure bool) *Client
  • func (c *Client) CloseIdleConnections()
  • func (c *Client) Download(u *url.URL, param *Download) (io.ReadCloser, int64, error)
  • func (c *Client) DownloadFile(file string, u *url.URL, param *Download) error
  • func (c *Client) DownloadRequest(u *url.URL, param *Download) (*http.Response, error)
  • func (c *Client) LoadThumbprints(file string) error
  • func (c *Client) MarshalJSON() ([]byte, error)
  • func (c *Client) ParseURL(urlStr string) (*url.URL, error)
  • func (c *Client) RoundTrip(ctx context.Context, reqBody, resBody HasFault) error
  • func (c *Client) SetCertificate(cert tls.Certificate)
  • func (c *Client) SetRootCAs(file string) error
  • func (c *Client) SetThumbprint(host string, thumbprint string)
  • func (c *Client) Thumbprint(host string) string
  • func (c *Client) URL() *url.URL
  • func (c *Client) UnmarshalJSON(b []byte) error
  • func (c *Client) Upload(f io.Reader, u *url.URL, param *Upload) error
  • func (c *Client) UploadFile(file string, u *url.URL, param *Upload) error
• type Download
• type Envelope
• type Fault
  • func ToSoapFault(err error) *Fault
  • func (f *Fault) VimFault() types.AnyType
• type HasFault
• type Header
• type RoundTripper
• type Upload

Variables

var DefaultDownload = Download{
	Method: "GET",
}

var DefaultUpload = Upload{
	Type:   "application/octet-stream",
	Method: "PUT",
}

var DefaultVimNamespace = "urn:vim25"

var DefaultVimVersion = "6.0"

Functions

func IsRegularError

func IsRegularError(err error) bool

func IsSoapFault

func IsSoapFault(err error) bool

func IsVimFault

func IsVimFault(err error) bool

func ParseURL

func ParseURL(s string) (*url.URL, error)

ParseURL is wrapper around url.Parse, where Scheme defaults to "https" and Path defaults to "/sdk"

func ThumbprintSHA1

func ThumbprintSHA1(cert *x509.Certificate) string

ThumbprintSHA1 returns the thumbprint of the given cert in the same format used by the SDK and Client.SetThumbprint.

See: SSLVerifyFault.Thumbprint, SessionManagerGenericServiceTicket.Thumbprint, HostConnectSpec.SslThumbprint

func ToRegularError

func ToRegularError(err error) error

func ToVimFault

func ToVimFault(err error) types.BaseMethodFault

func Wrap

func Wrap(err error) error

func WrapRegularError

func WrapRegularError(err error) error

func WrapSoapFault

func WrapSoapFault(f *Fault) error

func WrapVimFault

func WrapVimFault(v types.BaseMethodFault) error

Types

type Client

type Client struct {
	http.Client

	Namespace string // Vim namespace
	Version   string // Vim version
	UserAgent string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(u *url.URL, insecure bool) *Client

func (*Client) CloseIdleConnections

func (c *Client) CloseIdleConnections()

func (*Client) Download

func (c *Client) Download(u *url.URL, param *Download) (io.ReadCloser, int64, error)

Download GETs the remote file from the given URL

func (*Client) DownloadFile

func (c *Client) DownloadFile(file string, u *url.URL, param *Download) error

DownloadFile GETs the given URL to a local file

func (*Client) DownloadRequest

func (c *Client) DownloadRequest(u *url.URL, param *Download) (*http.Response, error)

DownloadRequest wraps http.Client.Do, returning the http.Response without checking its StatusCode

func (*Client) LoadThumbprints

func (c *Client) LoadThumbprints(file string) error

LoadThumbprints from file with the give name. If name is empty or name does not exist this function will return nil.

func (*Client) MarshalJSON

func (c *Client) MarshalJSON() ([]byte, error)

func (*Client) ParseURL

func (c *Client) ParseURL(urlStr string) (*url.URL, error)

ParseURL wraps url.Parse to rewrite the URL.Host field In the case of VM guest uploads or NFC lease URLs, a Host field with a value of "*" is rewritten to the Client's URL.Host.

func (*Client) RoundTrip

func (c *Client) RoundTrip(ctx context.Context, reqBody, resBody HasFault) error

func (*Client) SetCertificate

func (c *Client) SetCertificate(cert tls.Certificate)

func (*Client) SetRootCAs

func (c *Client) SetRootCAs(file string) error

SetRootCAs defines the set of root certificate authorities that clients use when verifying server certificates. By default TLS uses the host's root CA set.

See: http.Client.Transport.TLSClientConfig.RootCAs

func (*Client) SetThumbprint

func (c *Client) SetThumbprint(host string, thumbprint string)

SetThumbprint sets the known certificate thumbprint for the given host. A custom DialTLS function is used to support thumbprint based verification. We first try tls.Dial with the default tls.Config, only falling back to thumbprint verification if it fails with an x509.UnknownAuthorityError or x509.HostnameError

See: http.Client.Transport.DialTLS

func (*Client) Thumbprint

func (c *Client) Thumbprint(host string) string

Thumbprint returns the certificate thumbprint for the given host if known to this client.

func (*Client) URL

func (c *Client) URL() *url.URL

func (*Client) UnmarshalJSON

func (c *Client) UnmarshalJSON(b []byte) error

func (*Client) Upload

func (c *Client) Upload(f io.Reader, u *url.URL, param *Upload) error

Upload PUTs the local file to the given URL

func (*Client) UploadFile

func (c *Client) UploadFile(file string, u *url.URL, param *Upload) error

UploadFile PUTs the local file to the given URL

type Download

type Download struct {
	Method   string
	Headers  map[string]string
	Ticket   *http.Cookie
	Progress progress.Sinker
}

type Envelope

type Envelope struct {
	XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Envelope"`
	Header  *Header  `xml:",omitempty"`
	Body    interface{}
}

type Fault

type Fault struct {
	XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Fault"`
	Code    string   `xml:"faultcode"`
	String  string   `xml:"faultstring"`
	Detail  struct {
		Fault types.AnyType `xml:",any,typeattr"`
	} `xml:"detail"`
}

func ToSoapFault

func ToSoapFault(err error) *Fault

func (*Fault) VimFault

func (f *Fault) VimFault() types.AnyType

type HasFault

type HasFault interface {
	Fault() *Fault
}

type Header

type Header struct {
	XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Header"`
}

type RoundTripper

type RoundTripper interface {
	RoundTrip(ctx context.Context, req, res HasFault) error
}

type Upload

type Upload struct {
	Type          string
	Method        string
	ContentLength int64
	Headers       map[string]string
	Ticket        *http.Cookie
	Progress      progress.Sinker
}