java

Documentation

Overview

Package java provides a concrete Cataloger implementation for packages relating to the Java language ecosystem.

Index

• func NewArchiveCataloger(cfg ArchiveCatalogerConfig) *generic.Cataloger
• func NewGradleLockfileCataloger() pkg.Cataloger
• func NewNativeImageCataloger() pkg.Cataloger
• func NewPomCataloger(cfg ArchiveCatalogerConfig) pkg.Cataloger
• type ArchiveCatalogerConfig
  • func DefaultArchiveCatalogerConfig() ArchiveCatalogerConfig
  • func (j ArchiveCatalogerConfig) WithArchiveTraversal(search cataloging.ArchiveSearchConfig, maxDepth int) ArchiveCatalogerConfig
  • func (j ArchiveCatalogerConfig) WithMavenBaseURL(input string) ArchiveCatalogerConfig
  • func (j ArchiveCatalogerConfig) WithUseNetwork(input bool) ArchiveCatalogerConfig
• type LockfileDependency
• type NativeImageCataloger
  • func (c *NativeImageCataloger) Catalog(resolver file.Resolver) ([]pkg.Package, []artifact.Relationship, error)
  • func (c *NativeImageCataloger) Name() string

Functions

func NewArchiveCataloger

func NewArchiveCataloger(cfg ArchiveCatalogerConfig) *generic.Cataloger

NewArchiveCataloger returns a new Java archive cataloger object for detecting packages with archives (jar, war, ear, par, sar, jpi, hpi, and native-image formats)

func NewGradleLockfileCataloger

func NewGradleLockfileCataloger() pkg.Cataloger

NewGradleLockfileCataloger returns a cataloger capable of parsing dependencies from a gradle.lockfile file. Note: Older versions of lockfiles aren't supported yet

func NewNativeImageCataloger

func NewNativeImageCataloger() pkg.Cataloger

newNativeImageCataloger returns a new Native Image cataloger object.

func NewPomCataloger

func NewPomCataloger(cfg ArchiveCatalogerConfig) pkg.Cataloger

NewPomCataloger returns a cataloger capable of parsing dependencies from a pom.xml file. Pom files list dependencies that maybe not be locally installed yet.

Types

type ArchiveCatalogerConfig

type ArchiveCatalogerConfig struct {
	cataloging.ArchiveSearchConfig `yaml:",inline" json:"" mapstructure:",squash"`
	UseNetwork                     bool   `yaml:"use-network" json:"use-network" mapstructure:"use-network"`
	MavenBaseURL                   string `yaml:"maven-base-url" json:"maven-base-url" mapstructure:"maven-base-url"`
	MaxParentRecursiveDepth        int    `yaml:"max-parent-recursive-depth" json:"max-parent-recursive-depth" mapstructure:"max-parent-recursive-depth"`
}

func DefaultArchiveCatalogerConfig

func DefaultArchiveCatalogerConfig() ArchiveCatalogerConfig

func (ArchiveCatalogerConfig) WithArchiveTraversal

func (j ArchiveCatalogerConfig) WithArchiveTraversal(search cataloging.ArchiveSearchConfig, maxDepth int) ArchiveCatalogerConfig

func (ArchiveCatalogerConfig) WithMavenBaseURL

func (j ArchiveCatalogerConfig) WithMavenBaseURL(input string) ArchiveCatalogerConfig

func (ArchiveCatalogerConfig) WithUseNetwork

func (j ArchiveCatalogerConfig) WithUseNetwork(input bool) ArchiveCatalogerConfig

type LockfileDependency

type LockfileDependency struct {
	Group   string
	Name    string
	Version string
}

Dependency represents a single dependency in the gradle.lockfile file

type NativeImageCataloger

type NativeImageCataloger struct{}

func (*NativeImageCataloger) Catalog

func (c *NativeImageCataloger) Catalog(resolver file.Resolver) ([]pkg.Package, []artifact.Relationship, error)

Catalog attempts to find any native image executables reachable from a resolver.

func (*NativeImageCataloger) Name

func (c *NativeImageCataloger) Name() string

Name returns a string that uniquely describes a native image cataloger