pomxmlnet

Documentation

Overview

Package pomxmlnet extracts Maven's pom.xml format with transitive dependency resolution.

Index

• Constants
• func NewDefault() filesystem.Extractor
• type Config
  • func DefaultConfig() Config
  • func NewConfig(registry string) Config
• type Extractor
  • func New(c Config) *Extractor
  • func (e Extractor) Ecosystem(_ *extractor.Inventory) string
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(fapi filesystem.FileAPI) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL
  • func (e Extractor) Version() int

Constants

const (
	// Name is the unique name of this extractor.
	Name = "java/pomxmlnet"
)

Functions

func NewDefault

func NewDefault() filesystem.Extractor

NewDefault returns an extractor with the default config settings.

Types

type Config

type Config struct {
	DependencyClient resolve.Client
	*datasource.MavenRegistryAPIClient
}

Config is the configuration for the pomxmlnet Extractor.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the pomxmlnet extractor.

func NewConfig

func NewConfig(registry string) Config

NewConfig returns the configuration given the URL of the Maven registry to fetch metadata.

type Extractor

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

Extractor extracts Maven packages with transitive dependency resolution.

func New

func New(c Config) *Extractor

New makes a new pom.xml transitive extractor with the given config.

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(_ *extractor.Inventory) string

Ecosystem returns the OSV ecosystem ('npm') of the software extracted by this extractor.

func (Extractor) Extract

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)

Extract extracts packages from pom.xml files passed through the scan input.

func (Extractor) FileRequired

func (e Extractor) FileRequired(fapi filesystem.FileAPI) bool

FileRequired returns true if the specified file matches Maven POM lockfile patterns.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) *purl.PackageURL

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.