java

Documentation

Overview

Package java provides a concrete Cataloger implementation for Java archives (jar, war, ear, par, sar, jpi, hpi, and native-image formats).

Index

• func NewJavaCataloger(cfg Config) *generic.Cataloger
• func NewJavaGradleLockfileCataloger() *generic.Cataloger
• func NewJavaPomCataloger() *generic.Cataloger
• type Config
• type LockfileDependency
• type NativeImageCataloger
  • func NewNativeImageCataloger() *NativeImageCataloger
  • func (c *NativeImageCataloger) Catalog(resolver file.Resolver) ([]pkg.Package, []artifact.Relationship, error)
  • func (c *NativeImageCataloger) Name() string

Functions

func NewJavaCataloger

func NewJavaCataloger(cfg Config) *generic.Cataloger

NewJavaCataloger returns a new Java archive cataloger object.

func NewJavaGradleLockfileCataloger

func NewJavaGradleLockfileCataloger() *generic.Cataloger

NewJavaGradleLockfileCataloger returns a cataloger capable of parsing dependencies from a gradle.lockfile file. older versions of lockfiles aren't supported yet

func NewJavaPomCataloger

func NewJavaPomCataloger() *generic.Cataloger

NewJavaPomCataloger 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 Config

type Config struct {
	SearchUnindexedArchives bool
	SearchIndexedArchives   bool
}

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 NewNativeImageCataloger

func NewNativeImageCataloger() *NativeImageCataloger

newNativeImageCataloger returns a new Native Image cataloger object.

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