services

Documentation

Index

• type ApiService
  • func New(c Config) *ApiService
  • func (server *ApiService) DynamoServices(db dboperations.IDbOperations, c *fiber.Ctx) *omnitruck.DynamoServices
  • func (server *ApiService) HealthCheck(c *fiber.Ctx) error
  • func (server *ApiService) Initialize(c Config) *ApiService
  • func (server *ApiService) JSON(c *fiber.Ctx, data interface{}) error
  • func (server *ApiService) Omnitruck(c *fiber.Ctx) *omnitruck.Omnitruck
  • func (server *ApiService) PlatformServices(c *fiber.Ctx) *omnitruck.PlatformServices
  • func (server *ApiService) ReplicatedService(config config.ReplicatedConfig, log logrus.Logger) replicated.IReplicated
  • func (server *ApiService) SendError(c *fiber.Ctx, request *clients.Request) error
  • func (server *ApiService) SendErrorResponse(c *fiber.Ctx, code int, msg string) error
  • func (server *ApiService) SendResponse(c *fiber.Ctx, data interface{}) error
  • func (server *ApiService) Start(wg *sync.WaitGroup) error
  • func (server *ApiService) StartService()
  • func (server *ApiService) ValidateRequest(params *omnitruck.RequestParams, c *fiber.Ctx) (error, bool)
• type ApiType
• type Config
• type ErrorResponse
• type Service

Types

type ApiService

type ApiService struct {
	sync.Mutex
	Config           Config
	Log              *log.Entry
	App              *fiber.App
	Validator        omnitruck.RequestValidator
	Mode             ApiType
	DatabaseService  dboperations.IDbOperations
	TemplateRenderer template.TemplateRender
	Replicated       replicated.IReplicated
	LicenseClient    clients.ILicense
}

func New

func New(c Config) *ApiService

func (*ApiService) DynamoServices

func (server *ApiService) DynamoServices(db dboperations.IDbOperations, c *fiber.Ctx) *omnitruck.DynamoServices

func (*ApiService) HealthCheck

func (server *ApiService) HealthCheck(c *fiber.Ctx) error

func (*ApiService) Initialize

func (server *ApiService) Initialize(c Config) *ApiService

func (*ApiService) JSON

func (server *ApiService) JSON(c *fiber.Ctx, data interface{}) error

func (*ApiService) Omnitruck

func (server *ApiService) Omnitruck(c *fiber.Ctx) *omnitruck.Omnitruck

func (*ApiService) PlatformServices

func (server *ApiService) PlatformServices(c *fiber.Ctx) *omnitruck.PlatformServices

func (*ApiService) ReplicatedService

func (server *ApiService) ReplicatedService(config config.ReplicatedConfig, log logrus.Logger) replicated.IReplicated

func (*ApiService) SendError

func (server *ApiService) SendError(c *fiber.Ctx, request *clients.Request) error

func (*ApiService) SendErrorResponse

func (server *ApiService) SendErrorResponse(c *fiber.Ctx, code int, msg string) error

func (*ApiService) SendResponse

func (server *ApiService) SendResponse(c *fiber.Ctx, data interface{}) error

func (*ApiService) Start

func (server *ApiService) Start(wg *sync.WaitGroup) error

func (*ApiService) StartService

func (server *ApiService) StartService()

func (*ApiService) ValidateRequest

func (server *ApiService) ValidateRequest(params *omnitruck.RequestParams, c *fiber.Ctx) (error, bool)

type ApiType

type ApiType int

const (
	Trial ApiType = iota
	Opensource
	Commercial
)

type Config

type Config struct {
	Name          string
	Listen        string
	Log           *log.Entry
	Mode          ApiType
	ServiceConfig config.ServiceConfig
}

type ErrorResponse

type ErrorResponse struct {
	Code       int    `json:"code"`
	StatusText string `json:"status_text"`
	Message    string `json:"message"`

} //@name ErrorResponse

type Service

type Service interface {
	Name() string
	Start(*sync.WaitGroup) error
	Stop() error
}