http

Documentation

Index

• Constants
• type CORSConfig
• type Config
  • func (c *Config) Validate() error
• type RequestHandler
• type Service
  • func New(ctx context.Context, serviceName string, config Config, ...) (*Service, error)
  • func (s *Service) Address() string
  • func (s *Service) Serve() error
  • func (s *Service) Shutdown() error
• type UIConfig
  • func (c *UIConfig) Validate() error
• type WebConfigurationConfig

Constants

const (
	UseCacheQueryKey              = "useCache"
	UseMulticastQueryKey          = "useMulticast"
	UseEndpointsQueryKey          = "useEndpoints"
	TimeoutQueryKey               = "timeout"
	OwnershipStatusFilterQueryKey = "ownershipStatusFilter"
	TypeFilterQueryKey            = "typeFilter"
)

const (
	DeviceIDKey          = "deviceId"
	ResourceHrefKey      = "resourceHref"
	ResourcesPathKey     = "resources"
	ResourceLinksPathKey = "resource-links"

	ApplicationProtoJsonContentType = "application/protojson"
	ApplicationJsonContentType      = "application/json"

	Api   = "/api"
	ApiV1 = Api + "/v1"

	Devices             = ApiV1 + "/devices"
	Device              = Devices + "/{" + DeviceIDKey + "}"
	DeviceResourceLinks = Devices + "/{" + DeviceIDKey + "}/" + ResourceLinksPathKey
	DeviceResourceLink  = DeviceResourceLinks + "/{" + ResourceHrefKey + "}"
	DeviceResources     = Device + "/" + ResourcesPathKey
	DeviceResource      = DeviceResources + "/{" + ResourceHrefKey + "}"
	OwnDevice           = Device + "/own"
	DisownDevice        = Device + "/disown"
	WebConfiguration    = "/web_configuration.json"
)

HTTP Service URIs.

Types

type CORSConfig

type CORSConfig struct {
	AllowedOrigins   []string `yaml:"allowedOrigins"  json:"allowedOrigins"`
	AllowedHeaders   []string `yaml:"allowedHeaders"  json:"allowedHeaders"`
	AllowedMethods   []string `yaml:"allowedMethods"  json:"allowedMethods"`
	AllowCredentials bool     `yaml:"allowCredentials"  json:"allowCredentials"`
}

type Config

type Config struct {
	listener.Config `yaml:",inline"`
	CORS            CORSConfig `yaml:"cors"  json:"cors"`
	UI              UIConfig   `yaml:"ui" json:"ui"`
}

func (*Config) Validate

func (c *Config) Validate() error

type RequestHandler

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

type Service

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

func New

func New(ctx context.Context, serviceName string, config Config, clientApplicationServer *grpc.ClientApplicationServer, logger log.Logger, tracerProvider trace.TracerProvider) (*Service, error)

New creates new HTTP service

func (*Service) Address

func (s *Service) Address() string

func (*Service) Serve

func (s *Service) Serve() error

Serve starts the service's HTTP server and blocks

func (*Service) Shutdown

func (s *Service) Shutdown() error

Shutdown ends serving

type UIConfig

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

func (*UIConfig) Validate

func (c *UIConfig) Validate() error

type WebConfigurationConfig

type WebConfigurationConfig struct {
	HTTPGatewayAddress string `yaml:"httpGatewayAddress" json:"httpGatewayAddress"`
}

WebConfiguration represents web configuration for user interface