routers

type Header struct {
	Key    string   `json:"key" jsonschema:"required"`
	Values []string `json:"values,omitempty" jsonschema:"uniqueItems=true"`
	Regexp string   `json:"regexp,omitempty" jsonschema:"format=regexp"`
	// contains filtered or unexported fields
}

type Headers []*Header

type Host struct {
	IsRegexp bool   `json:"isRegexp,omitempty"`
	Value    string `json:"value" jsonschema:"required"`
	// contains filtered or unexported fields
}

type Kind struct {
	// Name is the name of the router kind.
	Name string

	// Description is the description of the router.
	Description string

	// CreateInstance creates a new router instance of the kind.
	CreateInstance func(rules Rules) Router
}

type MethodType uint

type Params struct {
	Keys, Values []string
}

type Path struct {
	IPFilterSpec      *ipfilter.Spec `json:"ipFilter,omitempty"`
	Path              string         `json:"path,omitempty" jsonschema:"pattern=^/"`
	PathPrefix        string         `json:"pathPrefix,omitempty" jsonschema:"pattern=^/"`
	PathRegexp        string         `json:"pathRegexp,omitempty" jsonschema:"format=regexp"`
	RewriteTarget     string         `json:"rewriteTarget,omitempty"`
	Methods           []string       `json:"methods,omitempty" jsonschema:"uniqueItems=true,format=httpmethod-array"`
	Backend           string         `json:"backend" jsonschema:"required"`
	ClientMaxBodySize int64          `json:"clientMaxBodySize,omitempty"`
	Headers           Headers        `json:"headers,omitempty"`
	Queries           Queries        `json:"queries,omitempty"`
	MatchAllHeader    bool           `json:"matchAllHeader,omitempty"`
	MatchAllQuery     bool           `json:"matchAllQuery,omitempty"`
	// contains filtered or unexported fields
}

type Paths []*Path

type Queries []*Query

type Query struct {
	Key    string   `json:"key" jsonschema:"required"`
	Values []string `json:"values,omitempty" jsonschema:"uniqueItems=true"`
	Regexp string   `json:"regexp,omitempty" jsonschema:"format=regexp"`
	// contains filtered or unexported fields
}

type Route interface {
	protocols.Route

	// Rewrite for path rewriting.
	Rewrite(context *RouteContext)
	// GetBackend is used to get the backend corresponding to the route.
	GetBackend() string
	// GetClientMaxBodySize is used to get the clientMaxBodySize corresponding to the route.
	GetClientMaxBodySize() int64

	// GetExactPath is used to get the exact path corresponding to the route.
	GetExactPath() string
	// GetPathPrefix is used to get the path prefix corresponding to the route.
	GetPathPrefix() string
	// GetPathRegexp is used to get the path regexp corresponding to the route.
	GetPathRegexp() string
}

type RouteContext struct {
	// Request is httpprot.Request.
	Request *httpprot.Request
	// Path represents the path of the request.
	Path string
	// Method represents the MethodType corresponding to the http method.
	Method MethodType

	// Params are used to store the variables in the search path and their corresponding values.
	Params Params

	// Cacheable means whether the route can be cached or not.
	Cacheable bool
	// Route represents the results of this search
	Route                                                     Route
	HeaderMismatch, MethodMismatch, QueryMismatch, IPMismatch bool
	// contains filtered or unexported fields
}

type Router interface {
	// Search performs a route search and populates the context with search-related information.
	Search(context *RouteContext)
}

type Rule struct {
	// NOTICE: If the field is a pointer, it must have `omitempty` in tag `json`
	// when it has `omitempty` in tag `jsonschema`.
	// Otherwise it will output null value, which is invalid in json schema (the type is object).
	// the original reason is the jsonscheme(genjs) has not support multiple types.
	// Reference: https://github.com/alecthomas/jsonschema/issues/30
	// In the future if we have the scenario where we need marshal the field, but omitempty
	// in the schema, we are suppose to support multiple types on our own.
	IPFilterSpec *ipfilter.Spec `json:"ipFilter,omitempty"`
	Host         string         `json:"host,omitempty"`
	HostRegexp   string         `json:"hostRegexp,omitempty" jsonschema:"format=regexp"`
	Hosts        []Host         `json:"hosts,omitempty"`
	Paths        Paths          `json:"paths,omitempty"`
	// contains filtered or unexported fields
}

type Rules []*Rule