maven

Documentation

Index

• Constants
• type ApplicationFactory
• type Build
  • func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)
• type DaemonMavenManager
  • func NewDaemonMavenManager(configResolver libpak.ConfigurationResolver, ...) DaemonMavenManager
  • func (d DaemonMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)
  • func (d DaemonMavenManager) ShouldInstall() bool
• type Detect
  • func (Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)
• type Distribution
  • func NewDistribution(dependency libpak.BuildpackDependency, cache libpak.DependencyCache) (Distribution, libcnb.BOMEntry)
  • func (d Distribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)
  • func (d Distribution) Name() string
• type MavenManager
• type MvndDistribution
  • func NewMvndDistribution(dependency libpak.BuildpackDependency, cache libpak.DependencyCache) (MvndDistribution, libcnb.BOMEntry)
  • func (d MvndDistribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)
  • func (d MvndDistribution) Name() string
• type NoopMavenManager
  • func NewNoopMavenManager(logger bard.Logger) NoopMavenManager
  • func (n NoopMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)
  • func (n NoopMavenManager) ShouldInstall() bool
• type StandardMavenManager
  • func NewStandardMavenManager(appPath string, configResolver libpak.ConfigurationResolver, ...) StandardMavenManager
  • func (s StandardMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)
  • func (s StandardMavenManager) ShouldInstall() bool
• type WrapperMavenManager
  • func NewWrapperMavenManager(appPath string, logger bard.Logger) WrapperMavenManager
  • func (w WrapperMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)
  • func (w WrapperMavenManager) ShouldInstall() bool

Constants

const (
	PlanEntryMaven                 = "maven"
	PlanEntryJVMApplicationPackage = "jvm-application-package"
	PlanEntryJDK                   = "jdk"
	PlanEntrySyft                  = "syft"
	PlanEntryYarn                  = "yarn"
	PlanEntryNode                  = "node"
)

Types

type ApplicationFactory

type ApplicationFactory interface {
	NewApplication(additionalMetadata map[string]interface{}, arguments []string, artifactResolver libbs.ArtifactResolver,
		cache libbs.Cache, command string, bom *libcnb.BOM, applicationPath string, bomScanner sbom.SBOMScanner) (libbs.Application, error)
}

type Build

type Build struct {
	Logger             bard.Logger
	ApplicationFactory ApplicationFactory
	TTY                bool
	// contains filtered or unexported fields
}

func (Build) Build

func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)

type DaemonMavenManager

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

DaemonMavenManager provides the Maven daemon based Maven distribution

func NewDaemonMavenManager

func NewDaemonMavenManager(configResolver libpak.ConfigurationResolver, depResolver libpak.DependencyResolver, depCache libpak.DependencyCache, layersPath string, logger bard.Logger) DaemonMavenManager

func (DaemonMavenManager) Install

func (d DaemonMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)

Install the Maven daemon tool

func (DaemonMavenManager) ShouldInstall

func (d DaemonMavenManager) ShouldInstall() bool

ShouldInstall the Maven Daemon

type Detect

type Detect struct{}

func (Detect) Detect

func (Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)

type Distribution

type Distribution struct {
	LayerContributor libpak.DependencyLayerContributor
	Logger           bard.Logger
}

func NewDistribution

func NewDistribution(dependency libpak.BuildpackDependency, cache libpak.DependencyCache) (Distribution, libcnb.BOMEntry)

func (Distribution) Contribute

func (d Distribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)

func (Distribution) Name

func (d Distribution) Name() string

type MavenManager

type MavenManager interface {
	ShouldInstall() bool
	Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)
}

MavenManager manages the lifecycle of a Maven distribution

type MvndDistribution

type MvndDistribution struct {
	LayerContributor libpak.DependencyLayerContributor
	Logger           bard.Logger
}

func NewMvndDistribution

func NewMvndDistribution(dependency libpak.BuildpackDependency, cache libpak.DependencyCache) (MvndDistribution, libcnb.BOMEntry)

func (MvndDistribution) Contribute

func (d MvndDistribution) Contribute(layer libcnb.Layer) (libcnb.Layer, error)

func (MvndDistribution) Name

func (d MvndDistribution) Name() string

type NoopMavenManager

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

NoopMavenManager doesn't provide Maven, but expects it to exist on the path

func NewNoopMavenManager

func NewNoopMavenManager(logger bard.Logger) NoopMavenManager

func (NoopMavenManager) Install

func (n NoopMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)

Install nothing. Slightly misleading as this doesn't install anything, it just makes sure mvn is on the $PATH

func (NoopMavenManager) ShouldInstall

func (n NoopMavenManager) ShouldInstall() bool

ShouldInstall determines if Maven is on the $PATH

type StandardMavenManager

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

StandardMavenManager provides the standard JVM-based Maven distribution

func NewStandardMavenManager

func NewStandardMavenManager(appPath string, configResolver libpak.ConfigurationResolver, depResolver libpak.DependencyResolver, depCache libpak.DependencyCache, layersPath string, logger bard.Logger) StandardMavenManager

func (StandardMavenManager) Install

func (s StandardMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)

Install the standard JVM-based Maven distribution

func (StandardMavenManager) ShouldInstall

func (s StandardMavenManager) ShouldInstall() bool

ShouldInstall the standard JVM-based Maven distribution

type WrapperMavenManager

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

WrapperMavenManager provides Maven through the Maven Wrapper

func NewWrapperMavenManager

func NewWrapperMavenManager(appPath string, logger bard.Logger) WrapperMavenManager

func (WrapperMavenManager) Install

func (w WrapperMavenManager) Install() (string, libcnb.LayerContributor, *libcnb.BOMEntry, error)

Install the Maven wrapper tool Slightly misleading as this doesn't install anything, it just makes sure the wrapper can be run The wrapper itself handles any installation, if it's necessary

func (WrapperMavenManager) ShouldInstall

func (w WrapperMavenManager) ShouldInstall() bool

ShouldInstall the Maven Wrapper