eprouter

type AuthHandler interface {
	PerformAuth(routePtr *Route, ctx *Context) (authenticationWasSucessful bool, failureToAuthErrorNum int, failureToAuthErrorMessage string)
}

type CommonLogger struct {
}

type Context struct {
	Req      *http.Request // original http request
	Endpoint Endpoint      // parsed endpoint information

	StatusCode    int                    // The http status code written out. Only populated after a write.
	ContentLength int                    // The number of bytes written out. Only populated after a write.
	AuthInfo      map[string]interface{} // a k/v store of any info about the user which was gleaned during authentication
	// contains filtered or unexported fields
}

type CustomRouteResponse func(*Context)

type Endpoint struct {
	VersionStr string
	EntityName string
	PrimaryKey string
	Action     string
	Components []string
	Extras     []string
	// contains filtered or unexported fields
}

type ErrorInfo struct {
	ErrorNumber  int64  `json:"errorNumber,omitempty"`  // will be 0 on successful responses, non-zero otherwise
	ErrorMessage string `json:"errorMessage,omitempty"` // end-user appropriate error message
	DebugNumber  int64  `json:"debugNumber,omitempty"`  // optional debug code
	DebugMessage string `json:"debugMessage,omitempty"` // optional debug message
}

type MiddlewareProcessor interface {
	Process(routePtr *Route, ctx *Context) (terminateEarly bool, derr *deeperror.DeepError)
}

type Payload interface {
	PayloadType() string
}

type PayloadController interface {
}

type PayloadWrapper struct {
	Payloads PayloadsMap `json:",omitempty"` // key is type, value is list of payloads of that type

	ErrorInfo
	Alert string `json:",omitempty"` // used when the client end user needs to be alerted of something: (eg, maintenance mode, downtime, sercurity, required update, etc.)
}

type PayloadsMap map[string][]Payload

type PostProcessor interface {
	Process(ctx *Context) (terminateEarly bool, derr *deeperror.DeepError)
}

type PreProcessor interface {
	Process(ctx *Context) (terminateEarly bool, derr *deeperror.DeepError)
}

type Route struct {
	RequiresAuth  bool
	Authenticator AuthHandler

	Method         string
	Path           string
	VersionStr     string
	EntityName     string
	Action         string
	Handler        RouteHandler
	HandlerName    string // not actually used except for logging and debugging
	ControllerName string // not actually used except for logging and debugging
}

type RouteError struct {
	ErrorLevel levels.ErrorLevel
	// contains filtered or unexported fields
}

type RouteHandler func(*Context) RouteHandlerResult

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

type Router struct {
	BasePath string

	PreProcessors        []PreProcessor
	MiddlewareProcessors []MiddlewareProcessor
	PostProcessors       []PostProcessor

	Controllers map[string]PayloadController // key is entity name
	RouteMap    map[string]*Route            // key is entity name
}

type VersionUint uint16