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 JSONError
  • func (e JSONError) Error() string
• type MissingRestoreKeyError
  • func (e MissingRestoreKeyError) Error() string
• type Plugin
• type PluginFeatures
• type PluginInfo
• type PluginOpts
• type ShieldEndpoint
  • func (endpoint ShieldEndpoint) ArrayValue(key string) ([]interface{}, error)
  • func (endpoint ShieldEndpoint) BooleanValue(key string) (bool, error)
  • func (endpoint ShieldEndpoint) FloatValue(key string) (float64, error)
  • func (endpoint ShieldEndpoint) MapValue(key string) (map[string]interface{}, error)
  • func (endpoint ShieldEndpoint) StringValue(key 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   *os.File
	Stdin    *os.File
	Stderr   *os.File
	Cmd      string
	ExpectRC []int
}

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 Plugin

type Plugin interface {
	Backup(ShieldEndpoint) error
	Restore(ShieldEndpoint) error
	Store(ShieldEndpoint) (string, 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"`
}

type PluginOpts

type PluginOpts struct {
	Debug   bool `goptions:"-D, --debug, description='Enable debugging'"`
	Version bool `goptions:"-v, --version, description='Display version information'"`
	Action  goptions.Verbs
	Info    struct {
	} `goptions:"info"`
	Backup struct {
		Endpoint string `goptions:"-e, --endpoint, obligatory, description='JSON string representing backup target'"`
	} `goptions:"backup"`
	Restore struct {
		Endpoint string `goptions:"-e, --endpoint, obligatory, description='JSON string representing backup target'"`
	} `goptions:"restore"`
	Store struct {
		Endpoint string `goptions:"-e, --endpoint, obligatory, description='JSON string representing store endpoint'"`
	} `goptions:"store"`
	Retrieve struct {
		Endpoint string `goptions:"-e, --endpoint, obligatory, description='JSON string representing retrieve endpoint'"`
		Key      string `goptions:"-k, --key, obligatory, description='Key of blob to retrieve from storage'"`
	} `goptions:"retrieve"`
	Purge struct {
		Endpoint string `goptions:"-e, --endpoint, obligatory, description='JSON string representing purge endpoint'"`
		Key      string `goptions:"-k, --key, obligatory, description='Key of blob to purge from storage'"`
	} `goptions:"purge"`
}

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) FloatValue

func (endpoint ShieldEndpoint) FloatValue(key string) (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)

type UnsupportedActionError

type UnsupportedActionError struct {
	Action string
}

func (UnsupportedActionError) Error

func (e UnsupportedActionError) Error() string