api

Documentation

Index

• type Authenticator
• type BaseRouter
  • func (br *BaseRouter) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type DefaultHandler
  • func NewDefaultHandler(ctl core.Interface) *DefaultHandler
  • func (dh *DefaultHandler) HandleCheckStatusReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandleGetJobReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandleGetJobsReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandleJobActionReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandleJobLogReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandleLaunchJobReq(w http.ResponseWriter, req *http.Request)
  • func (dh *DefaultHandler) HandlePeriodicExecutions(w http.ResponseWriter, req *http.Request)
• type Handler
• type Router
  • func NewBaseRouter(handler Handler, authenticator Authenticator) Router
• type SecretAuthenticator
  • func (sa *SecretAuthenticator) DoAuth(req *http.Request) error
• type Server
  • func NewServer(ctx context.Context, router Router, cfg ServerConfig) *Server
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
• type ServerConfig

Types

type Authenticator

type Authenticator interface {
	// Auth incoming request
	//
	// req *http.Request: the incoming request
	//
	// Returns:
	// nil returned if successfully done
	// otherwise an error returned
	DoAuth(req *http.Request) error
}

Authenticator defined behaviors of doing auth checking.

type BaseRouter

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

BaseRouter provides the basic routes for the job service based on the golang http server mux.

func (*BaseRouter) ServeHTTP

func (br *BaseRouter) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP is the implementation of Router interface.

type DefaultHandler

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

DefaultHandler is the default request handler which implements the Handler interface.

func NewDefaultHandler

func NewDefaultHandler(ctl core.Interface) *DefaultHandler

NewDefaultHandler is constructor of DefaultHandler.

func (*DefaultHandler) HandleCheckStatusReq

func (dh *DefaultHandler) HandleCheckStatusReq(w http.ResponseWriter, req *http.Request)

HandleCheckStatusReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandleGetJobReq

func (dh *DefaultHandler) HandleGetJobReq(w http.ResponseWriter, req *http.Request)

HandleGetJobReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandleGetJobsReq

func (dh *DefaultHandler) HandleGetJobsReq(w http.ResponseWriter, req *http.Request)

HandleGetJobsReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandleJobActionReq

func (dh *DefaultHandler) HandleJobActionReq(w http.ResponseWriter, req *http.Request)

HandleJobActionReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandleJobLogReq

func (dh *DefaultHandler) HandleJobLogReq(w http.ResponseWriter, req *http.Request)

HandleJobLogReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandleLaunchJobReq

func (dh *DefaultHandler) HandleLaunchJobReq(w http.ResponseWriter, req *http.Request)

HandleLaunchJobReq is implementation of method defined in interface 'Handler'

func (*DefaultHandler) HandlePeriodicExecutions

func (dh *DefaultHandler) HandlePeriodicExecutions(w http.ResponseWriter, req *http.Request)

HandlePeriodicExecutions is implementation of method defined in interface 'Handler'

type Handler

type Handler interface {
	// HandleLaunchJobReq is used to handle the job submission request.
	HandleLaunchJobReq(w http.ResponseWriter, req *http.Request)

	// HandleGetJobReq is used to handle the job stats query request.
	HandleGetJobReq(w http.ResponseWriter, req *http.Request)

	// HandleJobActionReq is used to handle the job action requests (stop/retry).
	HandleJobActionReq(w http.ResponseWriter, req *http.Request)

	// HandleCheckStatusReq is used to handle the job service healthy status checking request.
	HandleCheckStatusReq(w http.ResponseWriter, req *http.Request)

	// HandleJobLogReq is used to handle the request of getting job logs
	HandleJobLogReq(w http.ResponseWriter, req *http.Request)

	// HandleJobLogReq is used to handle the request of getting periodic executions
	HandlePeriodicExecutions(w http.ResponseWriter, req *http.Request)

	// HandleGetJobsReq is used to handle the request of getting jobs
	HandleGetJobsReq(w http.ResponseWriter, req *http.Request)
}

Handler defines approaches to handle the http requests.

type Router

type Router interface {
	// ServeHTTP used to handle the http requests
	ServeHTTP(w http.ResponseWriter, req *http.Request)
}

Router defines the related routes for the job service and directs the request to the right handler method.

func NewBaseRouter

func NewBaseRouter(handler Handler, authenticator Authenticator) Router

NewBaseRouter is the constructor of BaseRouter.

type SecretAuthenticator

type SecretAuthenticator struct{}

SecretAuthenticator implements interface 'Authenticator' based on simple secret.

func (*SecretAuthenticator) DoAuth

func (sa *SecretAuthenticator) DoAuth(req *http.Request) error

DoAuth implements same method in interface 'Authenticator'.

type Server

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

Server serves the http requests.

func NewServer

func NewServer(ctx context.Context, router Router, cfg ServerConfig) *Server

NewServer is constructor of Server.

func (*Server) Start

func (s *Server) Start() error

Start the server to serve requests. Blocking call

func (*Server) Stop

func (s *Server) Stop() error

Stop server gracefully.

type ServerConfig

type ServerConfig struct {
	// Protocol server listening on: https/http
	Protocol string

	// Server listening port
	Port uint

	// Cert file path if using https
	Cert string

	// Key file path if using https
	Key string
}

ServerConfig contains the configurations of Server.