plugin

Documentation

Index

• Constants
• Variables
• func Start(plgn Plugin)
• type Credential
• type Meta
• type PivotalCF
  • func NewPivotalCF(pcf PivotalCF) *PivotalCF
• type Plugin
• type PluginTile
  • func (s *PluginTile) Backup() (err error)
  • func (s *PluginTile) Restore() (err error)
• type PluginTileBuilder
  • func (s *PluginTileBuilder) New(tileSpec tileregistry.TileSpec) (tile tileregistry.Tile, err error)
• type Product

Constants

const (
	//PluginPort - default plugin port
	PluginPort = int(1984)
	//PluginMeta - default plugin arg to show meta data
	PluginMeta = "plugin-meta"

	//PluginActivityRestore - activity keyname
	PluginActivityRestore = "restore"
	//PluginActivityBackup - activity keyname
	PluginActivityBackup = "backup"
	//PluginActivityExecute - activity keyname
	PluginActivityExecute = "execute"
)

Variables

var (
	//UIOutput - a function to control UIOutput
	UIOutput = fmt.Print
	//PluginArgs - cli args given to the plugin
	PluginArgs = os.Args
)

var DefaultPivotalCF = func(installationSettings *cfbackup.ConfigurationParser) PivotalCF {

	return &defaultPivotalCF{
		installationSettings: installationSettings,
	}
}

DefaultPivotalCF - creates the default pivotacf

var IsPluginMetaCall atomic.Value

IsPluginMetaCall - determines if the call to the plugin is for meta data or execution

Functions

func Start

func Start(plgn Plugin)

Start - call on a plugin within a main to make your app a cfops plugin

Types

type Credential

type Credential cfbackup.Properties

Credential - credential implementation

type Meta

type Meta struct {
	Name                string
	Role                string
	Description         string
	SupportedActivities map[string]bool
}

Meta - plugin meta data storage object

type PivotalCF

type PivotalCF interface {
	SetActivity(string)
	GetActivity() string
	GetProducts() map[string]cfbackup.Products
	GetCredentials() map[string]map[string][]cfbackup.Properties
}

PivotalCF - interface representing a pivotalcf

func NewPivotalCF

func NewPivotalCF(pcf PivotalCF) *PivotalCF

NewPivotalCF - creates a pivotalcf from a given object and registers the gob

type Plugin

type Plugin interface {
	GetMeta() Meta
	Run(PivotalCF, *[]string) error
}

Plugin - a plugin interface definition

type PluginTile

type PluginTile struct {
	PivotalCF PivotalCF
	FilePath  string
	Meta      Meta
}

PluginTile - tile implementation of a plugin

func (*PluginTile) Backup

func (s *PluginTile) Backup() (err error)

Backup - backup method for plugin tile wrapper

func (*PluginTile) Restore

func (s *PluginTile) Restore() (err error)

Restore - restore method for plugin tile wrapper

type PluginTileBuilder

type PluginTileBuilder struct {
	FilePath string
	Meta     Meta
}

PluginTileBuilder - factory for a tile wrapped plugin

func (*PluginTileBuilder) New

func (s *PluginTileBuilder) New(tileSpec tileregistry.TileSpec) (tile tileregistry.Tile, err error)

New - method to create a plugin tile

type Product

type Product cfbackup.Products

Product - implementation