web_server

Documentation

Index

• func WebHandleWrapper(handler WebHandler, newRequestFunc NewWebRequestFunc) gin.HandlerFunc
• type CreateDbRequest
  • func (r *CreateDbRequest) AuthRequired() bool
  • func (r *CreateDbRequest) GetName() string
  • func (r *CreateDbRequest) Process(c *gin.Context, handler WebHandler)
  • func (r *CreateDbRequest) Resources() []string
  • func (r *CreateDbRequest) Scopes() []string
• type DbHandler
  • func NewDbHandler(sourceHandler sourceApi.SourceHandler, readyWaiter grpcServerApi.DbReadyWaiter) *DbHandler
  • func (h *DbHandler) GetName() string
• type IsDbReadyRequest
  • func (r *IsDbReadyRequest) AuthRequired() bool
  • func (r *IsDbReadyRequest) GetName() string
  • func (r *IsDbReadyRequest) Process(c *gin.Context, handler WebHandler)
  • func (r *IsDbReadyRequest) Resources() []string
  • func (r *IsDbReadyRequest) Scopes() []string
• type NewWebRequestFunc
• type WebHandler
• type WebRequest
  • func NewCreateDbRequest() WebRequest
  • func NewIsDbReadyRequest() WebRequest
• type WebServer
  • func NewWebServer(config *config.WebConfig) *WebServer
  • func (w *WebServer) Init(setter server.GlobalSetter) error
  • func (w *WebServer) PostInit(getter server.GlobalGetter) error
  • func (w *WebServer) Run()
  • func (w *WebServer) Shutdown(ctx context.Context)

Functions

func WebHandleWrapper

func WebHandleWrapper(handler WebHandler, newRequestFunc NewWebRequestFunc) gin.HandlerFunc

Types

type CreateDbRequest

type CreateDbRequest struct {
	*sourceApi.DatabaseRequest
}

func (*CreateDbRequest) AuthRequired

func (r *CreateDbRequest) AuthRequired() bool

func (*CreateDbRequest) GetName

func (r *CreateDbRequest) GetName() string

func (*CreateDbRequest) Process

func (r *CreateDbRequest) Process(c *gin.Context, handler WebHandler)

func (*CreateDbRequest) Resources

func (r *CreateDbRequest) Resources() []string

func (*CreateDbRequest) Scopes

func (r *CreateDbRequest) Scopes() []string

type DbHandler

type DbHandler struct {
	SourceHandler sourceApi.SourceHandler
	ReadyWaiter   grpcServerApi.DbReadyWaiter
}

func NewDbHandler

func NewDbHandler(sourceHandler sourceApi.SourceHandler, readyWaiter grpcServerApi.DbReadyWaiter) *DbHandler

func (*DbHandler) GetName

func (h *DbHandler) GetName() string

type IsDbReadyRequest

type IsDbReadyRequest struct {
	Name         string `form:"name" json:"name" binding:"max=63,id"`
	InstanceName string `form:"instance_name" json:"instance_name" binding:"max=63,iname"`
}

func (*IsDbReadyRequest) AuthRequired

func (r *IsDbReadyRequest) AuthRequired() bool

func (*IsDbReadyRequest) GetName

func (r *IsDbReadyRequest) GetName() string

func (*IsDbReadyRequest) Process

func (r *IsDbReadyRequest) Process(c *gin.Context, handler WebHandler)

func (*IsDbReadyRequest) Resources

func (r *IsDbReadyRequest) Resources() []string

func (*IsDbReadyRequest) Scopes

func (r *IsDbReadyRequest) Scopes() []string

type NewWebRequestFunc

type NewWebRequestFunc func() WebRequest

type WebHandler

type WebHandler interface {
	GetName() string
}

type WebRequest

type WebRequest interface {
	GetName() string

	Scopes() []string
	Resources() []string
	AuthRequired() bool

	Process(c *gin.Context, handler WebHandler)
}

func NewCreateDbRequest

func NewCreateDbRequest() WebRequest

func NewIsDbReadyRequest

func NewIsDbReadyRequest() WebRequest

type WebServer

type WebServer struct {
	Config *config.WebConfig

	Server *http.Server
	Router *gin.Engine
	Auth   *ginAuth.GinAuth
	// contains filtered or unexported fields
}

func NewWebServer

func NewWebServer(config *config.WebConfig) *WebServer

func (*WebServer) Init

func (w *WebServer) Init(setter server.GlobalSetter) error

func (*WebServer) PostInit

func (w *WebServer) PostInit(getter server.GlobalGetter) error

func (*WebServer) Run

func (w *WebServer) Run()

func (*WebServer) Shutdown

func (w *WebServer) Shutdown(ctx context.Context)