httppipeline

type Filter interface {
	// Kind returns the unique kind name to represent itself.
	Kind() string

	// DefaultSpec returns the default spec.
	DefaultSpec() interface{}

	// Description returns the description of the filter.
	Description() string

	// Results returns all possible results, the normal result
	// (i.e. empty string) could not be in it.
	Results() []string

	// Init initializes the Filter.
	Init(filterSpec *FilterSpec, super *supervisor.Supervisor)

	// Inherit also initializes the Filter.
	// But it needs to handle the lifecycle of the previous generation.
	// So it's own responsibility for the filter to inherit and clean the previous generation stuff.
	// The http pipeline won't call Close for the previous generation.
	Inherit(filterSpec *FilterSpec, previousGeneration Filter, super *supervisor.Supervisor)

	// Handle handles one HTTP request, all possible results
	// need be registered in Results.
	Handle(context.HTTPContext) (result string)

	// Status returns its runtime status.
	// It could return nil.
	Status() interface{}

	// Close closes itself.
	Close()
}

type FilterMetaSpec struct {
	Name string `yaml:"name" jsonschema:"required,format=urlname"`
	Kind string `yaml:"kind" jsonschema:"required"`
}

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

type FilterStat struct {
	Name     string
	Kind     string
	Result   string
	Duration time.Duration
	Next     []*FilterStat
}

type Flow struct {
	Filter string            `yaml:"filter" jsonschema:"required,format=urlname"`
	JumpIf map[string]string `yaml:"jumpIf" jsonschema:"omitempty"`
}

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

type PipelineContext struct {
	FilterStats *FilterStat
}

type Spec struct {
	Flow    []Flow                   `yaml:"flow" jsonschema:"omitempty"`
	Filters []map[string]interface{} `yaml:"filters" jsonschema:"-"`
}

type Status struct {
	Health string `yaml:"health"`

	Filters map[string]interface{} `yaml:"filters"`
}