http

Documentation

Index

• Constants
• func FinishInitialize(state string) string
• type RequestHandler
• type Service
  • func New(ctx context.Context, serviceName string, config configHttp.Config, ...) (*Service, error)
  • func (s *Service) Address() string
  • func (s *Service) Close() error
  • func (s *Service) Serve() error

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"
	WellKnown = "/.well-known"
	Identity  = ApiV1 + "/identity"

	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"
	OnboardDevice       = Device + "/onboard"
	OffboardDevice      = Device + "/offboard"

	Initialize             = ApiV1 + "/initialize"
	Reset                  = ApiV1 + "/reset"
	IdentityCertificate    = Identity + "/certificate"
	WellKnownJWKs          = WellKnown + "/jwks.json"
	WellKnownConfiguration = WellKnown + "/configuration"
)

HTTP Service URIs.

Functions

func FinishInitialize

func FinishInitialize(state string) string

Types

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 configHttp.Config, clientApplicationServer *grpc.ClientApplicationServer, fileWatcher *fsnotify.Watcher, logger pkgLog.Logger, tracerProvider trace.TracerProvider) (*Service, error)

New creates new HTTP service

func (*Service) Address

func (s *Service) Address() string

func (*Service) Close

func (s *Service) Close() error

Close serving

func (*Service) Serve

func (s *Service) Serve() error

Serve starts the service's HTTP server and blocks