integration

Documentation

Index

• func RegisterPlugin(pluginName string, endpointArgumentName string, newFunc NewFunc)
• func RegisteredPlugins() map[string]func() Plugin
• func Reset()
• type NewFunc
• type Plugin
• type Plugins
  • func PluginsInstance() Plugins
  • func (p Plugins) CallStack(data interface{}) (stack map[string]interface{})
  • func (p Plugins) DestroyAll()
  • func (p Plugins) GetData(argv []any) (data map[string]string)
  • func (p Plugins) GetEnvironmentsData(envIds []uid.ID) (data map[uid.ID]map[string]string)
  • func (p Plugins) GetEnvironmentsShortData(envIds []uid.ID) (data map[uid.ID]map[string]string)
  • func (p Plugins) InitAll(fid string)
  • func (p Plugins) ObjectStack(varStack map[string]string, baseConfigStack map[string]string) (stack map[string]interface{})

Functions

func RegisterPlugin

func RegisterPlugin(pluginName string, endpointArgumentName string, newFunc NewFunc)

func RegisteredPlugins

func RegisteredPlugins() map[string]func() Plugin

func Reset

func Reset()

Reset resets the plugin system for testing purposes.

Types

type NewFunc

type NewFunc func(endpoint string) Plugin

type Plugin

type Plugin interface {
	GetName() string
	GetPrettyName() string
	GetEndpoint() string
	GetConnectionState() string
	GetData(argv []any) string
	GetEnvironmentsData(envIds []uid.ID) map[uid.ID]string
	GetEnvironmentsShortData(envIds []uid.ID) map[uid.ID]string

	Init(instanceId string) error
	CallStack(data interface{}) map[string]interface{}                                                // used in hook call context
	ObjectStack(varStack map[string]string, baseConfigStack map[string]string) map[string]interface{} // all other ProcessTemplates contexts
	Destroy() error
}

type Plugins

type Plugins []Plugin

func PluginsInstance

func PluginsInstance() Plugins

func (Plugins) CallStack

func (p Plugins) CallStack(data interface{}) (stack map[string]interface{})

func (Plugins) DestroyAll

func (p Plugins) DestroyAll()

func (Plugins) GetData

func (p Plugins) GetData(argv []any) (data map[string]string)

func (Plugins) GetEnvironmentsData

func (p Plugins) GetEnvironmentsData(envIds []uid.ID) (data map[uid.ID]map[string]string)

func (Plugins) GetEnvironmentsShortData

func (p Plugins) GetEnvironmentsShortData(envIds []uid.ID) (data map[uid.ID]map[string]string)

func (Plugins) InitAll

func (p Plugins) InitAll(fid string)

func (Plugins) ObjectStack

func (p Plugins) ObjectStack(varStack map[string]string, baseConfigStack map[string]string) (stack map[string]interface{})