middleware

Documentation

Index

• func DebugRequestMiddleware(...) func(ctx context.Context, w http.ResponseWriter, r *http.Request, ...) error
• type CORSMiddleware
  • func NewCORSMiddleware(d string) CORSMiddleware
  • func (c CORSMiddleware) WrapHandler(...) func(ctx context.Context, w http.ResponseWriter, r *http.Request, ...) error
• type ExperimentalMiddleware
  • func NewExperimentalMiddleware(experimentalEnabled bool) ExperimentalMiddleware
  • func (e ExperimentalMiddleware) WrapHandler(...) func(ctx context.Context, w http.ResponseWriter, r *http.Request, ...) error
• type Middleware
• type VersionMiddleware
  • func NewVersionMiddleware(serverVersion, defaultAPIVersion, minAPIVersion string) (*VersionMiddleware, error)
  • func (v VersionMiddleware) WrapHandler(...) func(ctx context.Context, w http.ResponseWriter, r *http.Request, ...) error

Functions

func DebugRequestMiddleware

func DebugRequestMiddleware(handler func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error) func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error

DebugRequestMiddleware dumps the request to logger

Types

type CORSMiddleware

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

CORSMiddleware injects CORS headers to each request when it's configured.

Deprecated: CORS headers should not be set on the API. This feature will be removed in the next release.

func NewCORSMiddleware

func NewCORSMiddleware(d string) CORSMiddleware

NewCORSMiddleware creates a new CORSMiddleware with default headers.

Deprecated: CORS headers should not be set on the API. This feature will be removed in the next release.

func (CORSMiddleware) WrapHandler

func (c CORSMiddleware) WrapHandler(handler func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error) func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error

WrapHandler returns a new handler function wrapping the previous one in the request chain.

type ExperimentalMiddleware

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

ExperimentalMiddleware is a the middleware in charge of adding the 'Docker-Experimental' header to every outgoing request

func NewExperimentalMiddleware

func NewExperimentalMiddleware(experimentalEnabled bool) ExperimentalMiddleware

NewExperimentalMiddleware creates a new ExperimentalMiddleware

func (ExperimentalMiddleware) WrapHandler

func (e ExperimentalMiddleware) WrapHandler(handler func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error) func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error

WrapHandler returns a new handler function wrapping the previous one in the request chain.

type Middleware

type Middleware interface {
	WrapHandler(func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error) func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error
}

Middleware is an interface to allow the use of ordinary functions as Docker API filters. Any struct that has the appropriate signature can be registered as a middleware.

type VersionMiddleware

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

VersionMiddleware is a middleware that validates the client and server versions.

func NewVersionMiddleware

func NewVersionMiddleware(serverVersion, defaultAPIVersion, minAPIVersion string) (*VersionMiddleware, error)

NewVersionMiddleware creates a VersionMiddleware with the given versions.

func (VersionMiddleware) WrapHandler

func (v VersionMiddleware) WrapHandler(handler func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error) func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error

WrapHandler returns a new handler function wrapping the previous one in the request chain.