maven

Documentation

Index

• type MavenArtifact
  • func (m MavenArtifact) Dependencies() []module.Dependency
  • func (m MavenArtifact) Fetcher() string
  • func (m MavenArtifact) Package() string
  • func (m MavenArtifact) Revision() string
• type MavenBuilder
  • func (builder *MavenBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error)
  • func (builder *MavenBuilder) Build(m module.Module, force bool) error
  • func (builder *MavenBuilder) DiscoverModules(dir string) ([]module.Config, error)
  • func (builder *MavenBuilder) Initialize() error
  • func (builder *MavenBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error)
  • func (builder *MavenBuilder) IsModule(target string) (bool, error)
• type POMFile

Types

type MavenArtifact

type MavenArtifact struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

MavenArtifact implements Dependency for Maven builds

func (MavenArtifact) Dependencies

func (m MavenArtifact) Dependencies() []module.Dependency

Dependencies is not implemented for MavenArtifact

func (MavenArtifact) Fetcher

func (m MavenArtifact) Fetcher() string

Fetcher always returns mvn for MavenArtifact

func (MavenArtifact) Package

func (m MavenArtifact) Package() string

Package returns the package spec for MavenArtifact

func (MavenArtifact) Revision

func (m MavenArtifact) Revision() string

Revision returns the version spec for MavenArtifact

type MavenBuilder

type MavenBuilder struct {
	JavaCmd     string
	JavaVersion string

	MvnCmd     string
	MvnVersion string
}

MavenBuilder implements Builder for Apache Maven (*.pom.xml) builds

func (*MavenBuilder) Analyze

func (builder *MavenBuilder) Analyze(m module.Module, allowUnresolved bool) ([]module.Dependency, error)

Analyze parses the output of `mvn dependency:list`

func (*MavenBuilder) Build

func (builder *MavenBuilder) Build(m module.Module, force bool) error

Build runs `mvn install -DskipTests -Drat.skip=true` and cleans with `mvn clean`

func (*MavenBuilder) DiscoverModules

func (builder *MavenBuilder) DiscoverModules(dir string) ([]module.Config, error)

DiscoverModules finds either a root pom.xml file or all pom.xmls in the specified dir

func (*MavenBuilder) Initialize

func (builder *MavenBuilder) Initialize() error

Initialize collects metadata on Java and Maven binaries

func (*MavenBuilder) IsBuilt

func (builder *MavenBuilder) IsBuilt(m module.Module, allowUnresolved bool) (bool, error)

IsBuilt checks whether `mvn dependency:list` produces output.

func (*MavenBuilder) IsModule

func (builder *MavenBuilder) IsModule(target string) (bool, error)

IsModule is not implemented

type POMFile

type POMFile struct {
	XMLName     xml.Name `xml:"project"`
	ArtifactID  string   `xml:"artifactId"`
	GroupID     string   `xml:"groupId"`
	Version     string   `xml:"version"`
	Description string   `xml:"description"`
	Name        string   `xml:"name"`
	URL         string   `xml:"url"`
}

POMFile represents the schema of a common pom.xml file