restapi

Documentation

Index

• type Server
  • func New(repo configrepo.Repo, address string, securityEnabled bool) *Server
  • func (s *Server) CheckToken(ctx iris.Context, app *configrepo.ApplicationVersion) error
  • func (s *Server) IsSecurityEnabled() bool
  • func (s *Server) StartNoTLS() error
  • func (s *Server) StartTLS(certFile, keyFile string) error
  • func (s *Server) Stop()

Types

type Server

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

Server represent a rest server

func New

func New(repo configrepo.Repo, address string, securityEnabled bool) *Server

New instantiate a REST server

func (*Server) CheckToken

func (s *Server) CheckToken(ctx iris.Context, app *configrepo.ApplicationVersion) error

CheckToken check if a valid auth token is present on the request

http headers: Authorization and X-Config-Token

func (*Server) IsSecurityEnabled

func (s *Server) IsSecurityEnabled() bool

IsSecurityEnabled returns if the security is enabled or not

func (*Server) StartNoTLS

func (s *Server) StartNoTLS() error

StartNoTLS starts a NON TLS listener

func (*Server) StartTLS

func (s *Server) StartTLS(certFile, keyFile string) error

StartTLS starts a TLS listener

func (*Server) Stop

func (s *Server) Stop()

Stop stops the REST listener