apiserver

type CharmsHTTPHandler ¶

type CharmsHTTPHandler struct {
	PostHandler FailableHandlerFunc
	GetHandler  FailableHandlerFunc
}

CharmsHTTPHandler creates is a http.Handler which serves POST requests to a PostHandler and GET requests to a GetHandler.

TODO(katco): This is the beginning of inverting the dependencies in this callstack by splitting out the serving mechanism from the modules that are processing the requests. The next step is to publically expose construction of a suitable PostHandler and GetHandler whose goals should be clearly called out in their names, (e.g. charmPersitAPI for POSTs).

To accomplish this, we'll have to make the httpContext type public so that we can pass it into these public functions.

After we do this, we can then test the individual funcs/structs without standing up an entire HTTP server. I.e. actual unit tests. If you're in this area and can, please chissle away at this problem and update this TODO as needed! Many thanks, hacker!

func (h *CharmsHTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type EntitiesWatcher ¶

type EntitiesWatcher interface {
	state.StringsWatcher

	// MapChanges maps the received strings to their according tag strings.
	// The EntityFinder interface representing state or a mock has to be
	// upcasted into the needed sub-interface of state for the real mapping.
	MapChanges(in []string) ([]string, error)
}

EntitiesWatcher defines an interface based on the StringsWatcher but also providing a method for the mapping of the received strings to the tags of the according entities.

type FailableHandlerFunc ¶

type FailableHandlerFunc func(http.ResponseWriter, *http.Request) error

type LoginValidator ¶

type LoginValidator func(params.LoginRequest) error

LoginValidator functions are used to decide whether login requests are to be allowed. The validator is called before credentials are checked.

type Pinger ¶

type Pinger interface {
	Ping()
	Stop() error
}

pinger describes a resource that can be pinged and stopped.

func NewPinger(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (Pinger, error)

type Server ¶

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

Server holds the server side of the API.

func NewServer(s *state.State, lis net.Listener, cfg ServerConfig) (*Server, error)

func (srv *Server) ConnectionCount() int64

func (srv *Server) Dead() <-chan struct{}

func (srv *Server) Kill()

func (srv *Server) Stop() error

func (srv *Server) Wait() error

type ServerConfig ¶

type ServerConfig struct {
	Clock       clock.Clock
	PingClock   clock.Clock
	Cert        string
	Key         string
	Tag         names.Tag
	DataDir     string
	LogDir      string
	Validator   LoginValidator
	CertChanged <-chan params.StateServingInfo

	// AutocertDNSName holds the DNS name for which
	// official TLS certificates will be obtained. If this is
	// empty, no certificates will be requested.
	AutocertDNSName string

	// AutocertURL holds the URL from which official
	// TLS certificates will be obtained. By default,
	// acme.LetsEncryptURL will be used.
	AutocertURL string

	// AllowModelAccess holds whether users will be allowed to
	// access models that they have access rights to even when
	// they don't have access to the controller.
	AllowModelAccess bool

	// NewObserver is a function which will return an observer. This
	// is used per-connection to instantiate a new observer to be
	// notified of key events during API requests.
	NewObserver observer.ObserverFactory

	// StatePool only exists to support testing.
	StatePool *state.StatePool
}

ServerConfig holds parameters required to set up an API server.

func (c *ServerConfig) Validate() error

type SrvAllWatcher ¶

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

SrvAllWatcher defines the API methods on a state.Multiwatcher. which watches any changes to the state. Each client has its own current set of watchers, stored in resources. It is used by both the AllWatcher and AllModelWatcher facades.

func (aw *SrvAllWatcher) Next() (params.AllWatcherNextResults, error)

func (w *SrvAllWatcher) Stop() error