restserver

type CORSOptions struct {
	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// An origin may contain a wildcard (*) to replace 0 or more characters
	// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penalty.
	// Only one wildcard can be used per origin.
	// Default value is ["*"]
	AllowedOrigins []string
	// AllowOriginFunc is a custom function to validate the origin. It take the origin
	// as argument and returns true if allowed or false otherwise. If this option is
	// set, the content of AllowedOrigins is ignored.
	AllowOriginFunc func(origin string) bool
	// AllowOriginRequestFunc is a custom function to validate the origin. It takes the HTTP Request object and the
	// origin as argument and returns true if allowed or false otherwise. If this option is set, the content of
	// `AllowedOrigins` and `AllowOriginFunc` is ignored.
	AllowOriginRequestFunc func(r *http.Request, origin string) bool
	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (HEAD, GET and POST).
	AllowedMethods []string
	// AllowedHeaders is list of non simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string
	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string
	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge int
	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool
	// OptionsPassthrough instructs preflight to let other potential next handlers to
	// process the OPTIONS method. Turn this on if your application handles OPTIONS.
	OptionsPassthrough bool
	// Debugging flag adds additional output to debug server side CORS issues
	Debug bool
}

type Config interface {
	// GetServerName provides name of the server: WebAPI|Admin etc
	GetServerName() string
	// GetBindAddr provides the address that the HTTPS server should be listening on
	GetBindAddr() string
	// GetPublicURL is the FQ name of the VIP to the cluster that clients use to connect
	GetPublicURL() string
	// GetServices returns the names of services to enable for this HTTP server
	GetServices() []string
}

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

type Handle func(http.ResponseWriter, *http.Request, Params)

type MuxFactory interface {
	// NewMux builds and returns the root handler.
	NewMux() http.Handler
}

type Params httprouter.Params

type Router interface {
	// Handler returns the http.Handler serving the registered routes,
	// wrapped with CORS when the router was created with NewRouterWithCORS.
	Handler() http.Handler
	// GET registers handle for GET requests to path.
	GET(path string, handle Handle)
	// HEAD registers handle for HEAD requests to path.
	HEAD(path string, handle Handle)
	// OPTIONS registers handle for OPTIONS requests to path.
	OPTIONS(path string, handle Handle)
	// POST registers handle for POST requests to path.
	POST(path string, handle Handle)
	// PUT registers handle for PUT requests to path.
	PUT(path string, handle Handle)
	// PATCH registers handle for PATCH requests to path.
	PATCH(path string, handle Handle)
	// DELETE registers handle for DELETE requests to path.
	DELETE(path string, handle Handle)
	// CONNECT registers handle for CONNECT requests to path.
	CONNECT(path string, handle Handle)
}

type Server interface {
	http.Handler
	// Name returns the configured server name (Config.GetServerName).
	Name() string
	// Version returns the version string passed to New.
	Version() string
	// HostName returns the host part of the bind address, or the OS hostname.
	HostName() string
	// LocalIP returns the IP address passed to New, or the auto-detected local IP.
	LocalIP() string
	// Port returns the port part of the bind address.
	Port() string
	// Protocol returns "https" when a TLS config is set, "http" otherwise.
	Protocol() string
	// PublicURL returns Config.GetPublicURL.
	PublicURL() string
	// StartedAt returns the UTC time the server instance was created.
	StartedAt() time.Time
	// Service returns a registered service by name, or nil.
	Service(name string) Service
	// Config returns the server configuration.
	Config() Config
	// TLSConfig returns the TLS configuration, or nil for plain HTTP.
	TLSConfig() *tls.Config

	// IsReady indicates that the server is serving and all services are ready to serve
	IsReady() bool

	// AddService registers a service; it must be called before StartHTTP.
	AddService(s Service)
	// StartHTTP starts serving in a background goroutine.
	StartHTTP() error
	// StopHTTP drains requests, then closes services and the listener.
	StopHTTP()

	// OnEvent registers a handler for a lifecycle event.
	OnEvent(evt ServerEvent, handler ServerEventFunc)
}

type ServerEvent int

type ServerEventFunc func(evt ServerEvent)

type Service interface {
	// Name returns the unique service name used for registration and lookup.
	Name() string
	// Register adds the service's routes to the router.
	Register(Router)
	// Close releases the service's resources after StopHTTP drains requests.
	// It is called once, even when the shutdown deadline expires.
	Close()
	// IsReady indicates that service is ready to serve its end-points;
	// while any service returns false the server answers 503 to all requests.
	IsReady() bool
}

type TLSInfoConfig interface {
	// GetCertFile returns location of the cert
	GetCertFile() string
	// GetKeyFile returns location of the key
	GetKeyFile() string
	// GetTrustedCAFile specifies location of the Trusted CA file
	GetTrustedCAFile() string
	// GetClientCAFile specifies location of the client CA bundle file
	GetClientCAFile() string
	// GetClientCertAuth controls client auth
	GetClientCertAuth() *bool
}