rule

Documentation

Index

• type Element
• type List
  • func NewList(ifNoResult int, isReply bool) (*List, error)
  • func (p *List) Add(e *Element) error
  • func (p *List) BuildRules(engines map[string]policy.Engine) error
  • func (p *List) Engines() map[string]string
  • func (p *List) Evaluate(ctx context.Context, state request.Request, data map[string]interface{}, ...) (int, error)

Types

type Element

type Element struct {
	Plugin string
	Name   string
	Params []string
	Rule   policy.Rule
}

Element is a structure that host a definition of policy Rule, and the Rule itself when created

type List

type List struct {
	Reply         bool
	Rules         []*Element
	DefaultPolicy int
}

List of Rules checked in order of the list

func NewList

func NewList(ifNoResult int, isReply bool) (*List, error)

NewList to create an empty new List of Rules

func (*List) Add

func (p *List) Add(e *Element) error

Add the element at end of the list

func (*List) BuildRules

func (p *List) BuildRules(engines map[string]policy.Engine) error

BuildRules instanciate the Rule of each Element, based on the parameters collected from setup.

func (*List) Engines

func (p *List) Engines() map[string]string

Engines list all engines involved - return map[name] -> plugin

func (*List) Evaluate

func (p *List) Evaluate(ctx context.Context, state request.Request, data map[string]interface{}, engines map[string]policy.Engine) (int, error)

Evaluate all policy one by one until one provide a valid result if no Rule can provide a result, the DefaultPolicy of the list applies