pkgcataloging

Documentation

Index

• Constants
• Variables
• type CatalogerReference
  • func NewAlwaysEnabledCatalogerReference(cataloger pkg.Cataloger) CatalogerReference
  • func NewCatalogerReference(cataloger pkg.Cataloger, tags []string) CatalogerReference
• type Config
  • func DefaultConfig() Config
  • func (c Config) WithBinaryConfig(cfg binary.ClassifierCatalogerConfig) Config
  • func (c Config) WithDotnetConfig(cfg dotnet.CatalogerConfig) Config
  • func (c Config) WithGolangConfig(cfg golang.CatalogerConfig) Config
  • func (c Config) WithJavaArchiveConfig(cfg java.ArchiveCatalogerConfig) Config
  • func (c Config) WithJavascriptConfig(cfg javascript.CatalogerConfig) Config
  • func (c Config) WithLinuxKernelConfig(cfg kernel.LinuxKernelCatalogerConfig) Config
  • func (c Config) WithPythonConfig(cfg python.CatalogerConfig) Config
• type SelectionRequest

Constants

const (
	// InstalledTag is to identify packages found to be positively installed.
	InstalledTag = "installed"

	// DeclaredTag is to identify packages described but not necessarily installed.
	DeclaredTag = "declared"

	// ImageTag indicates the cataloger should be used when cataloging images.
	ImageTag = "image"

	// DirectoryTag indicates the cataloger should be used when cataloging directories.
	DirectoryTag = "directory"

	// PackageTag should be used to identify catalogers that are package-based.
	PackageTag = "package"

	// OSTag should be used to identify catalogers that cataloging OS packages.
	OSTag = "os"

	// LanguageTag should be used to identify catalogers that cataloging language-specific packages.
	LanguageTag = "language"
)

Variables

var NewSelectionRequest = cataloging.NewSelectionRequest

NewSelectionRequest is deprecated: use cataloging.NewSelectionRequest instead

Types

type CatalogerReference

type CatalogerReference struct {
	Cataloger     pkg.Cataloger
	AlwaysEnabled bool
	Tags          []string
}

func NewAlwaysEnabledCatalogerReference

func NewAlwaysEnabledCatalogerReference(cataloger pkg.Cataloger) CatalogerReference

func NewCatalogerReference

func NewCatalogerReference(cataloger pkg.Cataloger, tags []string) CatalogerReference

type Config

type Config struct {
	Binary      binary.ClassifierCatalogerConfig  `yaml:"binary" json:"binary" mapstructure:"binary"`
	Dotnet      dotnet.CatalogerConfig            `yaml:"dotnet" json:"dotnet" mapstructure:"dotnet"`
	Golang      golang.CatalogerConfig            `yaml:"golang" json:"golang" mapstructure:"golang"`
	JavaArchive java.ArchiveCatalogerConfig       `yaml:"java-archive" json:"java-archive" mapstructure:"java-archive"`
	JavaScript  javascript.CatalogerConfig        `yaml:"javascript" json:"javascript" mapstructure:"javascript"`
	LinuxKernel kernel.LinuxKernelCatalogerConfig `yaml:"linux-kernel" json:"linux-kernel" mapstructure:"linux-kernel"`
	Python      python.CatalogerConfig            `yaml:"python" json:"python" mapstructure:"python"`
}

func DefaultConfig

func DefaultConfig() Config

func (Config) WithBinaryConfig

func (c Config) WithBinaryConfig(cfg binary.ClassifierCatalogerConfig) Config

func (Config) WithDotnetConfig

func (c Config) WithDotnetConfig(cfg dotnet.CatalogerConfig) Config

func (Config) WithGolangConfig

func (c Config) WithGolangConfig(cfg golang.CatalogerConfig) Config

func (Config) WithJavaArchiveConfig

func (c Config) WithJavaArchiveConfig(cfg java.ArchiveCatalogerConfig) Config

func (Config) WithJavascriptConfig

func (c Config) WithJavascriptConfig(cfg javascript.CatalogerConfig) Config

func (Config) WithLinuxKernelConfig

func (c Config) WithLinuxKernelConfig(cfg kernel.LinuxKernelCatalogerConfig) Config

func (Config) WithPythonConfig

func (c Config) WithPythonConfig(cfg python.CatalogerConfig) Config

type SelectionRequest

type SelectionRequest = cataloging.SelectionRequest

SelectionRequest is deprecated: use cataloging.SelectionRequest instead