validators

Documentation

Overview

Package validators provides basic validation for splice requests and exposes an interface for additional validators.

Index

• type Basic
  • func (d Basic) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)
• type GenericGeneratorChecks
  • func (c GenericGeneratorChecks) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)
• type PrefixGeneratorCheck
  • func (c PrefixGeneratorCheck) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)
• type Reuse
  • func NewReuse() *Reuse
  • func (r Reuse) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)
• type Validator
  • func New() ([]Validator, error)
  • func NewUnattended() ([]Validator, error)

Types

type Basic

type Basic struct {
}

Basic implements Validator and performs basic checking of a request.

func (Basic) Check

func (d Basic) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)

Check returns StatusSuccess(0) if a request has data in required fields and that data passes basic integrity checks.

type GenericGeneratorChecks

type GenericGeneratorChecks struct{}

GenericGeneratorChecks provides general sanity checks for SpliceD generators

func (GenericGeneratorChecks) Check

func (c GenericGeneratorChecks) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)

Check returns StatusSuccess if req is valid. It may modify req to sanitize it.

type PrefixGeneratorCheck

type PrefixGeneratorCheck struct{}

PrefixGeneratorCheck provides sanity checks for the SpliceD "prefix" Generator. It may modify the request to sanitize certain inputs for compatibility.

func (PrefixGeneratorCheck) Check

func (c PrefixGeneratorCheck) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)

Check returns StatusSuccess if req is valid. It may modify req to sanitize it.

type Reuse

type Reuse struct{}

Reuse implements validators.Validator and checks if the request is permitted to enable name reuse.

func NewReuse

func NewReuse() *Reuse

NewReuse returns a reuse validator.

func (Reuse) Check

func (r Reuse) Check(ctx context.Context, req *models.Request) (server.StatusCode, error)

type Validator

type Validator interface {
	// Check returns a status code and an error if the check failed. Check
	// should perform its own cleanup (defer or otherwise) prior to returning.
	Check(context.Context, *models.Request) (server.StatusCode, error)
}

Validator performs metadata checking for requests.

func New

func New() ([]Validator, error)

New returns a slice containing all basic validators for interactive requests.

func NewUnattended

func NewUnattended() ([]Validator, error)

NewUnattended returns a slice containing all validators required for unattended requests.