springboot

Documentation

Index

• Constants
• type JARDependencies
  • func (d JARDependencies) Len() int
  • func (d JARDependencies) Less(i, j int) bool
  • func (d JARDependencies) Swap(i, j int)
• type JARDependency
  • func NewJARDependency(path string, logger logger.Logger) (JARDependency, bool, error)
• type Metadata
  • func NewMetadata(application application.Application, logger logger.Logger) (Metadata, bool, error)
  • func (m Metadata) Identity() (string, string)
• type SpringBoot
  • func NewSpringBoot(build build.Build) (SpringBoot, bool, error)
  • func (s SpringBoot) Contribute() error
  • func (s SpringBoot) Plan() (buildpackplan.Plan, error)

Constants

const Dependency = "spring-boot"

Dependency indicates that an application is a Spring Boot application.

Types

type JARDependencies

type JARDependencies []JARDependency

func (JARDependencies) Len

func (d JARDependencies) Len() int

func (JARDependencies) Less

func (d JARDependencies) Less(i, j int) bool

func (JARDependencies) Swap

func (d JARDependencies) Swap(i, j int)

type JARDependency

type JARDependency struct {
	Name    string `toml:"name"`
	Version string `toml:"version"`
	SHA256  string `toml:"sha256"`
}

JARDependency represents a JAR dependency within an application

func NewJARDependency

func NewJARDependency(path string, logger logger.Logger) (JARDependency, bool, error)

NewJARDependency creates a new instance of JAR dependency, returning true if it matches the standard Maven naming scheme.

type Metadata

type Metadata struct {
	// Classes indicates the Spring-Boot-Classes of a Spring Boot application.
	Classes string `mapstructure:"classes" properties:"Spring-Boot-Classes,default=" toml:"classes"`

	// Classpath is the classpath of a Spring Boot application.
	ClassPath []string `mapstructure:"classpath" properties:",default=" toml:"classpath"`

	// Lib indicates the Spring-Boot-Lib of a Spring Boot application.
	Lib string `mapstructure:"lib" properties:"Spring-Boot-Lib,default=" toml:"lib"`

	// StartClass indicates the Start-Class of a Spring Boot application.
	StartClass string `mapstructure:"start-class" properties:"Start-Class,default=" toml:"start-class"`

	// Version indicates the Spring-Boot-Version of a Spring Boot application.
	Version string `mapstructure:"version" properties:"Spring-Boot-Version,default=" toml:"version"`
}

Metadata describes the application's metadata.

func NewMetadata

func NewMetadata(application application.Application, logger logger.Logger) (Metadata, bool, error)

NewMetadata creates a new Metadata returning false if Spring-Boot-Version is not defined.

func (Metadata) Identity

func (m Metadata) Identity() (string, string)

type SpringBoot

type SpringBoot struct {
	// Metadata is metadata about the Spring Boot application.
	Metadata Metadata
	// contains filtered or unexported fields
}

SpringBoot represents a Spring Boot JVM application.

func NewSpringBoot

func NewSpringBoot(build build.Build) (SpringBoot, bool, error)

NewSpringBoot creates a new SpringBoot instance. OK is true if the build plan contains a "jvm-application" dependency and a "Spring-Boot-Version" manifest key.

func (SpringBoot) Contribute

func (s SpringBoot) Contribute() error

Contribute makes the contribution to build, cache, and launch.

func (SpringBoot) Plan

func (s SpringBoot) Plan() (buildpackplan.Plan, error)

Plan returns the dependency information for this application.