filters

type BaseSpec struct {
	supervisor.MetaSpec `json:",inline"`
	// contains filtered or unexported fields
}

type Filter interface {
	// Name returns the name of the filter.
	Name() string

	// Kind returns the kind of the filter, caller should never modify the
	// return value.
	Kind() *Kind

	// Spec returns the Spec of the filter instance.
	Spec() Spec

	// Init initializes the Filter.
	Init()

	// Inherit also initializes the Filter, the difference from Init is it
	// inherit something from the previousGeneration, but Inherit does NOT
	// handle the lifecycle of previousGeneration.
	Inherit(previousGeneration Filter)

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

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

	// Close closes itself.
	Close()
}

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

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

	// Results list all possible results of the filter, except the normal
	// result (i.e. empty string).
	Results []string

	// CreateInstance creates a new filter instance of the kind.
	CreateInstance func(spec Spec) Filter

	// DefaultSpec returns a spec for the filter, with default values. The
	// function should always return a new spec copy, because the caller
	// may modify the returned spec.
	DefaultSpec func() Spec
}

type Resiliencer interface {
	InjectResiliencePolicy(policies map[string]resilience.Policy)
}

type Spec interface {
	// Super returns supervisor
	Super() *supervisor.Supervisor

	// Name returns name.
	Name() string

	// Kind returns kind.
	Kind() string

	// Pipeline returns the name of the pipeline this filter belongs to.
	Pipeline() string

	// JSONConfig returns the config in json format.
	JSONConfig() string
	// contains filtered or unexported methods
}