processor

Documentation

Overview

Package processor specifies the common pieces for other processors

Index

• type Outcome
  • func (o Outcome) String() string
• type Processor
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) GetOutcome(req *http.Request) Outcome
  • func (r *Registry) List() []Processor
  • func (r *Registry) Register(p Processor)

Types

type Outcome

type Outcome int

Outcome represents the possible outcomes for a request processor

const (
	// ALLOW means that the request is known to be OK
	ALLOW Outcome = iota

	// BLOCK means that the request is known to be NOK
	BLOCK

	// NEUTRAL means that the processor can't know for sure whether the request is good
	NEUTRAL
)

func (Outcome) String

func (o Outcome) String() string

type Processor

type Processor interface {
	Process(req *http.Request) (Outcome, error)
}

Processor defines a common interface for all processors

type Registry

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

Registry stores all the processors known to this application

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new registry instance with the default processors

func (*Registry) GetOutcome

func (r *Registry) GetOutcome(req *http.Request) Outcome

GetOutcome for the given request, stopping after the first non-neutral outcome

func (*Registry) List

func (r *Registry) List() []Processor

List the registered processors

func (*Registry) Register

func (r *Registry) Register(p Processor)

Register a new processor