icchttp

Documentation

Overview

Package icchttp contains helper function to handle http requests.

The handers are defined by its own package (icc, applause...).

Index

• Constants
• func AuthMiddleware(next http.Handler, auth Authenticater) http.Handler
• func Error(w http.ResponseWriter, err error)
• func ErrorNoStatus(w io.Writer, err error)
• func HandleHealth(mux *http.ServeMux)
• func HealthClient(ctx context.Context, useHTTPS bool, host, port string, insecure bool) error
• type Authenticater

Constants

const (
	// Path is the basic path for all handlers of this service.
	Path = "/system/icc"
)

Functions

func AuthMiddleware

func AuthMiddleware(next http.Handler, auth Authenticater) http.Handler

AuthMiddleware checks the user id of the request.

func Error

func Error(w http.ResponseWriter, err error)

Error sends an error message to the client as json-message.

If the error does not have a Type() string message, it is handled as 500er. In other case, it is handled as 400er.

func ErrorNoStatus

func ErrorNoStatus(w io.Writer, err error)

ErrorNoStatus is like Error(), but does not write a status message.

func HandleHealth

func HandleHealth(mux *http.ServeMux)

HandleHealth returns 200 (if the service is running).

func HealthClient

func HealthClient(ctx context.Context, useHTTPS bool, host, port string, insecure bool) error

HealthClient sends a http request to a server to fetch the health status.

Types

type Authenticater

type Authenticater interface {
	Authenticate(http.ResponseWriter, *http.Request) (context.Context, error)
	FromContext(context.Context) int
}

Authenticater knowns how to authenticate a request.