handler

Documentation

Index

• Constants
• type AccessControl
  • func NewAccessControl(protected http.Handler, list accesscontrol.List) *AccessControl
  • func (a *AccessControl) Child() http.Handler
  • func (a *AccessControl) ServeHTTP(rw http.ResponseWriter, req *http.Request)
  • func (a *AccessControl) String() string
• type BodyLimit
• type Endpoint
  • func NewEndpoint(opts *EndpointOptions, log *logrus.Entry, modifier []hcl.Body) *Endpoint
  • func (e *Endpoint) BodyContext() hcl.Body
  • func (e *Endpoint) BufferOptions() eval.BufferOption
  • func (e *Endpoint) Options() *server.Options
  • func (e *Endpoint) RequestLimit() int64
  • func (e *Endpoint) ServeHTTP(rw http.ResponseWriter, req *http.Request)
  • func (e *Endpoint) String() string
• type EndpointOptions
• type Error
  • func NewErrorHandler(kindsHandler map[string]http.Handler, errTpl *errors.Template) *Error
  • func (e *Error) ServeHTTP(rw http.ResponseWriter, req *http.Request)
• type File
  • func NewFile(docRoot, basePath string, errorTpl *errors.Template, srvOpts *server.Options, ...) (*File, error)
  • func (f *File) HasResponse(req *http.Request) bool
  • func (f *File) Options() *server.Options
  • func (f *File) ServeHTTP(rw http.ResponseWriter, req *http.Request)
  • func (f *File) String() string
  • func (f *File) Template() *errors.Template
• type Health
  • func NewHealthCheck(path string, shutdownCh chan struct{}) *Health
  • func (h *Health) Match(req *http.Request) bool
  • func (h *Health) ServeHTTP(rw http.ResponseWriter, _ *http.Request)
  • func (h *Health) String() string
• type Proxy
  • func NewProxy(backend http.RoundTripper, ctx hcl.Body, logger *logrus.Entry) *Proxy
  • func (p *Proxy) RoundTrip(req *http.Request) (*http.Response, error)
• type Spa
  • func NewSpa(bootstrapFile string, srvOpts *server.Options, modifier []hcl.Body) (*Spa, error)
  • func (s *Spa) Options() *server.Options
  • func (s *Spa) ServeHTTP(rw http.ResponseWriter, req *http.Request)
  • func (s *Spa) String() string

Constants

const DefaultHealthPath = "/healthz"

Types

type AccessControl

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

func NewAccessControl

func NewAccessControl(protected http.Handler, list accesscontrol.List) *AccessControl

func (*AccessControl) Child

func (a *AccessControl) Child() http.Handler

func (*AccessControl) ServeHTTP

func (a *AccessControl) ServeHTTP(rw http.ResponseWriter, req *http.Request)

func (*AccessControl) String

func (a *AccessControl) String() string

type BodyLimit

type BodyLimit interface {
	RequestLimit() int64
	BufferOptions() eval.BufferOption
}

type Endpoint

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

func NewEndpoint

func NewEndpoint(opts *EndpointOptions, log *logrus.Entry, modifier []hcl.Body) *Endpoint

func (*Endpoint) BodyContext

func (e *Endpoint) BodyContext() hcl.Body

BodyContext exposes the current endpoint hcl.Body.

func (*Endpoint) BufferOptions

func (e *Endpoint) BufferOptions() eval.BufferOption

func (*Endpoint) Options

func (e *Endpoint) Options() *server.Options

func (*Endpoint) RequestLimit

func (e *Endpoint) RequestLimit() int64

func (*Endpoint) ServeHTTP

func (e *Endpoint) ServeHTTP(rw http.ResponseWriter, req *http.Request)

func (*Endpoint) String

func (e *Endpoint) String() string

String interface maps to the access log handler field.

type EndpointOptions

type EndpointOptions struct {
	APIName        string
	BufferOpts     eval.BufferOption
	Context        hcl.Body
	ErrorTemplate  *errors.Template
	ErrorHandler   http.Handler
	IsErrorHandler bool
	LogHandlerKind string
	LogPattern     string
	ReqBodyLimit   int64
	ServerOpts     *server.Options

	Proxies   producer.Roundtrip
	Redirect  *producer.Redirect
	Requests  producer.Roundtrip
	Sequences producer.Sequences
	Response  *producer.Response
}

type Error

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

func NewErrorHandler

func NewErrorHandler(kindsHandler map[string]http.Handler, errTpl *errors.Template) *Error

func (*Error) ServeHTTP

func (e *Error) ServeHTTP(rw http.ResponseWriter, req *http.Request)

type File

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

func NewFile

func NewFile(docRoot, basePath string, errorTpl *errors.Template, srvOpts *server.Options, modifier []hcl.Body) (*File, error)

func (*File) HasResponse

func (f *File) HasResponse(req *http.Request) bool

func (*File) Options

func (f *File) Options() *server.Options

func (*File) ServeHTTP

func (f *File) ServeHTTP(rw http.ResponseWriter, req *http.Request)

func (*File) String

func (f *File) String() string

func (*File) Template

func (f *File) Template() *errors.Template

type Health

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

func NewHealthCheck

func NewHealthCheck(path string, shutdownCh chan struct{}) *Health

func (*Health) Match

func (h *Health) Match(req *http.Request) bool

func (*Health) ServeHTTP

func (h *Health) ServeHTTP(rw http.ResponseWriter, _ *http.Request)

func (*Health) String

func (h *Health) String() string

type Proxy

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

Proxy wraps a httputil.ReverseProxy to apply additional configuration context and have control over the roundtrip configuration.

func NewProxy

func NewProxy(backend http.RoundTripper, ctx hcl.Body, logger *logrus.Entry) *Proxy

func (*Proxy) RoundTrip

func (p *Proxy) RoundTrip(req *http.Request) (*http.Response, error)

type Spa

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

func NewSpa

func NewSpa(bootstrapFile string, srvOpts *server.Options, modifier []hcl.Body) (*Spa, error)

func (*Spa) Options

func (s *Spa) Options() *server.Options

func (*Spa) ServeHTTP

func (s *Spa) ServeHTTP(rw http.ResponseWriter, req *http.Request)

func (*Spa) String

func (s *Spa) String() string