web

Documentation

Index

• func NewAuthorizer(env *conf.Config, logger *zap.SugaredLogger, core *security.ServiceCore) func(logger *zap.SugaredLogger, scopes ...string) echo.MiddlewareFunc
• func NewStatusHandler(e *echo.Echo, port string)
• func RegisterContentHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, ...)
• func RegisterDatasetHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, dm *server.DsManager, ...)
• func RegisterJobOperationHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, js *jobs.Scheduler)
• func RegisterJobsHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, js *jobs.Scheduler)
• func RegisterNamespaceHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, store *server.Store)
• func RegisterProviderHandler(e *echo.Echo, log *zap.SugaredLogger, mw *Middleware, ...)
• func RegisterQueryHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, store *server.Store, ...)
• func RegisterSecurityHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, ...)
• func RegisterTxnHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, store *server.Store)
• type EmptyEntity
• type Filter
• type HTTPQueryResponseWriter
  • func NewHTTPQueryResponseWriter(context echo.Context) *HTTPQueryResponseWriter
  • func (w *HTTPQueryResponseWriter) WriteObject(object interface{}) error
• type Handler
• type Hop
• type JavascriptQuery
• type JobResponse
• type JsonLdRef
• type Middleware
  • func NewMiddleware(env *conf.Config, e *echo.Echo, core *security.ServiceCore, ...) *Middleware
• type NamespacePrefix
• type Query
• type ServiceContext
• type ServiceInfo
• type Template
  • func (t *Template) Render(w io.Writer, name string, data interface{}, c echo.Context) error
• type TokenResponse
• type WebService
  • func NewWebService(serviceContext *ServiceContext) (*WebService, error)
  • func (ws *WebService) Start(ctx context.Context) error
  • func (ws *WebService) Stop(ctx context.Context) error

Functions

func NewAuthorizer

func NewAuthorizer(env *conf.Config, logger *zap.SugaredLogger, core *security.ServiceCore) func(logger *zap.SugaredLogger, scopes ...string) echo.MiddlewareFunc

func NewStatusHandler

func NewStatusHandler(e *echo.Echo, port string)

func RegisterContentHandler

func RegisterContentHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	content *content.Service,
)

func RegisterDatasetHandler

func RegisterDatasetHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	dm *server.DsManager,
	store *server.Store,
	eb server.EventBus,
	tokenProviders *security.TokenProviders,
)

func RegisterJobOperationHandler

func RegisterJobOperationHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	js *jobs.Scheduler,
)

func RegisterJobsHandler

func RegisterJobsHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, js *jobs.Scheduler)

func RegisterNamespaceHandler

func RegisterNamespaceHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	store *server.Store,
)

func RegisterProviderHandler

func RegisterProviderHandler(
	e *echo.Echo,
	log *zap.SugaredLogger,
	mw *Middleware,
	tokenProviders *security.TokenProviders,
)

func RegisterQueryHandler

func RegisterQueryHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	store *server.Store,
	datasetManager *server.DsManager,
)

func RegisterSecurityHandler

func RegisterSecurityHandler(
	e *echo.Echo,
	logger *zap.SugaredLogger,
	mw *Middleware,
	core *security.ServiceCore,
)

func RegisterTxnHandler

func RegisterTxnHandler(e *echo.Echo, logger *zap.SugaredLogger, mw *Middleware, store *server.Store)

Types

type EmptyEntity

type EmptyEntity struct {
	ID string `json:"id"`
}

type Filter

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

type HTTPQueryResponseWriter

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

Implements interface for query response writer

func NewHTTPQueryResponseWriter

func NewHTTPQueryResponseWriter(context echo.Context) *HTTPQueryResponseWriter

func (*HTTPQueryResponseWriter) WriteObject

func (w *HTTPQueryResponseWriter) WriteObject(object interface{}) error

type Handler

type Handler struct {
	Logger         *zap.SugaredLogger
	Port           string
	Store          *server.Store
	JobScheduler   *jobs.Scheduler
	ContentConfig  *content.Service
	StatsDClient   statsd.ClientInterface
	DatasetManager *server.DsManager
	EventBus       server.EventBus
	Profile        string
}

type Hop

type Hop struct {
	Select []string
	// contains filtered or unexported fields
}

type JavascriptQuery

type JavascriptQuery struct {
	Query string `json:"query"`
}

type JobResponse

type JobResponse struct {
	JobID string `json:"jobId"`
}

type JsonLdRef

type JsonLdRef struct {
	ID string `json:"@id"`
}

type Middleware

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

func NewMiddleware

func NewMiddleware(env *conf.Config, e *echo.Echo, core *security.ServiceCore, logger *zap.SugaredLogger, statsd statsd.ClientInterface) *Middleware

type NamespacePrefix

type NamespacePrefix struct {
	Prefix    string `json:"prefix"`
	Expansion string `json:"expansion"`
}

type Query

type Query struct {
	EntityID         string   `json:"entityId"`
	StartingEntities []string `json:"startingEntities"`
	Predicate        string   `json:"predicate"`
	Inverse          bool     `json:"inverse"`
	Datasets         []string `json:"datasets"`
	Details          bool     `json:"details"`
	Limit            int      `json:"limit"`
	Continuations    []string `json:"continuations"`
	NoPartialMerging bool     `json:"noPartialMerging"`
}

type ServiceContext

type ServiceContext struct {
	Env            *conf.Config
	Logger         *zap.SugaredLogger
	Statsd         statsd.ClientInterface
	SecurityCore   *security.ServiceCore
	ContentService *content.Service
	DatasetManager *server.DsManager
	Store          *server.Store
	EventBus       server.EventBus
	TokenProviders *security.TokenProviders
	JobsScheduler  *jobs.Scheduler
	Port           string
}

ServiceContext is the injection of all deps grouped nicely together expectation is that this can become an interface and also the things it contains should provide interfaces and not structs with funcs

type ServiceInfo

type ServiceInfo struct {
	Name     string `json:"name"`
	Location string `json:"location"`
}

type Template

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

func (*Template) Render

func (t *Template) Render(w io.Writer, name string, data interface{}, c echo.Context) error

type TokenResponse

type TokenResponse struct {
	AccessToken string `json:"access_token"`
	TokenType   string `json:"token_type"`
}

TokenResponse is a OAuth2 JWT Token Response

type WebService

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

func NewWebService

func NewWebService(serviceContext *ServiceContext) (*WebService, error)

func (*WebService) Start

func (ws *WebService) Start(ctx context.Context) error

func (*WebService) Stop

func (ws *WebService) Stop(ctx context.Context) error