smithy-go: github.com/awslabs/smithy-go/middleware Index | Files

package middleware

import "github.com/awslabs/smithy-go/middleware"

Package middleware provide transport agnostic middleware for decorating SDK handlers.

The Smithy middleware stack provides ordered behavior to be invoked on an underlying handler. The stack is separated into steps that are invoked in a static order. A step is a collection of middleware that are injected into a ordered list defined by the user. The user may add, insert, swap, and remove a step's middleware. When the stack is invoked the step middleware become static, and their order cannot be modified.

A stack and its step middleware are **not** safe to modify concurrently.

A stack will use the ordered list of middleware to decorate a underlying handler. A handler could be something like an HTTP Client that round trips an API operation over HTTP.

Smithy Middleware Stack

A Stack is a collection of middleware that wrap a handler. The stack can be broken down into discreet steps. Each step may contain zero or more middleware specific to that stack's step.

A Stack Step is a predefined set of middleware that are invoked in a static order by the Stack. These steps represent fixed points in the middleware stack for organizing specific behavior, such as serialize and build. A Stack Step is composed of zero or more middleware that are specific to that step. A step may define its on set of input/output parameters the generic input/output parameters are cast from. A step calls its middleware recursively, before calling the next step in the stack returning the result or error of the step middleware decorating the underlying handler.

* Initialize: Prepares the input, and sets any default parameters as needed, (e.g. idempotency token, and presigned URLs).

* Serialize: Serializes the prepared input into a data structure that can be consumed by the target transport's message, (e.g. REST-JSON serialization).

* Build: Adds additional metadata to the serialized transport message, (e.g. HTTP's Content-Length header, or body checksum). Decorations and modifications to the message should be copied to all message attempts.

* Finalize: Preforms final preparations needed before sending the message. The message should already be complete by this stage, and is only alternated to meet the expectations of the recipient, (e.g. Retry and AWS SigV4 request signing).

* Deserialize: Reacts to the handler's response returned by the recipient of the request message. Deserializes the response into a structured type or error above stacks can react to.

Adding Middleware to a Stack Step

Middleware can be added to a step front or back, or relative, by name, to an existing middleware in that stack. If a middleware does not have a name a unique name will be generated at the middleware is added to the step.

// Create middleware stack
stack := middleware.NewStack()

// Add middleware to stack steps
stack.Initialize.Add(paramValidationMiddleware, middleware.After)
stack.Serialize.Add(marshalOperationFoo, middleware.After)
stack.Deserialize.Add(unmarshalOperationFoo, middleware.After)

// Invoke middleware on handler.
resp, err := stack.HandleMiddleware(ctx, req.Input, clientHandler)

Index

Package Files

doc.go logging.go metadata.go middleware.go ordered_group.go stack.go step_build.go step_deserialize.go step_finalize.go step_initialize.go step_serialize.go

func AddSetLoggerMiddleware Uses

func AddSetLoggerMiddleware(stack *Stack, logger logging.Logger) error

AddSetLoggerMiddleware adds a middleware that will add the provided logger to the middleware context.

func GetLogger Uses

func GetLogger(ctx context.Context) logging.Logger

GetLogger takes a context to retrieve a Logger from. If no logger is present on the context a logging.Nop logger is returned. If the logger retrieved from context supports the ContextLogger interface, the context will be passed to the WithContext method and the resulting logger will be returned. Otherwise the stored logger is returned as is.

func GetMiddlewareIDs Uses

func GetMiddlewareIDs(ctx context.Context) []string

GetMiddlewareIDs returns a list of middleware IDs in the order they were added in.

func RecordMiddleware Uses

func RecordMiddleware(ctx context.Context, id string) context.Context

RecordMiddleware appends the middleware id to the list of middleware ids to the context.

func SetLogger Uses

func SetLogger(ctx context.Context, logger logging.Logger) context.Context

SetLogger sets the provided logger value on the provided ctx.

type BuildHandler Uses

type BuildHandler interface {
    HandleBuild(ctx context.Context, in BuildInput) (
        out BuildOutput, metadata Metadata, err error,
    )
}

BuildHandler provides the interface for the next handler the BuildMiddleware will call in the middleware chain.

type BuildHandlerFunc Uses

type BuildHandlerFunc func(context.Context, BuildInput) (BuildOutput, Metadata, error)

BuildHandlerFunc provides a wrapper around a function to be used as a build middleware handler.

func (BuildHandlerFunc) HandleBuild Uses

func (b BuildHandlerFunc) HandleBuild(ctx context.Context, in BuildInput) (BuildOutput, Metadata, error)

HandleBuild invokes the wrapped function with the provided arguments.

type BuildInput Uses

type BuildInput struct {
    Request interface{}
}

BuildInput provides the input parameters for the BuildMiddleware to consume. BuildMiddleware may modify the Request value before forwarding the input along to the next BuildHandler.

type BuildMiddleware Uses

type BuildMiddleware interface {
    // Unique ID for the middleware in theBuildStep. The step does not allow
    // duplicate IDs.
    ID() string

    // Invokes the middleware behavior which must delegate to the next handler
    // for the middleware chain to continue. The method must return a result or
    // error to its caller.
    HandleBuild(ctx context.Context, in BuildInput, next BuildHandler) (
        out BuildOutput, metadata Metadata, err error,
    )
}

BuildMiddleware provides the interface for middleware specific to the serialize step. Delegates to the next BuildHandler for further processing.

func BuildMiddlewareFunc Uses

func BuildMiddlewareFunc(id string, fn func(context.Context, BuildInput, BuildHandler) (BuildOutput, Metadata, error)) BuildMiddleware

BuildMiddlewareFunc returns a BuildMiddleware with the unique ID provided, and the func to be invoked.

type BuildOutput Uses

type BuildOutput struct {
    Result interface{}
}

BuildOutput provides the result returned by the next BuildHandler.

type BuildStep Uses

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

BuildStep provides the ordered grouping of BuildMiddleware to be invoked on an handler.

func NewBuildStep Uses

func NewBuildStep() *BuildStep

NewBuildStep returns an BuildStep ready to have middleware for initialization added to it.

func (*BuildStep) Add Uses

func (s *BuildStep) Add(m BuildMiddleware, pos RelativePosition) error

Add injects the middleware to the relative position of the middleware group. Returns an error if the middleware already exists.

func (*BuildStep) Clear Uses

func (s *BuildStep) Clear()

Clear removes all middleware in the step.

func (*BuildStep) Get Uses

func (s *BuildStep) Get(id string) (BuildMiddleware, bool)

Get retrieves the middleware identified by id. If the middleware is not present, returns false.

func (*BuildStep) HandleMiddleware Uses

func (s *BuildStep) HandleMiddleware(ctx context.Context, in interface{}, next Handler) (
    out interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware by decorating the next handler provided. Returns the result of the middleware and handler being invoked.

Implements Middleware interface.

func (*BuildStep) ID Uses

func (s *BuildStep) ID() string

ID returns the unique name of the step as a middleware.

func (*BuildStep) Insert Uses

func (s *BuildStep) Insert(m BuildMiddleware, relativeTo string, pos RelativePosition) error

Insert injects the middleware relative to an existing middleware id. Return error if the original middleware does not exist, or the middleware being added already exists.

func (*BuildStep) List Uses

func (s *BuildStep) List() []string

List returns a list of the middleware in the step.

func (*BuildStep) Remove Uses

func (s *BuildStep) Remove(id string) (BuildMiddleware, error)

Remove removes the middleware by id. Returns error if the middleware doesn't exist.

func (*BuildStep) Swap Uses

func (s *BuildStep) Swap(id string, m BuildMiddleware) (BuildMiddleware, error)

Swap removes the middleware by id, replacing it with the new middleware. Returns the middleware removed, or error if the middleware to be removed doesn't exist.

type DeserializeHandler Uses

type DeserializeHandler interface {
    HandleDeserialize(ctx context.Context, in DeserializeInput) (
        out DeserializeOutput, metadata Metadata, err error,
    )
}

DeserializeHandler provides the interface for the next handler the DeserializeMiddleware will call in the middleware chain.

type DeserializeHandlerFunc Uses

type DeserializeHandlerFunc func(context.Context, DeserializeInput) (DeserializeOutput, Metadata, error)

DeserializeHandlerFunc provides a wrapper around a function to be used as a deserialize middleware handler.

func (DeserializeHandlerFunc) HandleDeserialize Uses

func (d DeserializeHandlerFunc) HandleDeserialize(ctx context.Context, in DeserializeInput) (DeserializeOutput, Metadata, error)

HandleDeserialize invokes the wrapped function with the given arguments.

type DeserializeInput Uses

type DeserializeInput struct {
    Request interface{}
}

DeserializeInput provides the input parameters for the DeserializeInput to consume. DeserializeMiddleware should not modify the Request, and instead forward it along to the next DeserializeHandler.

type DeserializeMiddleware Uses

type DeserializeMiddleware interface {
    // Unique ID for the middleware in the DeserializeStep. The step does not
    // allow duplicate IDs.
    ID() string

    // Invokes the middleware behavior which must delegate to the next handler
    // for the middleware chain to continue. The method must return a result or
    // error to its caller.
    HandleDeserialize(ctx context.Context, in DeserializeInput, next DeserializeHandler) (
        out DeserializeOutput, metadata Metadata, err error,
    )
}

DeserializeMiddleware provides the interface for middleware specific to the serialize step. Delegates to the next DeserializeHandler for further processing.

func DeserializeMiddlewareFunc Uses

func DeserializeMiddlewareFunc(id string, fn func(context.Context, DeserializeInput, DeserializeHandler) (DeserializeOutput, Metadata, error)) DeserializeMiddleware

DeserializeMiddlewareFunc returns a DeserializeMiddleware with the unique ID provided, and the func to be invoked.

type DeserializeOutput Uses

type DeserializeOutput struct {
    RawResponse interface{}
    Result      interface{}
}

DeserializeOutput provides the result returned by the next DeserializeHandler. The DeserializeMiddleware should deserailize the RawResponse into a Result that can be consumed by middleware higher up in the stack.

type DeserializeStep Uses

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

DeserializeStep provides the ordered grouping of DeserializeMiddleware to be invoked on an handler.

func NewDeserializeStep Uses

func NewDeserializeStep() *DeserializeStep

NewDeserializeStep returns an DeserializeStep ready to have middleware for initialization added to it.

func (*DeserializeStep) Add Uses

func (s *DeserializeStep) Add(m DeserializeMiddleware, pos RelativePosition) error

Add injects the middleware to the relative position of the middleware group. Returns an error if the middleware already exists.

func (*DeserializeStep) Clear Uses

func (s *DeserializeStep) Clear()

Clear removes all middleware in the step.

func (*DeserializeStep) Get Uses

func (s *DeserializeStep) Get(id string) (DeserializeMiddleware, bool)

Get retrieves the middleware identified by id. If the middleware is not present, returns false.

func (*DeserializeStep) HandleMiddleware Uses

func (s *DeserializeStep) HandleMiddleware(ctx context.Context, in interface{}, next Handler) (
    out interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware by decorating the next handler provided. Returns the result of the middleware and handler being invoked.

Implements Middleware interface.

func (*DeserializeStep) ID Uses

func (s *DeserializeStep) ID() string

ID returns the unique id of the step as a middleware.

func (*DeserializeStep) Insert Uses

func (s *DeserializeStep) Insert(m DeserializeMiddleware, relativeTo string, pos RelativePosition) error

Insert injects the middleware relative to an existing middleware id. Return error if the original middleware does not exist, or the middleware being added already exists.

func (*DeserializeStep) List Uses

func (s *DeserializeStep) List() []string

List returns a list of the middleware in the step.

func (*DeserializeStep) Remove Uses

func (s *DeserializeStep) Remove(id string) (DeserializeMiddleware, error)

Remove removes the middleware by id. Returns error if the middleware doesn't exist.

func (*DeserializeStep) Swap Uses

func (s *DeserializeStep) Swap(id string, m DeserializeMiddleware) (DeserializeMiddleware, error)

Swap removes the middleware by id, replacing it with the new middleware. Returns the middleware removed, or error if the middleware to be removed doesn't exist.

type FinalizeHandler Uses

type FinalizeHandler interface {
    HandleFinalize(ctx context.Context, in FinalizeInput) (
        out FinalizeOutput, metadata Metadata, err error,
    )
}

FinalizeHandler provides the interface for the next handler the FinalizeMiddleware will call in the middleware chain.

type FinalizeHandlerFunc Uses

type FinalizeHandlerFunc func(context.Context, FinalizeInput) (FinalizeOutput, Metadata, error)

FinalizeHandlerFunc provides a wrapper around a function to be used as a finalize middleware handler.

func (FinalizeHandlerFunc) HandleFinalize Uses

func (f FinalizeHandlerFunc) HandleFinalize(ctx context.Context, in FinalizeInput) (FinalizeOutput, Metadata, error)

HandleFinalize invokes the wrapped function with the given arguments.

type FinalizeInput Uses

type FinalizeInput struct {
    Request interface{}
}

FinalizeInput provides the input parameters for the FinalizeMiddleware to consume. FinalizeMiddleware may modify the Request value before forwarding the FinalizeInput along to the next next FinalizeHandler.

type FinalizeMiddleware Uses

type FinalizeMiddleware interface {
    // Unique ID for the middleware in the FinalizeStep. The step does not
    // allow duplicate IDs.
    ID() string

    // Invokes the middleware behavior which must delegate to the next handler
    // for the middleware chain to continue. The method must return a result or
    // error to its caller.
    HandleFinalize(ctx context.Context, in FinalizeInput, next FinalizeHandler) (
        out FinalizeOutput, metadata Metadata, err error,
    )
}

FinalizeMiddleware provides the interface for middleware specific to the serialize step. Delegates to the next FinalizeHandler for further processing.

func FinalizeMiddlewareFunc Uses

func FinalizeMiddlewareFunc(id string, fn func(context.Context, FinalizeInput, FinalizeHandler) (FinalizeOutput, Metadata, error)) FinalizeMiddleware

FinalizeMiddlewareFunc returns a FinalizeMiddleware with the unique ID provided, and the func to be invoked.

type FinalizeOutput Uses

type FinalizeOutput struct {
    Result interface{}
}

FinalizeOutput provides the result returned by the next FinalizeHandler.

type FinalizeStep Uses

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

FinalizeStep provides the ordered grouping of FinalizeMiddleware to be invoked on an handler.

func NewFinalizeStep Uses

func NewFinalizeStep() *FinalizeStep

NewFinalizeStep returns an FinalizeStep ready to have middleware for initialization added to it.

func (*FinalizeStep) Add Uses

func (s *FinalizeStep) Add(m FinalizeMiddleware, pos RelativePosition) error

Add injects the middleware to the relative position of the middleware group. Returns an error if the middleware already exists.

func (*FinalizeStep) Clear Uses

func (s *FinalizeStep) Clear()

Clear removes all middleware in the step.

func (*FinalizeStep) Get Uses

func (s *FinalizeStep) Get(id string) (FinalizeMiddleware, bool)

Get retrieves the middleware identified by id. If the middleware is not present, returns false.

func (*FinalizeStep) HandleMiddleware Uses

func (s *FinalizeStep) HandleMiddleware(ctx context.Context, in interface{}, next Handler) (
    out interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware by decorating the next handler provided. Returns the result of the middleware and handler being invoked.

Implements Middleware interface.

func (*FinalizeStep) ID Uses

func (s *FinalizeStep) ID() string

ID returns the unique id of the step as a middleware.

func (*FinalizeStep) Insert Uses

func (s *FinalizeStep) Insert(m FinalizeMiddleware, relativeTo string, pos RelativePosition) error

Insert injects the middleware relative to an existing middleware id. Return error if the original middleware does not exist, or the middleware being added already exists.

func (*FinalizeStep) List Uses

func (s *FinalizeStep) List() []string

List returns a list of the middleware in the step.

func (*FinalizeStep) Remove Uses

func (s *FinalizeStep) Remove(id string) (FinalizeMiddleware, error)

Remove removes the middleware by id. Returns error if the middleware doesn't exist.

func (*FinalizeStep) Swap Uses

func (s *FinalizeStep) Swap(id string, m FinalizeMiddleware) (FinalizeMiddleware, error)

Swap removes the middleware by id, replacing it with the new middleware. Returns the middleware removed, or error if the middleware to be removed doesn't exist.

type Handler Uses

type Handler interface {
    // Handle performs logic to obtain an output for the given input. Handler
    // should be decorated with middleware to perform input specific behavior.
    Handle(ctx context.Context, input interface{}) (
        output interface{}, metadata Metadata, err error,
    )
}

Handler provides the interface for performing the logic to obtain an output, or error for the given input.

func DecorateHandler Uses

func DecorateHandler(h Handler, with ...Middleware) Handler

DecorateHandler decorates a handler with a middleware. Wrapping the handler with the middleware.

type HandlerFunc Uses

type HandlerFunc func(ctx context.Context, input interface{}) (
    output interface{}, metadata Metadata, err error,
)

HandlerFunc provides a wrapper around a function pointer to be used as a middleware handler.

func (HandlerFunc) Handle Uses

func (fn HandlerFunc) Handle(ctx context.Context, input interface{}) (
    output interface{}, metadata Metadata, err error,
)

Handle invokes the underlying function, returning the result.

type InitializeHandler Uses

type InitializeHandler interface {
    HandleInitialize(ctx context.Context, in InitializeInput) (
        out InitializeOutput, metadata Metadata, err error,
    )
}

InitializeHandler provides the interface for the next handler the InitializeMiddleware will call in the middleware chain.

type InitializeHandlerFunc Uses

type InitializeHandlerFunc func(context.Context, InitializeInput) (InitializeOutput, Metadata, error)

InitializeHandlerFunc provides a wrapper around a function to be used as an initialize middleware handler.

func (InitializeHandlerFunc) HandleInitialize Uses

func (i InitializeHandlerFunc) HandleInitialize(ctx context.Context, in InitializeInput) (InitializeOutput, Metadata, error)

HandleInitialize calls the wrapped function with the provided arguments.

type InitializeInput Uses

type InitializeInput struct {
    Parameters interface{}
}

InitializeInput wraps the input parameters for the InitializeMiddlewares to consume. InitializeMiddleware may modify the parameter value before forwarding it along to the next InitializeHandler.

type InitializeMiddleware Uses

type InitializeMiddleware interface {
    // Unique ID for the middleware in the InitializeStep. The step does not
    // allow duplicate IDs.
    ID() string

    // Invokes the middleware behavior which must delegate to the next handler
    // for the middleware chain to continue. The method must return a result or
    // error to its caller.
    HandleInitialize(ctx context.Context, in InitializeInput, next InitializeHandler) (
        out InitializeOutput, metadata Metadata, err error,
    )
}

InitializeMiddleware provides the interface for middleware specific to the initialize step. Delegates to the next InitializeHandler for further processing.

func InitializeMiddlewareFunc Uses

func InitializeMiddlewareFunc(id string, fn func(context.Context, InitializeInput, InitializeHandler) (InitializeOutput, Metadata, error)) InitializeMiddleware

InitializeMiddlewareFunc returns a InitializeMiddleware with the unique ID provided, and the func to be invoked.

type InitializeOutput Uses

type InitializeOutput struct {
    Result interface{}
}

InitializeOutput provides the result returned by the next InitializeHandler.

type InitializeStep Uses

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

InitializeStep provides the ordered grouping of InitializeMiddleware to be invoked on an handler.

func NewInitializeStep Uses

func NewInitializeStep() *InitializeStep

NewInitializeStep returns an InitializeStep ready to have middleware for initialization added to it.

func (*InitializeStep) Add Uses

func (s *InitializeStep) Add(m InitializeMiddleware, pos RelativePosition) error

Add injects the middleware to the relative position of the middleware group. Returns an error if the middleware already exists.

func (*InitializeStep) Clear Uses

func (s *InitializeStep) Clear()

Clear removes all middleware in the step.

func (*InitializeStep) Get Uses

func (s *InitializeStep) Get(id string) (InitializeMiddleware, bool)

Get retrieves the middleware identified by id. If the middleware is not present, returns false.

func (*InitializeStep) HandleMiddleware Uses

func (s *InitializeStep) HandleMiddleware(ctx context.Context, in interface{}, next Handler) (
    out interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware by decorating the next handler provided. Returns the result of the middleware and handler being invoked.

Implements Middleware interface.

func (*InitializeStep) ID Uses

func (s *InitializeStep) ID() string

ID returns the unique id of the step as a middleware.

func (*InitializeStep) Insert Uses

func (s *InitializeStep) Insert(m InitializeMiddleware, relativeTo string, pos RelativePosition) error

Insert injects the middleware relative to an existing middleware id. Return error if the original middleware does not exist, or the middleware being added already exists.

func (*InitializeStep) List Uses

func (s *InitializeStep) List() []string

List returns a list of the middleware in the step.

func (*InitializeStep) Remove Uses

func (s *InitializeStep) Remove(id string) (InitializeMiddleware, error)

Remove removes the middleware by id. Returns error if the middleware doesn't exist.

func (*InitializeStep) Swap Uses

func (s *InitializeStep) Swap(id string, m InitializeMiddleware) (InitializeMiddleware, error)

Swap removes the middleware by id, replacing it with the new middleware. Returns the middleware removed, or error if the middleware to be removed doesn't exist.

type Metadata Uses

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

Metadata provides storing and reading metadata values. Keys may be any comparable value type. Get and set will panic if key is not a comparable value type.

Metadata uses lazy initialization, and Set method must be called as an addressable value, or pointer. Not doing so may cause key/value pair to not be set.

func (Metadata) Get Uses

func (m Metadata) Get(key interface{}) interface{}

Get attempts to retrieve the value the key points to. Returns nil if the key was not found.

Panics if key type is not comparable.

func (Metadata) Has Uses

func (m Metadata) Has(key interface{}) bool

Has returns if the key exists in the metadata.

Panics if the key type is not comparable.

func (*Metadata) Set Uses

func (m *Metadata) Set(key, value interface{})

Set stores the value pointed to by the key. If a value already exists at that key it will be replaced with the new value.

Set method must be called as an addressable value, or pointer. If Set is not called as a addressable value or pointer, the key value pair being set may be lost.

Panics if the key type is not comparable.

type MetadataReader Uses

type MetadataReader interface {
    Get(key interface{}) interface{}
}

MetadataReader provides an interface for reading metadata from the underlying metadata container.

type Middleware Uses

type Middleware interface {
    // ID provides a unique identifier for the middleware.
    ID() string

    // Performs the middleware's handling of the input, returning the output,
    // or error. The middleware can invoke the next Handler if handling should
    // continue.
    HandleMiddleware(ctx context.Context, input interface{}, next Handler) (
        output interface{}, metadata Metadata, err error,
    )
}

Middleware provides the interface to call handlers in a chain.

type RelativePosition Uses

type RelativePosition int

RelativePosition provides specifying the relative position of a middleware in an ordered group.

const (
    After RelativePosition = iota
    Before
)

Relative position for middleware in steps.

type SerializeHandler Uses

type SerializeHandler interface {
    HandleSerialize(ctx context.Context, in SerializeInput) (
        out SerializeOutput, metadata Metadata, err error,
    )
}

SerializeHandler provides the interface for the next handler the SerializeMiddleware will call in the middleware chain.

type SerializeHandlerFunc Uses

type SerializeHandlerFunc func(context.Context, SerializeInput) (SerializeOutput, Metadata, error)

SerializeHandlerFunc provides a wrapper around a function to be used as a serialize middleware handler.

func (SerializeHandlerFunc) HandleSerialize Uses

func (s SerializeHandlerFunc) HandleSerialize(ctx context.Context, in SerializeInput) (SerializeOutput, Metadata, error)

HandleSerialize calls the wrapped function with the provided arguments.

type SerializeInput Uses

type SerializeInput struct {
    Parameters interface{}
    Request    interface{}
}

SerializeInput provides the input parameters for the SerializeMiddleware to consume. SerializeMiddleware may modify the Request value before forwarding SerializeInput along to the next SerializeHandler. The Parameters member should not be modified by SerializeMiddleware, InitializeMiddleware should be responsible for modifying the provided Parameter value.

type SerializeMiddleware Uses

type SerializeMiddleware interface {
    // Unique ID for the middleware in the SerializeStep. The step does not
    // allow duplicate IDs.
    ID() string

    // Invokes the middleware behavior which must delegate to the next handler
    // for the middleware chain to continue. The method must return a result or
    // error to its caller.
    HandleSerialize(ctx context.Context, in SerializeInput, next SerializeHandler) (
        out SerializeOutput, metadata Metadata, err error,
    )
}

SerializeMiddleware provides the interface for middleware specific to the serialize step. Delegates to the next SerializeHandler for further processing.

func SerializeMiddlewareFunc Uses

func SerializeMiddlewareFunc(id string, fn func(context.Context, SerializeInput, SerializeHandler) (SerializeOutput, Metadata, error)) SerializeMiddleware

SerializeMiddlewareFunc returns a SerializeMiddleware with the unique ID provided, and the func to be invoked.

type SerializeOutput Uses

type SerializeOutput struct {
    Result interface{}
}

SerializeOutput provides the result returned by the next SerializeHandler.

type SerializeStep Uses

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

SerializeStep provides the ordered grouping of SerializeMiddleware to be invoked on an handler.

func NewSerializeStep Uses

func NewSerializeStep(newRequest func() interface{}) *SerializeStep

NewSerializeStep returns an SerializeStep ready to have middleware for initialization added to it. The newRequest func parameter is used to initialize the transport specific request for the stack SerializeStep to serialize the input parameters into.

func (*SerializeStep) Add Uses

func (s *SerializeStep) Add(m SerializeMiddleware, pos RelativePosition) error

Add injects the middleware to the relative position of the middleware group. Returns an error if the middleware already exists.

func (*SerializeStep) Clear Uses

func (s *SerializeStep) Clear()

Clear removes all middleware in the step.

func (*SerializeStep) Get Uses

func (s *SerializeStep) Get(id string) (SerializeMiddleware, bool)

Get retrieves the middleware identified by id. If the middleware is not present, returns false.

func (*SerializeStep) HandleMiddleware Uses

func (s *SerializeStep) HandleMiddleware(ctx context.Context, in interface{}, next Handler) (
    out interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware by decorating the next handler provided. Returns the result of the middleware and handler being invoked.

Implements Middleware interface.

func (*SerializeStep) ID Uses

func (s *SerializeStep) ID() string

ID returns the unique id of the step as a middleware.

func (*SerializeStep) Insert Uses

func (s *SerializeStep) Insert(m SerializeMiddleware, relativeTo string, pos RelativePosition) error

Insert injects the middleware relative to an existing middleware id. Return error if the original middleware does not exist, or the middleware being added already exists.

func (*SerializeStep) List Uses

func (s *SerializeStep) List() []string

List returns a list of the middleware in the step.

func (*SerializeStep) Remove Uses

func (s *SerializeStep) Remove(id string) (SerializeMiddleware, error)

Remove removes the middleware by id. Returns error if the middleware doesn't exist.

func (*SerializeStep) Swap Uses

func (s *SerializeStep) Swap(id string, m SerializeMiddleware) (SerializeMiddleware, error)

Swap removes the middleware by id, replacing it with the new middleware. Returns the middleware removed, or error if the middleware to be removed doesn't exist.

type Stack Uses

type Stack struct {
    // Initialize Prepares the input, and sets any default parameters as
    // needed, (e.g. idempotency token, and presigned URLs).
    //
    // Takes Input Parameters, and returns result or error.
    //
    // Receives result or error from Serialize step.
    Initialize *InitializeStep

    // Serializes the prepared input into a data structure that can be consumed
    // by the target transport's message, (e.g. REST-JSON serialization)
    //
    // Converts Input Parameters into a Request, and returns the result or error.
    //
    // Receives result or error from Build step.
    Serialize *SerializeStep

    // Adds additional metadata to the serialized transport message,
    // (e.g. HTTP's Content-Length header, or body checksum). Decorations and
    // modifications to the message should be copied to all message attempts.
    //
    // Takes Request, and returns result or error.
    //
    // Receives result or error from Finalize step.
    Build *BuildStep

    // Preforms final preparations needed before sending the message. The
    // message should already be complete by this stage, and is only alternated
    // to meet the expectations of the recipient, (e.g. Retry and AWS SigV4
    // request signing)
    //
    // Takes Request, and returns result or error.
    //
    // Receives result or error from Deserialize step.
    Finalize *FinalizeStep

    // Reacts to the handler's response returned by the recipient of the request
    // message. Deserializes the response into a structured type or error above
    // stacks can react to.
    //
    // Should only forward Request to underlying handler.
    //
    // Takes Request, and returns result or error.
    //
    // Receives raw response, or error from underlying handler.
    Deserialize *DeserializeStep
    // contains filtered or unexported fields
}

Stack provides protocol and transport agnostic set of middleware split into distinct steps. Steps have specific transitions between them, that is managed by the individual step.

Steps are composed as middleware around the underlying handler in the following order:

Initialize -> Serialize -> Build -> Finalize -> Deserialize -> Handler

Any middleware within the chain may chose to stop and return an error or response. Since the middleware decorate the handler like a call stack, each middleware will receive the result of the next middleware in the chain. Middleware that does not need to react to an input, or result must forward along the input down the chain, or return the result back up the chain.

Initialize <- Serialize -> Build -> Finalize <- Deserialize <- Handler

func NewStack Uses

func NewStack(id string, newRequestFn func() interface{}) *Stack

NewStack returns an initialize empty stack.

func (*Stack) HandleMiddleware Uses

func (s *Stack) HandleMiddleware(ctx context.Context, input interface{}, next Handler) (
    output interface{}, metadata Metadata, err error,
)

HandleMiddleware invokes the middleware stack decorating the next handler. Each step of stack will be invoked in order before calling the next step. With the next handler call last.

The input value must be the input parameters of the operation being performed.

Will return the result of the operation, or error.

func (*Stack) ID Uses

func (s *Stack) ID() string

ID returns the unique ID for the stack as a middleware.

func (*Stack) List Uses

func (s *Stack) List() []string

List returns a list of all middleware in the stack by step.

func (*Stack) String Uses

func (s *Stack) String() string

Package middleware imports 5 packages (graph) and is imported by 412 packages. Updated 2020-11-06. Refresh now. Tools for package owners.