plugin

Documentation

Index

• Constants
• Variables
• func DEBUG(format string, args ...interface{})
• func Exec(cmdString string, flags int) error
• func ExecWithOptions(opts ExecOptions) error
• func GenUUID() string
• func Run(p Plugin)
• type EndpointDataTypeMismatchError
  • func (e EndpointDataTypeMismatchError) Error() string
• type EndpointMissingRequiredDataError
  • func (e EndpointMissingRequiredDataError) Error() string
• type ExecFailure
  • func (e ExecFailure) Error() string
• type ExecOptions
• type Field
• type JSONError
  • func (e JSONError) Error() string
• type MissingRestoreKeyError
  • func (e MissingRestoreKeyError) Error() string
• type Opt
• type Plugin
• type PluginFeatures
• type PluginInfo
• type ShieldEndpoint
  • func (endpoint ShieldEndpoint) ArrayValue(key string) ([]interface{}, error)
  • func (endpoint ShieldEndpoint) BooleanValue(key string) (bool, error)
  • func (endpoint ShieldEndpoint) BooleanValueDefault(key string, def bool) (bool, error)
  • func (endpoint ShieldEndpoint) FloatValue(key string) (float64, error)
  • func (endpoint ShieldEndpoint) FloatValueDefault(key string, def float64) (float64, error)
  • func (endpoint ShieldEndpoint) MapValue(key string) (map[string]interface{}, error)
  • func (endpoint ShieldEndpoint) StringValue(key string) (string, error)
  • func (endpoint ShieldEndpoint) StringValueDefault(key string, def string) (string, error)
• type UnsupportedActionError
  • func (e UnsupportedActionError) Error() string

Constants

const ENDPOINT_BAD_DATA = 13

const ENDPOINT_MISSING_KEY = 12

const EXEC_FAILURE = 3

const JSON_FAILURE = 10

const NOPIPE = 0

const PLUGIN_FAILURE = 4

const RESTORE_KEY_REQUIRED = 11

const STDIN = 1

const STDOUT = 2

const SUCCESS = 0

const UNSUPPORTED_ACTION = 2

const USAGE = 1

Variables

var UNIMPLEMENTED = UnsupportedActionError{}

Functions

func DEBUG

func DEBUG(format string, args ...interface{})

func Exec

func Exec(cmdString string, flags int) error

func ExecWithOptions

func ExecWithOptions(opts ExecOptions) error

func GenUUID

func GenUUID() string

func Run

func Run(p Plugin)

Types

type EndpointDataTypeMismatchError

type EndpointDataTypeMismatchError struct {
	Key         string
	DesiredType string
}

func (EndpointDataTypeMismatchError) Error

func (e EndpointDataTypeMismatchError) Error() string

type EndpointMissingRequiredDataError

type EndpointMissingRequiredDataError struct {
	Key string
}

func (EndpointMissingRequiredDataError) Error

func (e EndpointMissingRequiredDataError) Error() string

type ExecFailure

type ExecFailure struct {
	Err string
}

func (ExecFailure) Error

func (e ExecFailure) Error() string

type ExecOptions

type ExecOptions struct {
	Stdout   io.Writer
	Stdin    io.Reader
	Stderr   *os.File
	Cmd      string
	ExpectRC []int
}

type Field

type Field struct {
	Mode     string   `json:"mode"`
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Title    string   `json:"title,omitempty"`
	Help     string   `json:"help,omitempty"`
	Example  string   `json:"example,omitempty"`
	Default  string   `json:"default,omitempty"`
	Enum     []string `json:"enum,omitempty"`
	Required bool     `json:"required,omitempty"`
}

type JSONError

type JSONError struct {
	Err string
}

func (JSONError) Error

func (e JSONError) Error() string

type MissingRestoreKeyError

type MissingRestoreKeyError struct{}

func (MissingRestoreKeyError) Error

func (e MissingRestoreKeyError) Error() string

type Opt

type Opt struct {
	HelpShort bool   `cli:"-h"`
	HelpFull  bool   `cli:"--help"`
	Debug     bool   `cli:"-D, --debug",env:"DEBUG"`
	Version   bool   `cli:"-v, --version"`
	Endpoint  string `cli:"-e,--endpoint"`
	Key       string `cli:"-k, --key"`
	Text      bool   `cli:"--text"`

	Info     struct{} `cli:"info"`
	Example  struct{} `cli:"example"`
	Validate struct{} `cli:"validate"`
	Backup   struct{} `cli:"backup"`
	Restore  struct{} `cli:"restore"`
	Store    struct{} `cli:"store"`
	Retrieve struct{} `cli:"retrieve"`
	Purge    struct{} `cli:"purge"`
}

type Plugin

type Plugin interface {
	Validate(ShieldEndpoint) error
	Backup(ShieldEndpoint) error
	Restore(ShieldEndpoint) error
	Store(ShieldEndpoint) (string, int64, error)
	Retrieve(ShieldEndpoint, string) error
	Purge(ShieldEndpoint, string) error
	Meta() PluginInfo
}

type PluginFeatures

type PluginFeatures struct {
	Target string `json:"target"`
	Store  string `json:"store"`
}

type PluginInfo

type PluginInfo struct {
	Name     string         `json:"name"`
	Author   string         `json:"author"`
	Version  string         `json:"version"`
	Features PluginFeatures `json:"features"`

	Example  string `json:"-"`
	Defaults string `json:"-"`

	Fields []Field `json:"fields"`
}

type ShieldEndpoint

type ShieldEndpoint map[string]interface{}

func (ShieldEndpoint) ArrayValue

func (endpoint ShieldEndpoint) ArrayValue(key string) ([]interface{}, error)

func (ShieldEndpoint) BooleanValue

func (endpoint ShieldEndpoint) BooleanValue(key string) (bool, error)

func (ShieldEndpoint) BooleanValueDefault

func (endpoint ShieldEndpoint) BooleanValueDefault(key string, def bool) (bool, error)

func (ShieldEndpoint) FloatValue

func (endpoint ShieldEndpoint) FloatValue(key string) (float64, error)

func (ShieldEndpoint) FloatValueDefault

func (endpoint ShieldEndpoint) FloatValueDefault(key string, def float64) (float64, error)

func (ShieldEndpoint) MapValue

func (endpoint ShieldEndpoint) MapValue(key string) (map[string]interface{}, error)

func (ShieldEndpoint) StringValue

func (endpoint ShieldEndpoint) StringValue(key string) (string, error)

func (ShieldEndpoint) StringValueDefault

func (endpoint ShieldEndpoint) StringValueDefault(key string, def string) (string, error)

type UnsupportedActionError

type UnsupportedActionError struct {
	Action string
}

func (UnsupportedActionError) Error

func (e UnsupportedActionError) Error() string