cmds

Documentation

Index

• func Description(name string) string
• func RegisterLoggingConfigHandler(h LoggingHandler)
• type Error
• type LoggingConfiguration
• type LoggingHandler
• type PluginCommand
  • func NewPluginCommand(p ppi.Plugin) *PluginCommand
  • func (p *PluginCommand) Command() *cobra.Command
  • func (p *PluginCommand) Execute(args []string) error
  • func (p *PluginCommand) PreRunE(cmd *cobra.Command, args []string) error

Functions

func Description

func Description(name string) string

func RegisterLoggingConfigHandler

func RegisterLoggingConfigHandler(h LoggingHandler)

RegisterLoggingConfigHandler is used to register a configuration handler for logging configration passed by the OCM library. If standard mandelsoft logging is used, it can be adapted by adding the ananymous import of the ppi/logging package.

Types

type Error

type Error struct {
	Error string `json:"error"`
}

type LoggingConfiguration

type LoggingConfiguration struct {
	LogFileName string          `json:"logFileName"`
	LogConfig   json.RawMessage `json:"logConfig"`
	Json        bool            `json:"json,omitempty"`
}

LoggingConfiguration describes logging configuration for a slave executables like plugins. If mandelsoft logging is used please use ocm.software/ocm/api/utils/cobrautils/logging.LoggingConfiguration, instead.

type LoggingHandler

type LoggingHandler interface {
	HandleConfig(data []byte) error
}

type PluginCommand

type PluginCommand struct {
	// contains filtered or unexported fields
}

func NewPluginCommand

func NewPluginCommand(p ppi.Plugin) *PluginCommand

func (*PluginCommand) Command

func (p *PluginCommand) Command() *cobra.Command

func (*PluginCommand) Execute

func (p *PluginCommand) Execute(args []string) error

func (*PluginCommand) PreRunE

func (p *PluginCommand) PreRunE(cmd *cobra.Command, args []string) error