native

Documentation

Index

• Constants
• type Arguments
• type BaselineArguments
  • func (b BaselineArguments) Configure(_ []string) ([]string, string, error)
• type Build
  • func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)
• type Detect
  • func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)
• type ExplodedJarArguments
  • func (e ExplodedJarArguments) Configure(inputArgs []string) ([]string, string, error)
• type JarArguments
  • func (j JarArguments) Configure(inputArgs []string) ([]string, string, error)
• type NativeImage
  • func NewNativeImage(applicationPath string, arguments string, argumentsFile string, ...) (NativeImage, error)
  • func (n NativeImage) Contribute(layer libcnb.Layer) (libcnb.Layer, error)
  • func (NativeImage) Name() string
  • func (n NativeImage) ProcessArguments(layer libcnb.Layer) ([]string, string, error)
• type NoStartOrMainClass
  • func (e NoStartOrMainClass) Error() string
• type UserArguments
  • func (u UserArguments) Configure(inputArgs []string) ([]string, string, error)
• type UserFileArguments
  • func (u UserFileArguments) Configure(inputArgs []string) ([]string, string, error)

Constants

const (
	ConfigNativeImageArgs           = "BP_NATIVE_IMAGE_BUILD_ARGUMENTS"
	DeprecatedConfigNativeImageArgs = "BP_BOOT_NATIVE_IMAGE_BUILD_ARGUMENTS"
	CompressorUpx                   = "upx"
	CompressorGzexe                 = "gzexe"
	CompressorNone                  = "none"
)

const (
	ConfigNativeImage           = "BP_NATIVE_IMAGE"
	DeprecatedConfigNativeImage = "BP_BOOT_NATIVE_IMAGE"
	BinaryCompressionMethod     = "BP_BINARY_COMPRESSION_METHOD"

	PlanEntryNativeImage        = "native-image-application"
	PlanEntryNativeProcessed    = "native-processed"
	PlanEntryNativeImageBuilder = "native-image-builder"
	PlanEntryJVMApplication     = "jvm-application"
	PlanEntrySpringBoot         = "spring-boot"
	PlanEntryUpx                = "upx"
)

Types

type Arguments

type Arguments interface {
	Configure(inputArgs []string) ([]string, string, error)
}

type BaselineArguments

type BaselineArguments struct {
	StackID string
}

BaselineArguments provides a set of arguments that are always set

func (BaselineArguments) Configure

func (b BaselineArguments) Configure(_ []string) ([]string, string, error)

Configure provides an initial set of arguments, it ignores any input arguments

type Build

type Build struct {
	Logger      bard.Logger
	SBOMScanner sbom.SBOMScanner
}

func (Build) Build

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

type Detect

type Detect struct {
	Logger bard.Logger
}

func (Detect) Detect

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

type ExplodedJarArguments

type ExplodedJarArguments struct {
	ApplicationPath string
	LayerPath       string
	Manifest        *properties.Properties
}

ExplodedJarArguments provides a set of arguments specific to building from an exploded jar directory

func (ExplodedJarArguments) Configure

func (e ExplodedJarArguments) Configure(inputArgs []string) ([]string, string, error)

Configure appends arguments to inputArgs for building from an exploded JAR directory

type JarArguments

type JarArguments struct {
	ApplicationPath string
	JarFilePattern  string
}

JarArguments provides a set of arguments specific to building from a jar file

func (JarArguments) Configure

func (j JarArguments) Configure(inputArgs []string) ([]string, string, error)

type NativeImage

type NativeImage struct {
	ApplicationPath string
	Arguments       string
	ArgumentsFile   string
	Executor        effect.Executor
	JarFilePattern  string
	Logger          bard.Logger
	Manifest        *properties.Properties
	StackID         string
	Compressor      string
}

func NewNativeImage

func NewNativeImage(applicationPath string, arguments string, argumentsFile string, compressor string, jarFilePattern string, manifest *properties.Properties, stackID string) (NativeImage, error)

func (NativeImage) Contribute

func (n NativeImage) Contribute(layer libcnb.Layer) (libcnb.Layer, error)

func (NativeImage) Name

func (NativeImage) Name() string

func (NativeImage) ProcessArguments

func (n NativeImage) ProcessArguments(layer libcnb.Layer) ([]string, string, error)

type NoStartOrMainClass

type NoStartOrMainClass struct{}

NoStartOrMainClass is an error returned when a start or main class cannot be found

func (NoStartOrMainClass) Error

func (e NoStartOrMainClass) Error() string

type UserArguments

type UserArguments struct {
	Arguments string
}

UserArguments augments the existing arguments with those provided by the end user

func (UserArguments) Configure

func (u UserArguments) Configure(inputArgs []string) ([]string, string, error)

Configure returns the inputArgs plus the additional arguments specified by the end user, preference given to user arguments

type UserFileArguments

type UserFileArguments struct {
	ArgumentsFile string
}

UserFileArguments augments the existing arguments with those provided by the end user through a file

func (UserFileArguments) Configure

func (u UserFileArguments) Configure(inputArgs []string) ([]string, string, error)

Configure returns the inputArgs plus the additional arguments provided via argfile, setting via the '@argfile' format