scan

Documentation

Index

• Constants
• type ScanFunction
• type ScanService
  • func New(base *services.BaseService) *ScanService
  • func (s *ScanService) Register(container *restful.Container)
  • func (s *ScanService) RegisterSessions(ws *restful.WebService)
  • func (s *ScanService) TakeScan(fn ScanFunction) restful.RouteFunction
  • func (s *ScanService) TakeSession(fn SessionFunction) ScanFunction
• type SessionFunction
• type SessionUpdateEntity

Constants

const (
	ParamId        = "scan-id"
	SessionParamId = "session-id"
)

Types

type ScanFunction

type ScanFunction func(*restful.Request, *restful.Response, *scan.Scan)

type ScanService

type ScanService struct {
	*services.BaseService
}

func New

func New(base *services.BaseService) *ScanService

func (*ScanService) Register

func (s *ScanService) Register(container *restful.Container)

func (*ScanService) RegisterSessions

func (s *ScanService) RegisterSessions(ws *restful.WebService)

func (*ScanService) TakeScan

func (s *ScanService) TakeScan(fn ScanFunction) restful.RouteFunction

Decorate restful.RouteFunction. Look for scan by ParamId and add scan object in the end. If scan is not found then return Not Found. Also check project permission for current user.

func (*ScanService) TakeSession

func (s *ScanService) TakeSession(fn SessionFunction) ScanFunction

Decorate ScanFunction. Look for session in scan by SessionParamId and add session object in the end. If session is not found then return Not Found.

type SessionFunction

type SessionFunction func(*restful.Request, *restful.Response, *scan.Scan, *scan.Session)

type SessionUpdateEntity

type SessionUpdateEntity struct {
	Status scan.ScanStatus `json:"status" description:"one of [working|finished|failed]"`
}