preprocessor

Documentation

Index

• type AccessKeyValidationPreprocessor
  • func (p AccessKeyValidationPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int
• type ConnPreprocessor
  • func (p ConnPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int
• type DevOnlyProcessor
  • func (p DevOnlyProcessor) Preprocess(payload *router.Payload, response *router.Response) int
• type EnsurePluginReadyPreprocessor
  • func (p *EnsurePluginReadyPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int
• type InjectAuthIfPresent
  • func (p InjectAuthIfPresent) Preprocess(payload *router.Payload, response *router.Response) int
• type InjectDatabase
  • func (p InjectDatabase) Preprocess(payload *router.Payload, response *router.Response) int
• type InjectPublicDatabase
  • func (p InjectPublicDatabase) Preprocess(payload *router.Payload, response *router.Response) int
• type InjectUserIfPresent
  • func (p InjectUserIfPresent) Preprocess(payload *router.Payload, response *router.Response) int
• type NotificationPreprocessor
  • func (p NotificationPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int
• type RequireAdminOrMasterKey
  • func (p RequireAdminOrMasterKey) Preprocess(payload *router.Payload, response *router.Response) int
• type RequireAuth
  • func (p RequireAuth) Preprocess(payload *router.Payload, response *router.Response) int
• type UserAuthenticator
  • func (p *UserAuthenticator) Preprocess(payload *router.Payload, response *router.Response) int

Types

type AccessKeyValidationPreprocessor

type AccessKeyValidationPreprocessor struct {
	ClientKey string
	MasterKey string
	AppName   string
}

AccessKeyValidationPreprocessor provides preprocess method to check the API key of the request.

func (AccessKeyValidationPreprocessor) Preprocess

func (p AccessKeyValidationPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int

type ConnPreprocessor

type ConnPreprocessor struct {
	AppName       string
	AccessControl string
	DBOpener      func(context.Context, string, string, string, string, bool) (skydb.Conn, error)
	DBImpl        string
	Option        string
	DevMode       bool
}

func (ConnPreprocessor) Preprocess

func (p ConnPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int

type DevOnlyProcessor

type DevOnlyProcessor struct {
	DevMode bool
}

func (DevOnlyProcessor) Preprocess

func (p DevOnlyProcessor) Preprocess(payload *router.Payload, response *router.Response) int

type EnsurePluginReadyPreprocessor

type EnsurePluginReadyPreprocessor struct {
	PluginContext *plugin.Context
	ClientKey     string
	MasterKey     string
}

func (*EnsurePluginReadyPreprocessor) Preprocess

func (p *EnsurePluginReadyPreprocessor) Preprocess(
	payload *router.Payload,
	response *router.Response,
) int

type InjectAuthIfPresent

type InjectAuthIfPresent struct {
}

func (InjectAuthIfPresent) Preprocess

func (p InjectAuthIfPresent) Preprocess(payload *router.Payload, response *router.Response) int

type InjectDatabase

type InjectDatabase struct {
}

func (InjectDatabase) Preprocess

func (p InjectDatabase) Preprocess(payload *router.Payload, response *router.Response) int

type InjectPublicDatabase

type InjectPublicDatabase struct {
}

func (InjectPublicDatabase) Preprocess

func (p InjectPublicDatabase) Preprocess(payload *router.Payload, response *router.Response) int

type InjectUserIfPresent

type InjectUserIfPresent struct {
	HookRegistry *hook.Registry `inject:"HookRegistry"`
	AssetStore   asset.Store    `inject:"AssetStore"`
}

InjectUserIfPresent injects a user record to the payload

An AuthInfo must be injected before this, if it is not found, the preprocessor would just skip the injection

If AuthInfo is injected but a user record is not found, the preprocessor would create a new user record and inject it to the payload

func (InjectUserIfPresent) Preprocess

func (p InjectUserIfPresent) Preprocess(payload *router.Payload, response *router.Response) int

type NotificationPreprocessor

type NotificationPreprocessor struct {
	NotificationSender push.Sender
}

func (NotificationPreprocessor) Preprocess

func (p NotificationPreprocessor) Preprocess(payload *router.Payload, response *router.Response) int

type RequireAdminOrMasterKey

type RequireAdminOrMasterKey struct {
}

func (RequireAdminOrMasterKey) Preprocess

func (p RequireAdminOrMasterKey) Preprocess(payload *router.Payload, response *router.Response) int

type RequireAuth

type RequireAuth struct {
}

func (RequireAuth) Preprocess

func (p RequireAuth) Preprocess(payload *router.Payload, response *router.Response) int

type UserAuthenticator

type UserAuthenticator struct {
	ClientKey  string
	MasterKey  string
	AppName    string
	TokenStore authtoken.Store
}

UserAuthenticator provides preprocess method to authenicate a user with access token or non-login user without api key.

func (*UserAuthenticator) Preprocess

func (p *UserAuthenticator) Preprocess(payload *router.Payload, response *router.Response) int