service

Documentation

Index

• func NewHTTP(requestHandler *RequestHandler, authInterceptor kitHttp.Interceptor) (*http.Server, error)
• type APIsConfig
  • func (c *APIsConfig) Validate() error
• type BasicOAuthClient
  • func (c *BasicOAuthClient) Validate() error
• type ClientsConfig
  • func (c *ClientsConfig) Validate() error
• type Config
  • func (c Config) String() string
  • func (c *Config) Validate() error
• type DeviceOAuthClient
  • func (c *DeviceOAuthClient) Validate() error
• type GrpcServerConfig
  • func (c *GrpcServerConfig) Validate() error
• type HTTPConfig
  • func (c *HTTPConfig) Validate() error
• type RequestHandler
  • func NewRequestHandler(config *Config, client *client.Client) *RequestHandler
  • func (requestHandler *RequestHandler) CancelPendingCommands(w http.ResponseWriter, r *http.Request)
• type Server
  • func New(ctx context.Context, config Config, logger log.Logger) (*Server, error)
  • func (s *Server) Serve() error
  • func (s *Server) Shutdown() error
• type UIConfig
  • func (c *UIConfig) Validate() error
• type WebConfiguration
  • func (c *WebConfiguration) Validate() error
• type WebSocketConfig
  • func (c *WebSocketConfig) Validate() error

Functions

func NewHTTP

func NewHTTP(requestHandler *RequestHandler, authInterceptor kitHttp.Interceptor) (*http.Server, error)

NewHTTP returns HTTP server

Types

type APIsConfig

type APIsConfig struct {
	HTTP HTTPConfig `yaml:"http" json:"http"`
}

Config represent application configuration

func (*APIsConfig) Validate

func (c *APIsConfig) Validate() error

type BasicOAuthClient

type BasicOAuthClient struct {
	ClientID string   `yaml:"clientID" json:"clientId"`
	Audience string   `yaml:"audience" json:"audience"`
	Scopes   []string `yaml:"scopes" json:"scopes"`
}

func (*BasicOAuthClient) Validate

func (c *BasicOAuthClient) Validate() error

type ClientsConfig

type ClientsConfig struct {
	GrpcGateway GrpcServerConfig `yaml:"grpcGateway" json:"grpcGateway"`
}

func (*ClientsConfig) Validate

func (c *ClientsConfig) Validate() error

type Config

type Config struct {
	Log     log.Config    `yaml:"log" json:"log"`
	APIs    APIsConfig    `yaml:"apis" json:"apis"`
	Clients ClientsConfig `yaml:"clients" json:"clients"`
	UI      UIConfig      `yaml:"ui" json:"ui"`
}

func (Config) String

func (c Config) String() string

String return string representation of Config

func (*Config) Validate

func (c *Config) Validate() error

type DeviceOAuthClient

type DeviceOAuthClient struct {
	BasicOAuthClient `yaml:",inline"`
	ProviderName     string `json:"providerName" yaml:"providerName"`
}

func (*DeviceOAuthClient) Validate

func (c *DeviceOAuthClient) Validate() error

type GrpcServerConfig

type GrpcServerConfig struct {
	Connection client.Config `yaml:"grpc" json:"grpc"`
}

func (*GrpcServerConfig) Validate

func (c *GrpcServerConfig) Validate() error

type HTTPConfig

type HTTPConfig struct {
	Connection    listener.Config  `yaml:",inline" json:",inline"`
	WebSocket     WebSocketConfig  `yaml:"webSocket" json:"webSocket"`
	Authorization validator.Config `yaml:"authorization" json:"authorization"`
}

func (*HTTPConfig) Validate

func (c *HTTPConfig) Validate() error

type RequestHandler

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

RequestHandler for handling incoming request

func NewRequestHandler

func NewRequestHandler(config *Config, client *client.Client) *RequestHandler

NewRequestHandler factory for new RequestHandler

func (*RequestHandler) CancelPendingCommands

func (requestHandler *RequestHandler) CancelPendingCommands(w http.ResponseWriter, r *http.Request)

type Server

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

Server handle HTTP request

func New

func New(ctx context.Context, config Config, logger log.Logger) (*Server, error)

New parses configuration and creates new Server with provided store and bus

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the service's HTTP server and blocks

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown ends serving

type UIConfig

type UIConfig struct {
	Enabled          bool             `json:"enabled" yaml:"enabled"`
	Directory        string           `json:"directory" yaml:"directory"`
	WebConfiguration WebConfiguration `json:"webConfiguration" yaml:"webConfiguration"`
}

UIConfig represents user interface configuration

func (*UIConfig) Validate

func (c *UIConfig) Validate() error

type WebConfiguration

type WebConfiguration struct {
	Authority          string            `yaml:"authority" json:"authority"`
	HTTPGatewayAddress string            `yaml:"httpGatewayAddress" json:"httpGatewayAddress"`
	WebOAuthClient     BasicOAuthClient  `yaml:"webOAuthClient" json:"webOauthClient"`
	DeviceOAuthClient  DeviceOAuthClient `yaml:"deviceOAuthClient" json:"deviceOauthClient"`
}

WebConfiguration represents web configuration for user interface exposed via getOAuthConfiguration handler

func (*WebConfiguration) Validate

func (c *WebConfiguration) Validate() error

type WebSocketConfig

type WebSocketConfig struct {
	StreamBodyLimit int           `yaml:"streamBodyLimit" json:"streamBodyLimit"`
	PingFrequency   time.Duration `yaml:"pingFrequency" json:"pingFrequency"`
}

func (*WebSocketConfig) Validate

func (c *WebSocketConfig) Validate() error