server

Documentation

Index

• func AboutAboutPath() string
• func DecodeAboutRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)
• func EncodeAboutError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, ...) func(context.Context, http.ResponseWriter, error) error
• func EncodeAboutResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
• func HandleAboutOrigin(h http.Handler) http.Handler
• func Mount(mux goahttp.Muxer, h *Server)
• func MountAboutHandler(mux goahttp.Muxer, h http.Handler)
• func MountCORSHandler(mux goahttp.Muxer, h http.Handler)
• func NewAboutHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewAboutPayload(token *string) *about.AboutPayload
• func NewCORSHandler() http.Handler
• type AboutResponseBody
  • func NewAboutResponseBody(res *aboutviews.EnduroAboutView) *AboutResponseBody
• type EnduroPoststorageResponseBody
• type EnduroPoststorageResponseBodyCollection
• type EnduroPreprocessingResponseBody
• type MountPoint
• type Server
  • func New(e *about.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) MethodNames() []string
  • func (s *Server) Mount(mux goahttp.Muxer)
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func AboutAboutPath

func AboutAboutPath() string

AboutAboutPath returns the URL path to the about service about HTTP endpoint.

func DecodeAboutRequest

func DecodeAboutRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeAboutRequest returns a decoder for requests sent to the about about endpoint.

func EncodeAboutError

func EncodeAboutError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeAboutError returns an encoder for errors returned by the about about endpoint.

func EncodeAboutResponse

func EncodeAboutResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeAboutResponse returns an encoder for responses returned by the about about endpoint.

func HandleAboutOrigin

func HandleAboutOrigin(h http.Handler) http.Handler

HandleAboutOrigin applies the CORS response headers corresponding to the origin for the service about.

func Mount

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the about endpoints.

func MountAboutHandler

func MountAboutHandler(mux goahttp.Muxer, h http.Handler)

MountAboutHandler configures the mux to serve the "about" service "about" endpoint.

func MountCORSHandler

func MountCORSHandler(mux goahttp.Muxer, h http.Handler)

MountCORSHandler configures the mux to serve the CORS endpoints for the service about.

func NewAboutHandler

func NewAboutHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewAboutHandler creates a HTTP handler which loads the HTTP request and calls the "about" service "about" endpoint.

func NewAboutPayload

func NewAboutPayload(token *string) *about.AboutPayload

NewAboutPayload builds a about service about endpoint payload.

func NewCORSHandler

func NewCORSHandler() http.Handler

NewCORSHandler creates a HTTP handler which returns a simple 204 response.

Types

type AboutResponseBody

type AboutResponseBody struct {
	Version            string                                  `form:"version" json:"version" xml:"version"`
	PreservationSystem string                                  `form:"preservation_system" json:"preservation_system" xml:"preservation_system"`
	Preprocessing      *EnduroPreprocessingResponseBody        `form:"preprocessing" json:"preprocessing" xml:"preprocessing"`
	Poststorage        EnduroPoststorageResponseBodyCollection `form:"poststorage,omitempty" json:"poststorage,omitempty" xml:"poststorage,omitempty"`
}

AboutResponseBody is the type of the "about" service "about" endpoint HTTP response body.

func NewAboutResponseBody

func NewAboutResponseBody(res *aboutviews.EnduroAboutView) *AboutResponseBody

NewAboutResponseBody builds the HTTP response body from the result of the "about" endpoint of the "about" service.

type EnduroPoststorageResponseBody

type EnduroPoststorageResponseBody struct {
	WorkflowName string `form:"workflow_name" json:"workflow_name" xml:"workflow_name"`
	TaskQueue    string `form:"task_queue" json:"task_queue" xml:"task_queue"`
}

EnduroPoststorageResponseBody is used to define fields on response body types.

type EnduroPoststorageResponseBodyCollection

type EnduroPoststorageResponseBodyCollection []*EnduroPoststorageResponseBody

EnduroPoststorageResponseBodyCollection is used to define fields on response body types.

type EnduroPreprocessingResponseBody

type EnduroPreprocessingResponseBody struct {
	Enabled      bool   `form:"enabled" json:"enabled" xml:"enabled"`
	WorkflowName string `form:"workflow_name" json:"workflow_name" xml:"workflow_name"`
	TaskQueue    string `form:"task_queue" json:"task_queue" xml:"task_queue"`
}

EnduroPreprocessingResponseBody is used to define fields on response body types.

type MountPoint

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type Server

type Server struct {
	Mounts []*MountPoint
	About  http.Handler
	CORS   http.Handler
}

Server lists the about service endpoint HTTP handlers.

func New

func New(
	e *about.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the about service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) MethodNames

func (s *Server) MethodNames() []string

MethodNames returns the methods served.

func (*Server) Mount

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the about endpoints.

func (*Server) Service

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.