common

Documentation

Index

• Constants
• Variables
• func ErrorResponse(code int, msg string, w http.ResponseWriter)
• func ParsePagingParams(page, perPage string, maxPerPage int) (int, int, error)
• func PerItemPagination(_qLimit, _page, _perPage, _numOfSrcs int) ([]int, []int)
• func SupportedAggregate(a string) bool
• func SupportedPeriod(p string) bool
• func SupportedPeriods() []string
• func SupportedType(t string) bool
• func ValidatePagingParams(page, perPage, maxPerPage int) error
• func ValidatePerItemLimit(_qLimit, _perPage, _numOfSrcs int) error
• type AggrConf
• type Config
• type DataBackendConf
• type DataConf
• type Error
• type HTTPConf
• type ObtainerConf
  • func (c ObtainerConf) Validate() error
• type RegBackendConf
• type RegConf
  • func (c RegConf) ConfiguredRetention(period string) bool
• type ServiceCatalogConf
• type ValidatorConf
  • func (c ValidatorConf) Validate() error
• type WebConfig

Constants

const (
	// IDSeparator is used for separation of IDs in the URL
	IDSeparator = ","

	// Location of APIs
	RegistryAPILoc = "/registry"
	DataAPILoc     = "/data"
	AggrAPILoc     = "/aggr"

	// Query parameters
	ParamPage    = "page"
	ParamPerPage = "per_page"
	ParamLimit   = "limit"
	ParamStart   = "start"
	ParamEnd     = "end"
	ParamSort    = "sort"
	// Values for ParamSort
	ASC  = "asc"  // ascending
	DESC = "desc" // descending
)

const (
	STRING = "string"
	FLOAT  = "float"
	BOOL   = "bool"
)

Data source types

Variables

var (
	// APIVersion defines the API version
	APIVersion = "N/A"
	// Default MIME type for all responses
	DefaultMIMEType = "application/json;version=" + APIVersion
)

Functions

func ErrorResponse

func ErrorResponse(code int, msg string, w http.ResponseWriter)

ErrorResponse writes error to HTTP ResponseWriter

func ParsePagingParams

func ParsePagingParams(page, perPage string, maxPerPage int) (int, int, error)

func PerItemPagination

func PerItemPagination(_qLimit, _page, _perPage, _numOfSrcs int) ([]int, []int)

Calculate perItem and offset given the page, perPage, limit, and number of sources

func SupportedAggregate

func SupportedAggregate(a string) bool

SupportedAggregate validates an aggregate

func SupportedPeriod

func SupportedPeriod(p string) bool

SupportedPeriod validates a period

func SupportedPeriods

func SupportedPeriods() []string

SupportedPeriods returns supported periods

func SupportedType

func SupportedType(t string) bool

SupportedType validates a type

func ValidatePagingParams

func ValidatePagingParams(page, perPage, maxPerPage int) error

func ValidatePerItemLimit

func ValidatePerItemLimit(_qLimit, _perPage, _numOfSrcs int) error

Check if the parameters match the criteria required by PerItemPagination function

Types

type AggrConf

type AggrConf struct{}

Aggregation config

type Config

type Config struct {
	// Service ID
	ServiceID string `json:"serviceID"`
	// HDS API addr
	HTTP HTTPConf `json:"http"`
	// Web GUI
	Web WebConfig `json:"web"`
	// Registry API Config
	Reg RegConf `json:"registry"`
	// Data API Config
	Data DataConf `json:"data"`
	// Aggregation API Config
	Aggr AggrConf `json:"aggregation"`
	// LinkSmart Service Catalog registration config
	ServiceCatalog *ServiceCatalogConf `json:"serviceCatalog"`
	// Auth config
	Auth ValidatorConf `json:"auth"`
}

type DataBackendConf

type DataBackendConf struct {
	Type string `json:"type"`
	DSN  string `json:"dsn"`
}

Data backend config

type DataConf

type DataConf struct {
	Backend DataBackendConf `json:"backend"`
	// RetentionPeriods is deprecated, will be removed from v0.6.0. Use registry.retentionPeriods instead.
	RetentionPeriods []string `json:"retentionPeriods"`
	AutoRegistration bool     `json:"autoRegistration"`
}

Data config

type Error

type Error struct {
	// Code is the (http) code of the error
	Code int `json:"code"`
	// Message is the (human-readable) error message
	Message string `json:"message"`
}

Error describes an API error (serializable in JSON)

type HTTPConf

type HTTPConf struct {
	PublicEndpoint string `json:"publicEndpoint"`
	BindAddr       string `json:"bindAddr"`
	BindPort       uint16 `json:"bindPort"`
}

HTTP config

type ObtainerConf

type ObtainerConf struct {
	// Authentication provider name
	Provider string `json:"provider"`
	// Authentication provider URL
	ProviderURL string `json:"providerURL"`
	// Service ID
	ServiceID string `json:"serviceID"`
	// User credentials
	Username string `json:"username"`
	Password string `json:"password"`
}

Ticket Obtainer Client Config

func (ObtainerConf) Validate

func (c ObtainerConf) Validate() error

type RegBackendConf

type RegBackendConf struct {
	Type string `json:"type"`
	DSN  string `json:"dsn"`
}

Registry backend config

type RegConf

type RegConf struct {
	Backend          RegBackendConf `json:"backend"`
	RetentionPeriods []string       `json:"retentionPeriods"`
}

Registry config

func (RegConf) ConfiguredRetention

func (c RegConf) ConfiguredRetention(period string) bool

type ServiceCatalogConf

type ServiceCatalogConf struct {
	Discover bool          `json:"discover"`
	Endpoint string        `json:"endpoint"`
	TTL      uint          `json:"ttl"`
	Auth     *ObtainerConf `json:"auth"`
}

LinkSmart Service Catalog registration config

type ValidatorConf

type ValidatorConf struct {
	// Auth switch
	Enabled bool `json:"enabled"`
	// Authentication provider name
	Provider string `json:"provider"`
	// Authentication provider URL
	ProviderURL string `json:"providerURL"`
	// Service ID
	ServiceID string `json:"serviceID"`
	// Basic Authentication switch
	BasicEnabled bool `json:"basicEnabled"`
	// Authorization config
	Authz *authz.Conf `json:"authorization"`
}

Ticket Validator Config

func (ValidatorConf) Validate

func (c ValidatorConf) Validate() error

type WebConfig

type WebConfig struct {
	BindAddr  string `json:"bindAddr"`
	BindPort  uint16 `json:"bindPort"`
	StaticDir string `json:"staticDir"`
}

Web GUI Config