encode.go

package restxml

import (
	"bytes"
	"fmt"
	"io"
	"net/http"

	"github.com/aws/aws-sdk-go-v2/private/protocol"
	"github.com/aws/aws-sdk-go-v2/private/protocol/rest"
	"github.com/aws/aws-sdk-go-v2/private/protocol/xml"
)

// An Encoder provides encoding of the AWS RESTXML protocol. This encoder combindes
// the XML and REST encoders deligating to them for their associated targets.
//
// It is invalid to set a XML and stream payload on the same encoder.
type Encoder struct {
	method      string
	reqEncoder  *rest.Encoder
	bodyEncoder *xml.Encoder

	buf *bytes.Buffer
	err error
}

// NewEncoder creates a new encoder for encoding the AWS RESTXML protocol.
// The request passed in will be the base the path, query, and headers encoded
// will be set on top of.
func NewEncoder(req *http.Request) *Encoder {
	e := &Encoder{
		method:      req.Method,
		reqEncoder:  rest.NewEncoder(req),
		bodyEncoder: xml.NewEncoder(),
	}

	return e
}

// Encode returns the encoded request, and body payload. If no payload body was
// set nil will be returned.  If an error occurred while encoding the API an
// error will be returned.
func (e *Encoder) Encode() (*http.Request, io.ReadSeeker, error) {
	req, payloadBody, err := e.reqEncoder.Encode()
	if err != nil {
		return nil, nil, err
	}

	xmlBody, err := e.bodyEncoder.Encode()
	if err != nil {
		return nil, nil, err
	}

	havePayload := payloadBody != nil
	haveXML := xmlBody != nil

	if havePayload == haveXML && haveXML {
		return nil, nil, fmt.Errorf("unexpected XML body and request payload for AWSMarshaler")
	}

	body := payloadBody
	if body == nil {
		body = xmlBody
	}

	return req, body, err
}

// List will return a new list encoder based on the Target.
func (e *Encoder) List(t protocol.Target, k string, meta protocol.Metadata) protocol.ListEncoder {
	if e.err != nil {
		return nil
	}

	switch t {
	case protocol.HeaderTarget:
		fallthrough
	case protocol.QueryTarget:
		return e.reqEncoder.List(t, k, meta)
	case protocol.BodyTarget:
		return e.bodyEncoder.List(t, k, meta)
	default:
		e.err = fmt.Errorf("unknown SetList restxml encode target, %s, %s", t, k)
		return nil
	}
}

// Map will return a new map encoder based on the Target.
func (e *Encoder) Map(t protocol.Target, k string, meta protocol.Metadata) protocol.MapEncoder {
	if e.err != nil {
		return nil
	}

	switch t {
	case protocol.HeadersTarget:
		fallthrough
	case protocol.QueryTarget:
		return e.reqEncoder.Map(t, k, meta)
	case protocol.BodyTarget:
		return e.bodyEncoder.Map(t, k, meta)
	default:
		e.err = fmt.Errorf("unknown SetMap restxml encode target, %s, %s", t, k)
		return nil
	}
}

// SetValue will set a value to the header, path, query, or body.
//
// If the request's method is GET all BodyTarget values will be written to
// the query string.
func (e *Encoder) SetValue(t protocol.Target, k string, v protocol.ValueMarshaler, meta protocol.Metadata) {
	if e.err != nil {
		return
	}

	switch t {
	case protocol.PathTarget:
		fallthrough
	case protocol.QueryTarget:
		fallthrough
	case protocol.HeaderTarget:
		e.reqEncoder.SetValue(t, k, v, meta)
	case protocol.BodyTarget:
		if e.method == "GET" {
			e.reqEncoder.SetValue(t, k, v, meta)
		} else {
			e.bodyEncoder.SetValue(t, k, v, meta)
		}
	default:
		e.err = fmt.Errorf("unknown SetValue restxml encode target, %s, %s", t, k)
	}
}

// SetStream will set the stream to the payload of the request.
func (e *Encoder) SetStream(t protocol.Target, k string, v protocol.StreamMarshaler, meta protocol.Metadata) {
	if e.err != nil {
		return
	}

	switch t {
	case protocol.PayloadTarget:
		e.reqEncoder.SetStream(t, k, v, meta)
	default:
		e.err = fmt.Errorf("invalid target %s, for SetStream, must be PayloadTarget", t)
	}
}

// SetFields will set the nested type's fields to the body.
func (e *Encoder) SetFields(t protocol.Target, k string, m protocol.FieldMarshaler, meta protocol.Metadata) {
	if e.err != nil {
		return
	}

	switch t {
	case protocol.PayloadTarget:
		fallthrough
	case protocol.BodyTarget:
		e.bodyEncoder.SetFields(t, k, m, meta)
	default:
		e.err = fmt.Errorf("unknown SetMarshaler restxml encode target, %s, %s", t, k)
	}
}